refactor(transformers): deprecate path-mapping AST transformer (#3088)

DEPRECATION `path-mapping` AST transformer is deprecated. One should use alternative one like https://github.com/LeDDGroup/typescript-transform-paths instead
kulshekhar · Nov 22, 2021 · d8f6b96 · d8f6b96
1 parent f316352
commit d8f6b96
Show file tree

Hide file tree

Showing 18 changed files with 3 additions and 199 deletions.
diff --git a/e2e/__tests__/ast-transformers.test.ts b/e2e/__tests__/ast-transformers.test.ts
@@ -21,27 +21,6 @@ const executeTest = (testDir: string): void => {
   })
 }
 
-describe('path-mapping', () => {
-  const PATH_MAPPING_DIR_NAME = 'path-mapping'
-
-  describe('ts-4.5+', () => {
-    executeTest(`${AST_TRANSFORMERS_DIR_NAME}/${PATH_MAPPING_DIR_NAME}/ts-4.5+`)
-  })
-
-  describe('ts-4.5-', () => {
-    const DIR = path.join(__dirname, '..', AST_TRANSFORMERS_DIR_NAME, PATH_MAPPING_DIR_NAME, 'ts-4.5-')
-
-    beforeAll(() => {
-      runNpmInstall(DIR)
-      execa.sync('npm', ['install', '--no-package-lock', '--no-shrinkwrap', '--no-save', tsJestBundle], {
-        cwd: DIR,
-      })
-    })
-
-    executeTest(`${AST_TRANSFORMERS_DIR_NAME}/${PATH_MAPPING_DIR_NAME}/ts-4.5-`)
-  })
-})
-
 describe('transformer-options', () => {
   const TRANSFORM_OPT_DIR_NAME = 'transformer-options'
 

diff --git a/e2e/ast-transformers/path-mapping/__tests__/direct-import.spec.ts b/e2e/ast-transformers/path-mapping/__tests__/direct-import.spec.ts
diff --git a/e2e/ast-transformers/path-mapping/__tests__/dynamic-import.spec.ts b/e2e/ast-transformers/path-mapping/__tests__/dynamic-import.spec.ts
diff --git a/e2e/ast-transformers/path-mapping/__tests__/export.spec.ts b/e2e/ast-transformers/path-mapping/__tests__/export.spec.ts
diff --git a/e2e/ast-transformers/path-mapping/__tests__/import-default.spec.ts b/e2e/ast-transformers/path-mapping/__tests__/import-default.spec.ts
diff --git a/e2e/ast-transformers/path-mapping/__tests__/import-legacy.spec.ts b/e2e/ast-transformers/path-mapping/__tests__/import-legacy.spec.ts
diff --git a/e2e/ast-transformers/path-mapping/__tests__/import-require.spec.ts b/e2e/ast-transformers/path-mapping/__tests__/import-require.spec.ts
diff --git a/e2e/ast-transformers/path-mapping/__tests__/import-star.spec.ts b/e2e/ast-transformers/path-mapping/__tests__/import-star.spec.ts
diff --git a/e2e/ast-transformers/path-mapping/__tests__/import-type.spec.ts b/e2e/ast-transformers/path-mapping/__tests__/import-type.spec.ts
diff --git a/e2e/ast-transformers/path-mapping/share/export.ts b/e2e/ast-transformers/path-mapping/share/export.ts
diff --git a/e2e/ast-transformers/path-mapping/share/foo.ts b/e2e/ast-transformers/path-mapping/share/foo.ts
diff --git a/e2e/ast-transformers/path-mapping/ts-4.5+/jest-isolated.config.js b/e2e/ast-transformers/path-mapping/ts-4.5+/jest-isolated.config.js
diff --git a/e2e/ast-transformers/path-mapping/ts-4.5+/package.json b/e2e/ast-transformers/path-mapping/ts-4.5+/package.json
diff --git a/e2e/ast-transformers/path-mapping/ts-4.5-/jest-isolated.config.js b/e2e/ast-transformers/path-mapping/ts-4.5-/jest-isolated.config.js
diff --git a/e2e/ast-transformers/path-mapping/ts-4.5-/package-lock.json b/e2e/ast-transformers/path-mapping/ts-4.5-/package-lock.json
diff --git a/e2e/ast-transformers/path-mapping/ts-4.5-/package.json b/e2e/ast-transformers/path-mapping/ts-4.5-/package.json
diff --git a/e2e/ast-transformers/path-mapping/tsconfig.json b/e2e/ast-transformers/path-mapping/tsconfig.json
diff --git a/src/transformers/path-mapping.ts b/src/transformers/path-mapping.ts
@@ -28,6 +28,9 @@ export function factory({
   configSet,
 }: TsCompilerInstance): (ctx: _ts.TransformationContext) => _ts.Transformer<_ts.SourceFile> {
   const logger = configSet.logger.child({ namespace: name })
+  logger.warn(
+    'path-mapping AST transformer is deprecated and will be removed in `ts-jest` v28. Please use an alternative one, like https://github.com/LeDDGroup/typescript-transform-paths instead',
+  )
   const ts = configSet.compilerModule
   const tsFactory = ts.factory ? ts.factory : ts
   const compilerOptions = configSet.parsedTsConfig.options