From 8a5c4d5b0b329e21c073ba99e7ceef8768cd2c02 Mon Sep 17 00:00:00 2001 From: Wojciech Maj Date: Sat, 5 Dec 2020 16:47:02 +0100 Subject: [PATCH] Remove recursiveBlacklist option from jest-validate (#10650) --- CHANGELOG.md | 1 + packages/jest-config/src/normalize.ts | 2 +- .../src/__tests__/validate.test.ts | 34 ------------------- packages/jest-validate/src/types.ts | 1 - packages/jest-validate/src/validate.ts | 16 +++------ 5 files changed, 6 insertions(+), 48 deletions(-) diff --git a/CHANGELOG.md b/CHANGELOG.md index 4b9a848afd7e..7fca58c0223c 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -53,6 +53,7 @@ - `[jest-runner]` [**BREAKING**] Migrate to ESM ([#10900](https://github.com/facebook/jest/pull/10900)) - `[jest-runtime]` [**BREAKING**] Remove deprecated and unnused `getSourceMapInfo` from Runtime ([#9969](https://github.com/facebook/jest/pull/9969)) - `[jest-util]` No longer checking `enumerable` when adding `process.domain` ([#10862](https://github.com/facebook/jest/pull/10862)) +- `[jest-validate]` [**BREAKING**] Remove `recursiveBlacklist ` option in favor of previously introduced `recursiveDenylist` ([#10650](https://github.com/facebook/jest/pull/10650)) ### Performance diff --git a/packages/jest-config/src/normalize.ts b/packages/jest-config/src/normalize.ts index 08250b8c8ed8..e31cefaa3bf4 100644 --- a/packages/jest-config/src/normalize.ts +++ b/packages/jest-config/src/normalize.ts @@ -553,7 +553,7 @@ export default function normalize( comment: DOCUMENTATION_NOTE, deprecatedConfig: DEPRECATED_CONFIG, exampleConfig: VALID_CONFIG, - recursiveBlacklist: [ + recursiveDenylist: [ 'collectCoverageOnlyFrom', // 'coverageThreshold' allows to use 'global' and glob strings on the same // level, there's currently no way we can deal with such config diff --git a/packages/jest-validate/src/__tests__/validate.test.ts b/packages/jest-validate/src/__tests__/validate.test.ts index 60a6f0bc357b..4877e6d375b9 100644 --- a/packages/jest-validate/src/__tests__/validate.test.ts +++ b/packages/jest-validate/src/__tests__/validate.test.ts @@ -100,40 +100,6 @@ test.each([ }, ); -test('respects recursiveBlacklist', () => { - const warn = console.warn; - console.warn = jest.fn(); - const config = { - something: { - nested: { - some_random_key: 'value', - some_random_key2: 'value2', - }, - }, - }; - const exampleConfig = { - something: { - nested: { - test: true, - }, - }, - }; - - validate(config, {exampleConfig}); - - expect(console.warn).toBeCalled(); - - console.warn.mockReset(); - - validate(config, { - exampleConfig, - recursiveBlacklist: ['something.nested'], - }); - - expect(console.warn).not.toBeCalled(); - console.warn = warn; -}); - test('respects recursiveDenylist', () => { const warn = console.warn; console.warn = jest.fn(); diff --git a/packages/jest-validate/src/types.ts b/packages/jest-validate/src/types.ts index aba81d819edc..4c8f6beacda7 100644 --- a/packages/jest-validate/src/types.ts +++ b/packages/jest-validate/src/types.ts @@ -34,7 +34,6 @@ export type ValidationOptions = { ) => void; exampleConfig: Record; recursive?: boolean; - recursiveBlacklist?: Array; recursiveDenylist?: Array; title?: Title; unknown?: ( diff --git a/packages/jest-validate/src/validate.ts b/packages/jest-validate/src/validate.ts index ea2704e9a133..37844a223d77 100644 --- a/packages/jest-validate/src/validate.ts +++ b/packages/jest-validate/src/validate.ts @@ -70,11 +70,7 @@ const _validate = ( options.error(key, config[key], exampleConfig[key], options, path); } } else if ( - shouldSkipValidationForPath( - path, - key, - options.recursiveDenylist || options.recursiveBlacklist, - ) + shouldSkipValidationForPath(path, key, options.recursiveDenylist) ) { // skip validating unknown options inside blacklisted paths } else { @@ -85,12 +81,8 @@ const _validate = ( if ( options.recursive && !Array.isArray(exampleConfig[key]) && - (options.recursiveDenylist || options.recursiveBlacklist) && - !shouldSkipValidationForPath( - path, - key, - options.recursiveDenylist || options.recursiveBlacklist, - ) + options.recursiveDenylist && + !shouldSkipValidationForPath(path, key, options.recursiveDenylist) ) { _validate(config[key], exampleConfig[key], options, [...path, key]); } @@ -112,7 +104,7 @@ const validate = ( // Preserve default denylist entries even with user-supplied denylist const combinedDenylist: Array = [ ...(defaultConfig.recursiveDenylist || []), - ...(options.recursiveDenylist || options.recursiveBlacklist || []), + ...(options.recursiveDenylist || []), ]; const defaultedOptions: ValidationOptions = Object.assign({