fix(tsconfig): parse extended tsconfigs when transpiling script blocks #502
Conversation
|
@lmiller1990 I wouldn't mind back-patching this to vue-jest v28.x also, but there isn't a branch to target for that. What is the process for backpatching? I support infrastructure that wraps around these tools and I'm currently having to workaround this problem in my project's v28 branch, so it would be nice to be able to remove the workaround in both places. [Update] I'm just going to release jest 28 and jest 29 support for my package using the workaround. I will probably update the jest 29 release to not use the workaround if/when this PR gets released, but will probably just leave the jest 28 implementation alone. |
thebanjomatic
force-pushed
the
fix/tsconfig-extends
branch
3 times, most recently
from
6f7d17e
to
61a57b3
Compare
| ensureRequire('typescript', ['typescript']) | ||
| const typescript = require('typescript') | ||
|
|
||
| const tsconfigPath = resolveTsConfigSync(process.cwd(), path || '') |
There was a problem hiding this comment.
Note: we are still using the tsconfig package to resolve the path to the tsconfig file in the same way that tsconfig.loadSync was previously doing.
| onUnRecoverableConfigFileDiagnostic: e => { | ||
| const errorMessage = typescript.formatDiagnostic(e, { | ||
| getCurrentDirectory: () => process.cwd(), | ||
| getNewLine: () => `\n`, | ||
| getCanonicalFileName: file => file.replace(/\\/g, '/') | ||
| }) | ||
| warn(errorMessage) | ||
| } |
There was a problem hiding this comment.
This will provide us with an error message if typescript is unable to read the tsconfig file or one of the extended files because they don't exist or don't parse etc.
There was a problem hiding this comment.
This is nice, I like good error messages.
packages/vue2-jest/lib/utils.js
Outdated
| if (path in tsConfigCache) { | ||
| return tsConfigCache[path] | ||
| } |
There was a problem hiding this comment.
Note: Return early from cache if we have already encountered that path.
I don't know how expensive ts.getParsedCommandLineOfConfigFile is, or if typescript is doing any caching internally, but I typically only call this once per-project rather than per source file when I've used it in the past.
Since getTypescriptConfig is also called for each interpolated script block in the template as well as the <script> block of the SFC, it seemed like a good idea to just cache the parsed config result and reuse it.
| const transpileConfig = { | ||
| compilerOptions: { | ||
| ...compilerOptions, | ||
| module: typescript.ModuleKind.CommonJS |
There was a problem hiding this comment.
Note: As in the old code, we override the module with commonjs. I changed this to use the enum instead of a string literal because it failed to compile in my typescript version of this code. The expected value of CompilerOptions['module'] is ModuleKind, but it does seem to accept the string literals at runtime.
| @@ -1,4 +1,4 @@ | |||
| const throwError = require('./utils').throwError | |||
| const throwError = require('./throw-error') | |||
There was a problem hiding this comment.
Note: In order to use ensure-require from within utils.js, I needed to break the circular dependency. This was done by moving throw-error out of utils and into its own module so that ensure-require doesn't depend on utils.
| // these conditions are not being met and happen to be the use-case which was triggering errors | ||
| // in my config setup. |
There was a problem hiding this comment.
In my project, we were setting esModuleInterop in a shared base config, and Vue.extend(...) was throwing a TypeError when running the test because it "could not read property 'extend' from undefined".
|
@lmiller1990 Have you had the chance to look at this PR? |
|
@thebanjomatic I was offline for all of Oct. I'm back now, let me take a look. |
packages/vue2-jest/lib/utils.js
Outdated
| if (path in tsConfigCache) { | ||
| return tsConfigCache[path] | ||
| } |
| onUnRecoverableConfigFileDiagnostic: e => { | ||
| const errorMessage = typescript.formatDiagnostic(e, { | ||
| getCurrentDirectory: () => process.cwd(), | ||
| getNewLine: () => `\n`, | ||
| getCanonicalFileName: file => file.replace(/\\/g, '/') | ||
| }) | ||
| warn(errorMessage) | ||
| } |
There was a problem hiding this comment.
This is nice, I like good error messages.
… interpolated string
thebanjomatic
force-pushed
the
fix/tsconfig-extends
branch
from
61a57b3
to
76c5419
Compare
|
Thanks @lmiller1990 I have updated this PR with your suggested changes. I'm no longer personally in need of the jest 28 release unless you'd just prefer to patch it because it was broken in v28.1.0 |
|
Done https://github.com/vuejs/vue-jest/releases/tag/v29.2.0 LMK if you have any issues. |
A change introduced in v28.1.0 in PR #471 unintentionally changed the behavior of the tsconfig parsing such that configs using "extends" were no longer being considered.
Fixes: #495