fix(types): mark deprecated configuration options as @deprecated (#…

…11913)
jestjs · Sep 30, 2021 · 48cef09 · 48cef09
1 parent ad240ed
commit 48cef09
Show file tree

Hide file tree

Showing 2 changed files with 11 additions and 0 deletions.
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -4,6 +4,8 @@
 
 ### Fixes
 
+- `[@jest/types]` Mark deprecated configuration options as `@deprecated` ([#11913](https://github.com/facebook/jest/pull/11913))
+
 ### Chore & Maintenance
 
 ### Performance

diff --git a/packages/jest-types/src/Config.ts b/packages/jest-types/src/Config.ts
@@ -196,6 +196,9 @@ export type InitialOptions = Partial<{
   onlyFailures: boolean;
   outputFile: Path;
   passWithNoTests: boolean;
+  /**
+   * @deprecated Use `transformIgnorePatterns` options instead.
+   */
   preprocessorIgnorePatterns: Array<Glob>;
   preset: string | null | undefined;
   prettierPath: string | null | undefined;
@@ -209,6 +212,9 @@ export type InitialOptions = Partial<{
   roots: Array<Path>;
   runner: string;
   runTestsByPath: boolean;
+  /**
+   * @deprecated Use `transform` options instead.
+   */
   scriptPreprocessor: string;
   setupFiles: Array<Path>;
   /**
@@ -230,6 +236,9 @@ export type InitialOptions = Partial<{
   testLocationInResults: boolean;
   testMatch: Array<Glob>;
   testNamePattern: string;
+  /**
+   * @deprecated Use `roots` options instead.
+   */
   testPathDirs: Array<Path>;
   testPathIgnorePatterns: Array<string>;
   testRegex: string | Array<string>;