Repository navigation
NXT-20954: Added custom typecheck for Typescript 7 #405
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,147 @@ | ||
| 'use strict'; | ||
| const {spawn} = require('child_process'); | ||
| const path = require('path'); | ||
| const {WebpackError} = require('webpack'); | ||
|
|
||
| const pluginName = 'EnactTypeScriptCheckPlugin'; | ||
|
|
||
| // Errors reported by this plugin, so `enact serve` can tell them apart from other compilation errors | ||
| const reportedErrors = new WeakSet(); | ||
|
|
||
| // Diagnostics are not reported for test and setup files, matching the fork-ts-checker issue filters. | ||
| const excludeFile = /(^|[\\/])__tests__[\\/]|\.(spec|test)\.[^\\/]+$|(^|[\\/])src[\\/]setup(Proxy|Tests)\.[^\\/]+$/; | ||
|
|
||
| // Parses `tsc --pretty false` output. Each diagnostic starts with `file(line,col): error TSxxxx: message` | ||
| // (or `error TSxxxx: message` for global ones) and any following indented lines elaborate on it. | ||
| function parseDiagnostics (output) { | ||
| const diagnostics = []; | ||
| output.split(/\r?\n/).forEach(line => { | ||
| const located = /^(.+)\((\d+),(\d+)\): (error|warning) (TS\d+): (.*)$/.exec(line); | ||
| const unlocated = !located && /^(error|warning) (TS\d+): (.*)$/.exec(line); | ||
| if (located) { | ||
| const [, file, row, column, category, code, text] = located; | ||
| diagnostics.push({file, row, column, category, code, text}); | ||
| } else if (unlocated) { | ||
| const [, category, code, text] = unlocated; | ||
| diagnostics.push({category, code, text}); | ||
| } else if (line.trim() && diagnostics.length) { | ||
| diagnostics[diagnostics.length - 1].text += '\n' + line; | ||
| } | ||
| }); | ||
| return diagnostics; | ||
| } | ||
|
|
||
| function formatDiagnostic ({file, row, column, code, text}) { | ||
| return (file ? `${file}(${row},${column})\n` : '') + `${code}: ${text}`; | ||
| } | ||
|
|
||
| // Type checks the app with the `tsc` binary for TypeScript versions that do not expose the compiler API | ||
| // required by fork-ts-checker (TypeScript 7+). `tsc` runs alongside each webpack compilation and its | ||
| // diagnostics are added to the compilation once it finishes. | ||
| class TypeScriptCheckPlugin { | ||
| constructor ({tscPath, context, compileOnError = false}) { | ||
| this.tscPath = tscPath; | ||
| this.context = context; | ||
| this.compileOnError = compileOnError; | ||
| this.child = null; | ||
| this.check = null; | ||
| } | ||
|
|
||
| runTsc () { | ||
| this.cancel(); | ||
| const args = [ | ||
| this.tscPath, | ||
| '--project', | ||
| path.join(this.context, 'tsconfig.json'), | ||
| '--noEmit', | ||
| '--skipLibCheck', | ||
| '--incremental', | ||
| '--tsBuildInfoFile', | ||
| path.join(this.context, 'node_modules', '.cache', 'tsconfig.tsbuildinfo'), | ||
| '--pretty', | ||
| 'false' | ||
| ]; | ||
|
|
||
| return new Promise(resolve => { | ||
| let output = ''; | ||
| const child = spawn(process.execPath, args, {cwd: this.context, windowsHide: true}); | ||
| this.child = child; | ||
| child.stdout.on('data', data => (output += data)); | ||
| child.stderr.on('data', data => (output += data)); | ||
| child.on('error', err => { | ||
| resolve({failure: err.message}); | ||
| }); | ||
| child.on('close', (exitCode, signal) => { | ||
| if (this.child === child) this.child = null; | ||
| if (signal) { | ||
| resolve({cancelled: true}); | ||
| } else if (exitCode === 0) { | ||
| resolve({diagnostics: []}); | ||
| } else { | ||
| const diagnostics = parseDiagnostics(output); | ||
| // A non-zero exit without any parsable diagnostics means tsc itself failed | ||
| resolve( | ||
| diagnostics.length ? | ||
| {diagnostics} : | ||
| {failure: output.trim() || `tsc exited with code ${exitCode}`} | ||
| ); | ||
| } | ||
| }); | ||
| }); | ||
| } | ||
|
|
||
| cancel () { | ||
| if (this.child) { | ||
| this.child.kill(); | ||
| this.child = null; | ||
| } | ||
| } | ||
|
|
||
| apply (compiler) { | ||
| const start = () => { | ||
| this.check = this.runTsc(); | ||
| }; | ||
| compiler.hooks.run.tap(pluginName, start); | ||
| compiler.hooks.watchRun.tap(pluginName, start); | ||
| compiler.hooks.watchClose.tap(pluginName, () => this.cancel()); | ||
| compiler.hooks.shutdown.tap(pluginName, () => this.cancel()); | ||
|
|
||
| compiler.hooks.afterCompile.tapPromise(pluginName, compilation => { | ||
| // Child compilers inherit this hook; only report on the main compilation | ||
| if (compilation.compiler !== compiler || !this.check) return Promise.resolve(); | ||
|
|
||
| return this.check.then(({cancelled, failure, diagnostics}) => { | ||
| if (cancelled) return; | ||
| if (failure) { | ||
| compilation.warnings.push(new WebpackError(`TypeScript type checking could not run:\n${failure}`)); | ||
| return; | ||
| } | ||
| const errors = []; | ||
| const warnings = []; | ||
| diagnostics | ||
| .filter(({file}) => !file || !excludeFile.test(file)) | ||
| .forEach(diagnostic => { | ||
| const isError = diagnostic.category === 'error' && !this.compileOnError; | ||
| (isError ? errors : warnings).push(formatDiagnostic(diagnostic)); | ||
| }); | ||
|
|
||
| // All diagnostics are reported as a single issue, since react-dev-utils only | ||
| // prints the first error of a compilation in `enact serve` | ||
| const report = (list, issues) => { | ||
| if (!list.length) return; | ||
| const issue = new WebpackError(list.join('\n\n')); | ||
| issue.hideStack = true; | ||
| issues.push(issue); | ||
| return issue; | ||
| }; | ||
| const error = report(errors, compilation.errors); | ||
| if (error) reportedErrors.add(error); | ||
| report(warnings, compilation.warnings); | ||
| }); | ||
| }); | ||
| } | ||
| } | ||
|
|
||
| TypeScriptCheckPlugin.isTypeScriptError = error => reportedErrors.has(error); | ||
|
|
||
| module.exports = TypeScriptCheckPlugin; | ||
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Uh oh!
There was an error while loading. Please reload this page.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
A tsc process stopped on Windows is not treated as cancelled. (optional)
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I checked this on Windows (Node 24) with the real child: the TS 7 bin/tsc wrapper that the plugin spawns. After child.kill(), the close event fires with code=null, signal='SIGTERM'. On Windows, libuv records the exit signal when TerminateProcess succeeds, so the result goes through the if (signal) branch and resolves as {cancelled: true}.
I will be beaving this as is