Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

fix(jest-validate): Allow deprecation warnings for unknown options #14499

Merged
merged 9 commits into from
Sep 11, 2023
+131 −27
Merged

fix(jest-validate): Allow deprecation warnings for unknown options #14499

Changes from 1 commit
Commits
Show all changes
9 commits
Select commit Hold shift + click to select a range
8f92df8
fix(jest-validate): Allow deprecation warnings for unknown options
dj-stormtrooper Sep 7, 2023
f738bc5
docs: Changelog update
dj-stormtrooper Sep 7, 2023
5466c6c
feat: Add an ability to pass fatal errors to deprecation logger
dj-stormtrooper Sep 10, 2023
4eae5ad
feat: Add fatal deprecation errors
dj-stormtrooper Sep 10, 2023
7de422d
test: Deprecated CLI options
dj-stormtrooper Sep 10, 2023
fb27b05
Merge branch 'jestjs:main' into fix/deprecation-warnings-for-unknown-…
dj-stormtrooper Sep 11, 2023
7a930b3
docs: Changelog update
dj-stormtrooper Sep 11, 2023
5219319
docs: Add example of validating CLI options
dj-stormtrooper Sep 11, 2023
573aae3
fix: Prettier for readme
dj-stormtrooper Sep 11, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
Next Next commit
fix(jest-validate): Allow deprecation warnings for unknown options
  • Loading branch information
@dj-stormtrooper
dj-stormtrooper committed Sep 7, 2023
commit 8f92df8aaa23776cb90bdb0f1dd003193bf0cfa1
37 changes: 19 additions & 18 deletions packages/jest-validate/src/validateCLIOptions.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -69,29 +69,13 @@ export default function validateCLIOptions(
rawArgv: Array<string> = [],
): boolean {
const yargsSpecialOptions = ['$0', '_', 'help', 'h'];
const deprecationEntries = options.deprecationEntries ?? {};
const allowedOptions = Object.keys(options).reduce(
(acc, option) =>
acc.add(option).add((options[option].alias as string) || option),
new Set(yargsSpecialOptions),
);
const unrecognizedOptions = Object.keys(argv).filter(
arg =>
!allowedOptions.has(camelcase(arg, {locale: 'en-US'})) &&
!allowedOptions.has(arg) &&
(!rawArgv.length || rawArgv.includes(arg)),
[],
);

if (unrecognizedOptions.length) {
throw createCLIValidationError(unrecognizedOptions, allowedOptions);
}

const deprecationEntries = options.deprecationEntries ?? {};
const CLIDeprecations = Object.keys(deprecationEntries).reduce<
Record<string, DeprecatedOptionFunc>
>((acc, entry) => {
acc[entry] = deprecationEntries[entry];
if (options[entry]) {
acc[entry] = deprecationEntries[entry];
const alias = options[entry].alias as string;
if (alias) {
acc[alias] = deprecationEntries[entry];
Expand All @@ -108,5 +92,22 @@ export default function validateCLIOptions(
logDeprecatedOptions(deprecatedOptions, CLIDeprecations, argv);
}

const allowedOptions = Object.keys(options).reduce(
(acc, option) =>
acc.add(option).add((options[option].alias as string) || option),
new Set(yargsSpecialOptions),
);
const unrecognizedOptions = Object.keys(argv).filter(
arg =>
!allowedOptions.has(camelcase(arg, {locale: 'en-US'})) &&
!allowedOptions.has(arg) &&
(!rawArgv.length || rawArgv.includes(arg)),
[],
);

if (unrecognizedOptions.length) {
throw createCLIValidationError(unrecognizedOptions, allowedOptions);
}

return true;
}
-