fix: add unit test and e2e test

Author: longlho

docs/user/config/astTransformers.md

@@ -14,6 +14,46 @@ The option is `astTransformers` and it allows ones to specify which 3 types of T
 
 ### Examples
 
+#### Basic Transformers
+
+<div class="row"><div class="col-md-6" markdown="block">
+
+```js
+// jest.config.js
+module.exports = {
+  // [...]
+  globals: {
+    'ts-jest': {
+      astTransformers: {
+        before: ['my-custom-transformer'],
+      },
+    },
+  },
+}
+```
+
+</div><div class="col-md-6" markdown="block">
+
+```js
+// OR package.json
+{
+  // [...]
+  "jest": {
+    "globals": {
+      "ts-jest": {
+        astTransformers: {
+          "before": ["my-custom-transformer"]
+        }
+      }
+    }
+  }
+}
+```
+
+</div></div>
+
+#### Configuring transformers with options
+
 <div class="row"><div class="col-md-6" markdown="block">
 
 ```js
@@ -24,10 +64,9 @@ module.exports = {
     'ts-jest': {
       astTransformers: {
         before: [
-          'my-custom-transformer',
           {
             path: 'my-custom-transformer-that-needs-extra-opts',
-            options: {},
+            options: {}, // extra options to pass to transformers here
           },
         ],
       },
@@ -46,9 +85,9 @@ module.exports = {
     "globals": {
       "ts-jest": {
         astTransformers: {
-          "before": ["my-custom-transformer", {
+          "before": [{
             path: 'my-custom-transformer-that-needs-extra-opts',
-            options: {}
+            options: {} // extra options to pass to transformers here
           }]
         }
       }

e2e/__cases__/ast-transformers/with-extra-options/foo.js

@@ -0,0 +1,18 @@
+const { LogContexts, LogLevels } = require('bs-logger')
+
+function factory(cs, extraOpts = Object.create(null)) {
+  const logger = cs.logger.child({ namespace: 'dummy-transformer' })
+  const ts = cs.compilerModule
+  logger.debug('Dummy transformer with extra options', JSON.stringify(extraOpts))
+
+  function createVisitor(_ctx, _sf) {
+    return (node) => node
+  }
+
+  return (ctx) =>
+    logger.wrap({ [LogContexts.logLevel]: LogLevels.debug, call: null }, 'visitSourceFileNode(): dummy', (sf) =>
+      ts.visitNode(sf, createVisitor(ctx, sf))
+    )
+}
+
+exports.factory = factory

e2e/__cases__/ast-transformers/with-extra-options/with-extra-options.spec.ts

@@ -0,0 +1,5 @@
+const a = 1;
+
+it('should pass', () => {
+  expect(a).toEqual(1);
+})

e2e/__tests__/__snapshots__/ast-transformers.test.ts.snap

@@ -0,0 +1,19 @@
+// Jest Snapshot v1, https://goo.gl/fbAQLP
+
+exports[`AST transformers with extra options should pass using template "default" 1`] = `
+Array [
+  "[level:20] Dummy transformer with extra options {\\"foo\\":\\"bar\\"}",
+]
+`;
+
+exports[`AST transformers with extra options should pass using template "with-babel-7" 1`] = `
+Array [
+  "[level:20] Dummy transformer with extra options {\\"foo\\":\\"bar\\"}",
+]
+`;
+
+exports[`AST transformers with extra options should pass using template "with-babel-7-string-config" 1`] = `
+Array [
+  "[level:20] Dummy transformer with extra options {\\"foo\\":\\"bar\\"}",
+]
+`;

e2e/__tests__/ast-transformers.test.ts

@@ -0,0 +1,38 @@
+import { configureTestCase } from '../__helpers__/test-case'
+import { allValidPackageSets } from '../__helpers__/templates'
+import { existsSync } from "fs"
+import { LogContexts, LogLevels } from 'bs-logger'
+
+describe('AST transformers', () => {
+  describe('with extra options', () => {
+    const testCase = configureTestCase('ast-transformers/with-extra-options', {
+      env: { TS_JEST_LOG: 'ts-jest.log' },
+      tsJestConfig: {
+        astTransformers: {
+          before: [{
+            path: require.resolve('../__cases__/ast-transformers/with-extra-options/foo'),
+            options: {
+              foo: 'bar',
+            },
+          }],
+        },
+      },
+    })
+
+    testCase.runWithTemplates(allValidPackageSets, 0, (runTest, { testLabel }) => {
+      it(testLabel, () => {
+        const result = runTest()
+        expect(result.status).toBe(0)
+        expect(existsSync(result.logFilePath)).toBe(true)
+        const filteredEntries = result.logFileEntries
+          // keep only debug and above
+          .filter(m => (m.context[LogContexts.logLevel] || 0) >= LogLevels.debug)
+          // simplify entries
+          // eslint-disable-next-line @typescript-eslint/restrict-template-expressions
+          .map(e => result.normalize(`[level:${e.context[LogContexts.logLevel]}] ${e.message}`))
+          .filter(logging => logging.includes('Dummy transformer with extra options'))
+        expect(filteredEntries).toMatchSnapshot()
+      })
+    })
+  })
+})

e2e/__tests__/path-mapping.test.ts

@@ -13,7 +13,7 @@ function executeTest(rootDirs?: string[]) {
       },
       astTransformers: {
         before: [
-          {path: 'ts-jest/dist/transformers/path-mapping'}
+          'ts-jest/dist/transformers/path-mapping'
         ],
       },
     },

src/config/__snapshots__/config-set.spec.ts.snap

@@ -355,3 +355,14 @@ exports[`tsJest transformers should display deprecation warning message when con
 "[level:40] The configuration for astTransformers as string[] is deprecated and will be removed in ts-jest 27. Please define your custom AST transformers in a form of an object. More information you can check online documentation https://kulshekhar.github.io/ts-jest/user/config/astTransformers
 "
 `;
+
+exports[`tsJest transformers should support transformers with options 1`] = `
+Array [
+  Object {
+    "options": Object {
+      "foo": 1,
+    },
+    "path": Any<String>,
+  },
+]
+`;

src/config/config-set.spec.ts

@@ -161,6 +161,37 @@ describe('tsJest', () => {
       expect(logger.target.lines[1]).toMatchSnapshot()
     })
 
+    it('should support transformers with options', () => {
+      const cs = createConfigSet({
+        jestConfig: {
+          rootDir: 'src',
+          cwd: 'src',
+          globals: {
+            'ts-jest': {
+              astTransformers: {
+                before: [
+                  {
+                    path: 'dummy-transformer',
+                    options: {
+                      foo: 1,
+                    },
+                  },
+                ],
+              },
+            },
+          },
+        } as any,
+        logger,
+        resolve: null,
+      })
+
+      expect(cs.tsJest.transformers.before).toMatchSnapshot([
+        {
+          path: expect.any(String),
+        },
+      ])
+    })
+
     it.each([
       {},
       {

src/config/config-set.ts

@@ -57,7 +57,7 @@ import { TSError } from '../utils/ts-error'
 const logger = rootLogger.child({ namespace: 'config' })
 
 interface AstTransformerObj<T = Record<string, unknown>> {
-  module: AstTransformerDesc
+  transformModule: AstTransformerDesc
   options?: T
 }
 
@@ -432,7 +432,7 @@ export class ConfigSet {
     let astTransformers: AstTransformer = {
       before: [
         ...internalAstTransformers.map((transformer) => ({
-          module: transformer,
+          transformModule: transformer,
         })),
       ],
     }
@@ -444,10 +444,10 @@ export class ConfigSet {
           ...transformers.before.map((transformer) =>
             typeof transformer === 'string'
               ? {
-                  module: require(transformer),
+                  transformModule: require(transformer),
                 }
               : {
-                  module: require(transformer.path),
+                  transformModule: require(transformer.path),
                   options: transformer.options,
                 },
           ),
@@ -460,10 +460,10 @@ export class ConfigSet {
         after: transformers.after.map((transformer) =>
           typeof transformer === 'string'
             ? {
-                module: require(transformer),
+                transformModule: require(transformer),
               }
             : {
-                module: require(transformer.path),
+                transformModule: require(transformer.path),
                 options: transformer.options,
               },
         ),
@@ -475,10 +475,10 @@ export class ConfigSet {
         afterDeclarations: transformers.afterDeclarations.map((transformer) =>
           typeof transformer === 'string'
             ? {
-                module: require(transformer),
+                transformModule: require(transformer),
               }
             : {
-                module: require(transformer.path),
+                transformModule: require(transformer.path),
                 options: transformer.options,
               },
         ),
@@ -494,14 +494,14 @@ export class ConfigSet {
   @Memoize()
   get tsCustomTransformers(): CustomTransformers {
     let customTransformers: CustomTransformers = {
-      before: this.astTransformers.before.map((t) => t.module.factory(this, t.options)) as TransformerFactory<
+      before: this.astTransformers.before.map((t) => t.transformModule.factory(this, t.options)) as TransformerFactory<
         SourceFile
       >[],
     }
     if (this.astTransformers.after) {
       customTransformers = {
         ...customTransformers,
-        after: this.astTransformers.after.map((t) => t.module.factory(this, t.options)) as TransformerFactory<
+        after: this.astTransformers.after.map((t) => t.transformModule.factory(this, t.options)) as TransformerFactory<
           SourceFile
         >[],
       }
@@ -510,7 +510,7 @@ export class ConfigSet {
       customTransformers = {
         ...customTransformers,
         afterDeclarations: this.astTransformers.afterDeclarations.map((t) =>
-          t.module.factory(this, t.options),
+          t.transformModule.factory(this, t.options),
         ) as TransformerFactory<Bundle | SourceFile>[],
       }
     }
@@ -721,7 +721,7 @@ export class ConfigSet {
       digest: this.tsJestDigest,
       transformers: Object.values(this.astTransformers)
         .reduce((acc, val) => acc.concat(val), [])
-        .map((t: AstTransformerDesc) => `${t.name}@${t.version}`),
+        .map(({ transformModule }: AstTransformerObj) => `${transformModule.name}@${transformModule.version}`),
       jest,
       tsJest: this.tsJest,
       babel: this.babel,