Skip to content

Commit a84eafb

Browse files
nogic1008nogic1008
authored
feat: load TypeScript config from tsconfig package instead of ts-jest (#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
1 parent 4530039 commit a84eafb

File tree

14 files changed

+62
-51
lines changed

14 files changed

+62
-51
lines changed

‎e2e/2.x/babel-in-package/package.json

-1
Original file line numberDiff line numberDiff line change
@@ -20,7 +20,6 @@
2020
"coffeescript": "^2.3.2",
2121
"jest": "28.x",
2222
"jest-environment-jsdom": "28.0.2",
23-
"ts-jest": "^28.0.1",
2423
"typescript": "^4.6.4"
2524
},
2625
"jest": {

‎e2e/2.x/basic/package.json

+2-3
Original file line numberDiff line numberDiff line change
@@ -14,6 +14,7 @@
1414
"@babel/core": "^7.9.0",
1515
"@babel/preset-env": "^7.9.0",
1616
"@vue/test-utils": "^1.1.0",
17+
"@vue/vue2-jest": "^28.0.0",
1718
"babel-helper-vue-jsx-merge-props": "^2.0.3",
1819
"babel-plugin-syntax-jsx": "^6.18.0",
1920
"babel-plugin-transform-vue-jsx": "^3.7.0",
@@ -23,9 +24,7 @@
2324
"jest-environment-jsdom": "28.0.2",
2425
"pug": "^3.0.1",
2526
"sass": "^1.23.7",
26-
"ts-jest": "^28.0.1",
27-
"typescript": "^4.6.4",
28-
"@vue/vue2-jest": "^28.0.0"
27+
"typescript": "^4.6.4"
2928
},
3029
"jest": {
3130
"testEnvironment": "jsdom",

‎e2e/3.x/babel-in-package/package.json

+2-2
Original file line numberDiff line numberDiff line change
@@ -12,12 +12,12 @@
1212
"devDependencies": {
1313
"@babel/core": "^7.9.0",
1414
"@babel/preset-env": "^7.9.0",
15+
"@vue/vue3-jest": "^28.0.0",
1516
"coffeescript": "^2.3.2",
1617
"jest": "^28.0.0",
1718
"jest-environment-jsdom": "28.0.2",
1819
"ts-jest": "^28.0.1",
19-
"typescript": "^4.6.4",
20-
"@vue/vue3-jest": "^28.0.0"
20+
"typescript": "^4.6.4"
2121
},
2222
"jest": {
2323
"testEnvironment": "jsdom",

‎e2e/3.x/basic/package.json

+1-1
Original file line numberDiff line numberDiff line change
@@ -12,6 +12,7 @@
1212
"devDependencies": {
1313
"@babel/core": "^7.9.0",
1414
"@babel/preset-env": "^7.9.0",
15+
"@vue/vue3-jest": "^28.0.0",
1516
"babel-helper-vue-jsx-merge-props": "^2.0.3",
1617
"babel-plugin-syntax-jsx": "^6.18.0",
1718
"babel-plugin-transform-vue-jsx": "^3.7.0",
@@ -23,7 +24,6 @@
2324
"ts-jest": "^28.0.1",
2425
"typescript": "^4.6.4",
2526
"vue-class-component": "^8.0.0-beta.4",
26-
"@vue/vue3-jest": "^28.0.0",
2727
"vue-property-decorator": "^10.0.0-rc.3"
2828
}
2929
}

‎e2e/3.x/typescript-with-babel/package.json

+2-3
Original file line numberDiff line numberDiff line change
@@ -12,11 +12,10 @@
1212
"devDependencies": {
1313
"@babel/core": "^7.9.0",
1414
"@babel/preset-env": "^7.9.0",
15+
"@vue/vue3-jest": "^28.0.0",
1516
"jest": "^28.0.2",
1617
"jest-environment-jsdom": "28.0.2",
17-
"ts-jest": "^28.0.1",
18-
"typescript": "^4.6.4",
19-
"@vue/vue3-jest": "^28.0.0"
18+
"typescript": "^4.6.4"
2019
},
2120
"jest": {
2221
"testEnvironment": "jsdom",

‎e2e/3.x/typescript-with-compiler-options/package.json

+2-2
Original file line numberDiff line numberDiff line change
@@ -11,11 +11,11 @@
1111
},
1212
"devDependencies": {
1313
"@types/jest": "16.0.10",
14+
"@vue/vue3-jest": "^28.0.0",
1415
"jest": "^28.0.2",
1516
"jest-environment-jsdom": "28.0.2",
1617
"ts-jest": "^28.0.1",
17-
"typescript": "^4.6.4",
18-
"@vue/vue3-jest": "^28.0.0"
18+
"typescript": "^4.6.4"
1919
},
2020
"jest": {
2121
"testEnvironment": "jsdom",

‎e2e/3.x/typescript/package.json

+2-2
Original file line numberDiff line numberDiff line change
@@ -11,11 +11,11 @@
1111
},
1212
"devDependencies": {
1313
"@types/jest": "16.0.10",
14+
"@vue/vue3-jest": "^28.0.0",
1415
"jest": "^28.0.2",
1516
"jest-environment-jsdom": "28.0.2",
1617
"ts-jest": "^28.0.1",
17-
"typescript": "^4.6.4",
18-
"@vue/vue3-jest": "^28.0.0"
18+
"typescript": "^4.6.4"
1919
},
2020
"jest": {
2121
"testEnvironment": "jsdom",

‎packages/vue2-jest/lib/transformers/typescript.js

+2-2
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,9 @@
11
const ensureRequire = require('../ensure-require')
22
const babelJest = require('babel-jest').default
33
const {
4-
getTsJestConfig,
54
stripInlineSourceMap,
65
getCustomTransformer,
6+
getTypeScriptConfig,
77
getVueJestConfig
88
} = require('../utils')
99

@@ -12,7 +12,7 @@ module.exports = scriptLang => ({
1212
ensureRequire('typescript', ['typescript'])
1313
const typescript = require('typescript')
1414
const vueJestConfig = getVueJestConfig(config)
15-
const tsconfig = getTsJestConfig(config)
15+
const tsconfig = getTypeScriptConfig(vueJestConfig.tsConfig)
1616

1717
const res = typescript.transpileModule(scriptContent, {
1818
...tsconfig,

‎packages/vue2-jest/lib/utils.js

+22-9
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,6 @@
11
const constants = require('./constants')
22
const loadPartialConfig = require('@babel/core').loadPartialConfig
3+
const { loadSync: loadTsConfigSync } = require('tsconfig')
34
const chalk = require('chalk')
45
const path = require('path')
56
const fs = require('fs')
@@ -67,17 +68,28 @@ const getBabelOptions = function loadBabelOptions(filename, options = {}) {
6768
return loadPartialConfig(opts).options
6869
}
6970

70-
const getTsJestConfig = function getTsJestConfig(config) {
71-
const { ConfigSet } = require('ts-jest/dist/legacy/config/config-set')
72-
const configSet = new ConfigSet(config.config)
73-
var tsConfig = configSet.typescript || configSet.parsedTsConfig
71+
/**
72+
* Load TypeScript config from tsconfig.json.
73+
* @param {string | undefined} path tsconfig.json file path (default: root)
74+
* @returns {import('typescript').TranspileOptions | null} TypeScript compilerOptions or null
75+
*/
76+
const getTypeScriptConfig = function getTypeScriptConfig(path) {
77+
const tsconfig = loadTsConfigSync(process.cwd(), path || '')
78+
if (!tsconfig.path) {
79+
warn(`Not found tsconfig.json.`)
80+
return null
81+
}
82+
const compilerOptions =
83+
(tsconfig.config && tsconfig.config.compilerOptions) || {}
84+
7485
return {
75-
compilerOptions: { ...tsConfig.options, module: 'commonjs' }
86+
compilerOptions: { ...compilerOptions, module: 'commonjs' }
7687
}
7788
}
7889

7990
function isValidTransformer(transformer) {
8091
return (
92+
isFunction(transformer.createTransformer) ||
8193
isFunction(transformer.process) ||
8294
isFunction(transformer.postprocess) ||
8395
isFunction(transformer.preprocess)
@@ -110,12 +122,13 @@ const getCustomTransformer = function getCustomTransformer(
110122

111123
if (!isValidTransformer(transformer)) {
112124
throwError(
113-
`transformer must contain at least one process, preprocess, or ` +
114-
`postprocess method`
125+
`transformer must contain at least one createTransformer(), process(), preprocess(), or postprocess() method`
115126
)
116127
}
117128

118-
return transformer
129+
return isFunction(transformer.createTransformer)
130+
? transformer.createTransformer()
131+
: transformer
119132
}
120133

121134
const throwError = function error(msg) {
@@ -152,7 +165,7 @@ module.exports = {
152165
throwError,
153166
logResultErrors,
154167
getCustomTransformer,
155-
getTsJestConfig,
168+
getTypeScriptConfig,
156169
getBabelOptions,
157170
getVueJestConfig,
158171
transformContent,

‎packages/vue2-jest/package.json

+4-4
Original file line numberDiff line numberDiff line change
@@ -32,7 +32,6 @@
3232
"conventional-changelog": "^1.1.5",
3333
"jest": "^28.0.2",
3434
"semantic-release": "^15.13.2",
35-
"ts-jest": "^28.0.1",
3635
"typescript": "^4.6.4",
3736
"vue": "^2.4.2",
3837
"vue-template-compiler": "^2.4.2"
@@ -41,12 +40,12 @@
4140
"@babel/core": "7.x",
4241
"babel-jest": ">= 28 < 29",
4342
"jest": "28.x",
44-
"ts-jest": ">= 28 < 29",
43+
"typescript": ">= 4.3",
4544
"vue": "^2.x",
4645
"vue-template-compiler": "^2.x"
4746
},
4847
"peerDependenciesMeta": {
49-
"ts-jest": {
48+
"typescript": {
5049
"optional": true
5150
}
5251
},
@@ -55,7 +54,8 @@
5554
"@vue/component-compiler-utils": "^3.1.0",
5655
"chalk": "^2.1.0",
5756
"css-tree": "^2.0.1",
58-
"source-map": "0.5.6"
57+
"source-map": "0.5.6",
58+
"tsconfig": "^7.0.0"
5959
},
6060
"repository": {
6161
"type": "git",

‎packages/vue3-jest/lib/process.js

+2-2
Original file line numberDiff line numberDiff line change
@@ -6,8 +6,8 @@ const typescriptTransformer = require('./transformers/typescript')
66
const coffeescriptTransformer = require('./transformers/coffee')
77
const _processStyle = require('./process-style')
88
const processCustomBlocks = require('./process-custom-blocks')
9+
const getTypeScriptConfig = require('./utils').getTypeScriptConfig
910
const getVueJestConfig = require('./utils').getVueJestConfig
10-
const getTsJestConfig = require('./utils').getTsJestConfig
1111
const logResultErrors = require('./utils').logResultErrors
1212
const stripInlineSourceMap = require('./utils').stripInlineSourceMap
1313
const getCustomTransformer = require('./utils').getCustomTransformer
@@ -118,7 +118,7 @@ function processTemplate(descriptor, filename, config) {
118118

119119
logResultErrors(result)
120120

121-
const tsconfig = getTsJestConfig(config)
121+
const tsconfig = getTypeScriptConfig(vueJestConfig.tsConfig)
122122

123123
if (tsconfig) {
124124
// they are using TypeScript.

‎packages/vue3-jest/lib/transformers/typescript.js

+2-2
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,9 @@
11
const ensureRequire = require('../ensure-require')
22
const babelJest = require('babel-jest').default
33
const {
4-
getTsJestConfig,
54
stripInlineSourceMap,
65
getCustomTransformer,
6+
getTypeScriptConfig,
77
getVueJestConfig
88
} = require('../utils')
99

@@ -12,7 +12,7 @@ module.exports = {
1212
ensureRequire('typescript', ['typescript'])
1313
const typescript = require('typescript')
1414
const vueJestConfig = getVueJestConfig(config)
15-
const tsconfig = getTsJestConfig(config)
15+
const tsconfig = getTypeScriptConfig(vueJestConfig.tsConfig)
1616

1717
const res = typescript.transpileModule(scriptContent, {
1818
...tsconfig,

‎packages/vue3-jest/lib/utils.js

+19-13
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
const constants = require('./constants')
22
const loadPartialConfig = require('@babel/core').loadPartialConfig
3-
const { resolveSync: resolveTsConfigSync } = require('tsconfig')
3+
const { loadSync: loadTsConfigSync } = require('tsconfig')
44
const chalk = require('chalk')
55
const path = require('path')
66
const fs = require('fs')
@@ -68,24 +68,29 @@ const getBabelOptions = function loadBabelOptions(filename, options = {}) {
6868
return loadPartialConfig(opts).options
6969
}
7070

71-
const getTsJestConfig = function getTsJestConfig(config) {
72-
const tsConfigPath = getVueJestConfig(config).tsConfig || ''
73-
const isUsingTs = resolveTsConfigSync(process.cwd(), tsConfigPath)
74-
if (!isUsingTs) {
71+
/**
72+
* Load TypeScript config from tsconfig.json.
73+
* @param {string | undefined} path tsconfig.json file path (default: root)
74+
* @returns {import('typescript').TranspileOptions | null} TypeScript compilerOptions or null
75+
*/
76+
const getTypeScriptConfig = function getTypeScriptConfig(path) {
77+
const tsconfig = loadTsConfigSync(process.cwd(), path || '')
78+
if (!tsconfig.path) {
79+
warn(`Not found tsconfig.json.`)
7580
return null
7681
}
82+
const compilerOptions =
83+
(tsconfig.config && tsconfig.config.compilerOptions) || {}
7784

78-
const { ConfigSet } = require('ts-jest/dist/legacy/config/config-set')
79-
const configSet = new ConfigSet(config.config)
80-
const tsConfig = configSet.typescript || configSet.parsedTsConfig
8185
// Force es5 to prevent const vue_1 = require('vue') from conflicting
8286
return {
83-
compilerOptions: { ...tsConfig.options, target: 'es5', module: 'commonjs' }
87+
compilerOptions: { ...compilerOptions, target: 'es5', module: 'commonjs' }
8488
}
8589
}
8690

8791
function isValidTransformer(transformer) {
8892
return (
93+
isFunction(transformer.createTransformer) ||
8994
isFunction(transformer.process) ||
9095
isFunction(transformer.postprocess) ||
9196
isFunction(transformer.preprocess)
@@ -119,12 +124,13 @@ const getCustomTransformer = function getCustomTransformer(
119124

120125
if (!isValidTransformer(transformer)) {
121126
throwError(
122-
`transformer must contain at least one process, preprocess, or ` +
123-
`postprocess method`
127+
`transformer must contain at least one createTransformer(), process(), preprocess(), or postprocess() method`
124128
)
125129
}
126130

127-
return transformer
131+
return isFunction(transformer.createTransformer)
132+
? transformer.createTransformer()
133+
: transformer
128134
}
129135

130136
const throwError = function error(msg) {
@@ -161,7 +167,7 @@ module.exports = {
161167
throwError,
162168
logResultErrors,
163169
getCustomTransformer,
164-
getTsJestConfig,
170+
getTypeScriptConfig,
165171
getBabelOptions,
166172
getVueJestConfig,
167173
transformContent,

‎packages/vue3-jest/package.json

-5
Original file line numberDiff line numberDiff line change
@@ -31,22 +31,17 @@
3131
"jest": "^28.0.2",
3232
"jest-cli": "^28.0.2",
3333
"semantic-release": "^15.13.2",
34-
"ts-jest": "^28.0.1",
3534
"typescript": "^4.6.4",
3635
"vue": "^3.2.22"
3736
},
3837
"peerDependencies": {
3938
"@babel/core": "7.x",
4039
"babel-jest": "28.x",
4140
"jest": "28.x",
42-
"ts-jest": "28.x",
4341
"typescript": ">= 4.3",
4442
"vue": "^3.0.0-0"
4543
},
4644
"peerDependenciesMeta": {
47-
"ts-jest": {
48-
"optional": true
49-
},
5045
"typescript": {
5146
"optional": true
5247
}

0 commit comments

Comments
 (0)