feat: load TypeScript config from tsconfig package instead of `ts-j…

…est` (#471) * chore(deps): add `tsconfig` package on @vue/vue2-jest * feat: add `getTypeScriptConfig` util function * feat: use `getTypeScriptConfig` on typescript transformer * feat: remove `getTsJestConfig` function * chore(deps): remove ts-jest dependencies * chore(deps-dev): remove ts-jest from e2e projects * feat: remove info log * feat: support `createTransformer()` on customTransformer
vuejs · Aug 15, 2022 · a84eafb · a84eafb
1 parent 4530039
commit a84eafb
Show file tree

Hide file tree

Showing 14 changed files with 62 additions and 51 deletions.
diff --git a/e2e/2.x/babel-in-package/package.json b/e2e/2.x/babel-in-package/package.json
@@ -20,7 +20,6 @@
     "coffeescript": "^2.3.2",
     "jest": "28.x",
     "jest-environment-jsdom": "28.0.2",
-    "ts-jest": "^28.0.1",
     "typescript": "^4.6.4"
   },
   "jest": {

diff --git a/e2e/2.x/basic/package.json b/e2e/2.x/basic/package.json
@@ -14,6 +14,7 @@
     "@babel/core": "^7.9.0",
     "@babel/preset-env": "^7.9.0",
     "@vue/test-utils": "^1.1.0",
+    "@vue/vue2-jest": "^28.0.0",
     "babel-helper-vue-jsx-merge-props": "^2.0.3",
     "babel-plugin-syntax-jsx": "^6.18.0",
     "babel-plugin-transform-vue-jsx": "^3.7.0",
@@ -23,9 +24,7 @@
     "jest-environment-jsdom": "28.0.2",
     "pug": "^3.0.1",
     "sass": "^1.23.7",
-    "ts-jest": "^28.0.1",
-    "typescript": "^4.6.4",
-    "@vue/vue2-jest": "^28.0.0"
+    "typescript": "^4.6.4"
   },
   "jest": {
     "testEnvironment": "jsdom",

diff --git a/e2e/3.x/babel-in-package/package.json b/e2e/3.x/babel-in-package/package.json
@@ -12,12 +12,12 @@
   "devDependencies": {
     "@babel/core": "^7.9.0",
     "@babel/preset-env": "^7.9.0",
+    "@vue/vue3-jest": "^28.0.0",
     "coffeescript": "^2.3.2",
     "jest": "^28.0.0",
     "jest-environment-jsdom": "28.0.2",
     "ts-jest": "^28.0.1",
-    "typescript": "^4.6.4",
-    "@vue/vue3-jest": "^28.0.0"
+    "typescript": "^4.6.4"
   },
   "jest": {
     "testEnvironment": "jsdom",

diff --git a/e2e/3.x/basic/package.json b/e2e/3.x/basic/package.json
@@ -12,6 +12,7 @@
   "devDependencies": {
     "@babel/core": "^7.9.0",
     "@babel/preset-env": "^7.9.0",
+    "@vue/vue3-jest": "^28.0.0",
     "babel-helper-vue-jsx-merge-props": "^2.0.3",
     "babel-plugin-syntax-jsx": "^6.18.0",
     "babel-plugin-transform-vue-jsx": "^3.7.0",
@@ -23,7 +24,6 @@
     "ts-jest": "^28.0.1",
     "typescript": "^4.6.4",
     "vue-class-component": "^8.0.0-beta.4",
-    "@vue/vue3-jest": "^28.0.0",
     "vue-property-decorator": "^10.0.0-rc.3"
   }
 }
diff --git a/e2e/3.x/typescript-with-babel/package.json b/e2e/3.x/typescript-with-babel/package.json
@@ -12,11 +12,10 @@
   "devDependencies": {
     "@babel/core": "^7.9.0",
     "@babel/preset-env": "^7.9.0",
+    "@vue/vue3-jest": "^28.0.0",
     "jest": "^28.0.2",
     "jest-environment-jsdom": "28.0.2",
-    "ts-jest": "^28.0.1",
-    "typescript": "^4.6.4",
-    "@vue/vue3-jest": "^28.0.0"
+    "typescript": "^4.6.4"
   },
   "jest": {
     "testEnvironment": "jsdom",

diff --git a/e2e/3.x/typescript-with-compiler-options/package.json b/e2e/3.x/typescript-with-compiler-options/package.json
@@ -11,11 +11,11 @@
   },
   "devDependencies": {
     "@types/jest": "16.0.10",
+    "@vue/vue3-jest": "^28.0.0",
     "jest": "^28.0.2",
     "jest-environment-jsdom": "28.0.2",
     "ts-jest": "^28.0.1",
-    "typescript": "^4.6.4",
-    "@vue/vue3-jest": "^28.0.0"
+    "typescript": "^4.6.4"
   },
   "jest": {
     "testEnvironment": "jsdom",

diff --git a/e2e/3.x/typescript/package.json b/e2e/3.x/typescript/package.json
@@ -11,11 +11,11 @@
   },
   "devDependencies": {
     "@types/jest": "16.0.10",
+    "@vue/vue3-jest": "^28.0.0",
     "jest": "^28.0.2",
     "jest-environment-jsdom": "28.0.2",
     "ts-jest": "^28.0.1",
-    "typescript": "^4.6.4",
-    "@vue/vue3-jest": "^28.0.0"
+    "typescript": "^4.6.4"
   },
   "jest": {
     "testEnvironment": "jsdom",

diff --git a/packages/vue2-jest/lib/transformers/typescript.js b/packages/vue2-jest/lib/transformers/typescript.js
@@ -1,9 +1,9 @@
 const ensureRequire = require('../ensure-require')
 const babelJest = require('babel-jest').default
 const {
-  getTsJestConfig,
   stripInlineSourceMap,
   getCustomTransformer,
+  getTypeScriptConfig,
   getVueJestConfig
 } = require('../utils')
 
@@ -12,7 +12,7 @@ module.exports = scriptLang => ({
     ensureRequire('typescript', ['typescript'])
     const typescript = require('typescript')
     const vueJestConfig = getVueJestConfig(config)
-    const tsconfig = getTsJestConfig(config)
+    const tsconfig = getTypeScriptConfig(vueJestConfig.tsConfig)
 
     const res = typescript.transpileModule(scriptContent, {
       ...tsconfig,

diff --git a/packages/vue2-jest/lib/utils.js b/packages/vue2-jest/lib/utils.js
@@ -1,5 +1,6 @@
 const constants = require('./constants')
 const loadPartialConfig = require('@babel/core').loadPartialConfig
+const { loadSync: loadTsConfigSync } = require('tsconfig')
 const chalk = require('chalk')
 const path = require('path')
 const fs = require('fs')
@@ -67,17 +68,28 @@ const getBabelOptions = function loadBabelOptions(filename, options = {}) {
   return loadPartialConfig(opts).options
 }
 
-const getTsJestConfig = function getTsJestConfig(config) {
-  const { ConfigSet } = require('ts-jest/dist/legacy/config/config-set')
-  const configSet = new ConfigSet(config.config)
-  var tsConfig = configSet.typescript || configSet.parsedTsConfig
+/**
+ * Load TypeScript config from tsconfig.json.
+ * @param {string | undefined} path tsconfig.json file path (default: root)
+ * @returns {import('typescript').TranspileOptions | null} TypeScript compilerOptions or null
+ */
+const getTypeScriptConfig = function getTypeScriptConfig(path) {
+  const tsconfig = loadTsConfigSync(process.cwd(), path || '')
+  if (!tsconfig.path) {
+    warn(`Not found tsconfig.json.`)
+    return null
+  }
+  const compilerOptions =
+    (tsconfig.config && tsconfig.config.compilerOptions) || {}
+
   return {
-    compilerOptions: { ...tsConfig.options, module: 'commonjs' }
+    compilerOptions: { ...compilerOptions, module: 'commonjs' }
   }
 }
 
 function isValidTransformer(transformer) {
   return (
+    isFunction(transformer.createTransformer) ||
     isFunction(transformer.process) ||
     isFunction(transformer.postprocess) ||
     isFunction(transformer.preprocess)
@@ -110,12 +122,13 @@ const getCustomTransformer = function getCustomTransformer(
 
   if (!isValidTransformer(transformer)) {
     throwError(
-      `transformer must contain at least one process, preprocess, or ` +
-        `postprocess method`
+      `transformer must contain at least one createTransformer(), process(), preprocess(), or postprocess() method`
     )
   }
 
-  return transformer
+  return isFunction(transformer.createTransformer)
+    ? transformer.createTransformer()
+    : transformer
 }
 
 const throwError = function error(msg) {
@@ -152,7 +165,7 @@ module.exports = {
   throwError,
   logResultErrors,
   getCustomTransformer,
-  getTsJestConfig,
+  getTypeScriptConfig,
   getBabelOptions,
   getVueJestConfig,
   transformContent,

diff --git a/packages/vue2-jest/package.json b/packages/vue2-jest/package.json
@@ -32,7 +32,6 @@
     "conventional-changelog": "^1.1.5",
     "jest": "^28.0.2",
     "semantic-release": "^15.13.2",
-    "ts-jest": "^28.0.1",
     "typescript": "^4.6.4",
     "vue": "^2.4.2",
     "vue-template-compiler": "^2.4.2"
@@ -41,12 +40,12 @@
     "@babel/core": "7.x",
     "babel-jest": ">= 28 < 29",
     "jest": "28.x",
-    "ts-jest": ">= 28 < 29",
+    "typescript": ">= 4.3",
     "vue": "^2.x",
     "vue-template-compiler": "^2.x"
   },
   "peerDependenciesMeta": {
-    "ts-jest": {
+    "typescript": {
       "optional": true
     }
   },
@@ -55,7 +54,8 @@
     "@vue/component-compiler-utils": "^3.1.0",
     "chalk": "^2.1.0",
     "css-tree": "^2.0.1",
-    "source-map": "0.5.6"
+    "source-map": "0.5.6",
+    "tsconfig": "^7.0.0"
   },
   "repository": {
     "type": "git",

diff --git a/packages/vue3-jest/lib/process.js b/packages/vue3-jest/lib/process.js
@@ -6,8 +6,8 @@ const typescriptTransformer = require('./transformers/typescript')
 const coffeescriptTransformer = require('./transformers/coffee')
 const _processStyle = require('./process-style')
 const processCustomBlocks = require('./process-custom-blocks')
+const getTypeScriptConfig = require('./utils').getTypeScriptConfig
 const getVueJestConfig = require('./utils').getVueJestConfig
-const getTsJestConfig = require('./utils').getTsJestConfig
 const logResultErrors = require('./utils').logResultErrors
 const stripInlineSourceMap = require('./utils').stripInlineSourceMap
 const getCustomTransformer = require('./utils').getCustomTransformer
@@ -118,7 +118,7 @@ function processTemplate(descriptor, filename, config) {
 
   logResultErrors(result)
 
-  const tsconfig = getTsJestConfig(config)
+  const tsconfig = getTypeScriptConfig(vueJestConfig.tsConfig)
 
   if (tsconfig) {
     // they are using TypeScript.

diff --git a/packages/vue3-jest/lib/transformers/typescript.js b/packages/vue3-jest/lib/transformers/typescript.js
@@ -1,9 +1,9 @@
 const ensureRequire = require('../ensure-require')
 const babelJest = require('babel-jest').default
 const {
-  getTsJestConfig,
   stripInlineSourceMap,
   getCustomTransformer,
+  getTypeScriptConfig,
   getVueJestConfig
 } = require('../utils')
 
@@ -12,7 +12,7 @@ module.exports = {
     ensureRequire('typescript', ['typescript'])
     const typescript = require('typescript')
     const vueJestConfig = getVueJestConfig(config)
-    const tsconfig = getTsJestConfig(config)
+    const tsconfig = getTypeScriptConfig(vueJestConfig.tsConfig)
 
     const res = typescript.transpileModule(scriptContent, {
       ...tsconfig,

diff --git a/packages/vue3-jest/lib/utils.js b/packages/vue3-jest/lib/utils.js
@@ -1,6 +1,6 @@
 const constants = require('./constants')
 const loadPartialConfig = require('@babel/core').loadPartialConfig
-const { resolveSync: resolveTsConfigSync } = require('tsconfig')
+const { loadSync: loadTsConfigSync } = require('tsconfig')
 const chalk = require('chalk')
 const path = require('path')
 const fs = require('fs')
@@ -68,24 +68,29 @@ const getBabelOptions = function loadBabelOptions(filename, options = {}) {
   return loadPartialConfig(opts).options
 }
 
-const getTsJestConfig = function getTsJestConfig(config) {
-  const tsConfigPath = getVueJestConfig(config).tsConfig || ''
-  const isUsingTs = resolveTsConfigSync(process.cwd(), tsConfigPath)
-  if (!isUsingTs) {
+/**
+ * Load TypeScript config from tsconfig.json.
+ * @param {string | undefined} path tsconfig.json file path (default: root)
+ * @returns {import('typescript').TranspileOptions | null} TypeScript compilerOptions or null
+ */
+const getTypeScriptConfig = function getTypeScriptConfig(path) {
+  const tsconfig = loadTsConfigSync(process.cwd(), path || '')
+  if (!tsconfig.path) {
+    warn(`Not found tsconfig.json.`)
     return null
   }
+  const compilerOptions =
+    (tsconfig.config && tsconfig.config.compilerOptions) || {}
 
-  const { ConfigSet } = require('ts-jest/dist/legacy/config/config-set')
-  const configSet = new ConfigSet(config.config)
-  const tsConfig = configSet.typescript || configSet.parsedTsConfig
   // Force es5 to prevent const vue_1 = require('vue') from conflicting
   return {
-    compilerOptions: { ...tsConfig.options, target: 'es5', module: 'commonjs' }
+    compilerOptions: { ...compilerOptions, target: 'es5', module: 'commonjs' }
   }
 }
 
 function isValidTransformer(transformer) {
   return (
+    isFunction(transformer.createTransformer) ||
     isFunction(transformer.process) ||
     isFunction(transformer.postprocess) ||
     isFunction(transformer.preprocess)
@@ -119,12 +124,13 @@ const getCustomTransformer = function getCustomTransformer(
 
   if (!isValidTransformer(transformer)) {
     throwError(
-      `transformer must contain at least one process, preprocess, or ` +
-        `postprocess method`
+      `transformer must contain at least one createTransformer(), process(), preprocess(), or postprocess() method`
     )
   }
 
-  return transformer
+  return isFunction(transformer.createTransformer)
+    ? transformer.createTransformer()
+    : transformer
 }
 
 const throwError = function error(msg) {
@@ -161,7 +167,7 @@ module.exports = {
   throwError,
   logResultErrors,
   getCustomTransformer,
-  getTsJestConfig,
+  getTypeScriptConfig,
   getBabelOptions,
   getVueJestConfig,
   transformContent,

diff --git a/packages/vue3-jest/package.json b/packages/vue3-jest/package.json
@@ -31,22 +31,17 @@
     "jest": "^28.0.2",
     "jest-cli": "^28.0.2",
     "semantic-release": "^15.13.2",
-    "ts-jest": "^28.0.1",
     "typescript": "^4.6.4",
     "vue": "^3.2.22"
   },
   "peerDependencies": {
     "@babel/core": "7.x",
     "babel-jest": "28.x",
     "jest": "28.x",
-    "ts-jest": "28.x",
     "typescript": ">= 4.3",
     "vue": "^3.0.0-0"
   },
   "peerDependenciesMeta": {
-    "ts-jest": {
-      "optional": true
-    },
     "typescript": {
       "optional": true
     }