Rewrite to version 5.0.0

[piotr-oles]

As I promised a few weeks ago, I've performed a rewrite of the plugin to pay off technical debt and open this plugin for future development. This is a draft PR to show you the progress.

Tasks:

• Pay off technical debt
• Support for TypeScript Watch API controlled by webpack (Sometimes watch is using old Diagnostics #362, preserveSymlinks option not honored #332, Occasionally stops working #330, CPU usage on idle? #236, useTypescriptIncrementalApi increases initial build time #211)
• Support for TypeScript Solution Builder API (projectReferences) (TS6305: Output file '/path/to/dist/index.d.ts' has not been built from source file '/path/to/src/index.ts'. #392, TS 3.6 will come with api support for --build and --incremental #328, Plugin doesn't run for project references #187)
• Support for TypeScript Incremental API (partially implemented by using SolutionBuilder) (utilize ts 3.4 build cache to improve startup time #238)
• Support for Yarn PnP
• Support for EsLint
• TypeScript extensions infrastructure
• Support for Vue.js (TypeScript Watch API) (Vue files are not type checked or linted with useTypescriptIncrementalApi #219)
• Improve Vue template compiler error message (Improve error message for mismatched vue, vue-template-compiler #209)
• Documentation (Add docs for Yarn PnP usage #298, types.ts files do not trigger rebuild in webpack-dev-server #36 - add information about importsNotUsedAsValues: preserve)
• Unit Tests
• E2E Tests
• Reevaluate supported versions (TypeScript >=2.7.0, Webpack >=4.0.0, Node.js >=10) (Re-Evaluate supported TypeScript versions, open bugs in older versions #257)
• Properly closing services on out of memory error (Memory leak: service.js process is running after node heap out of memory crash #387)
• Inform users on out of memory error that its probably bug in the TypeScript itself
• Support for Webpack 5 (incompatible with Webpack 5.0 #383)
• Support for Webpack multi-compiler (Does not work with Webpack Multiple Target Configuration #229)
• Ensure that types are properly exposed (Cannot find module issue while using on a webpack.config.TS file #359, Could not find a declaration file for module 'webpack' / 'tapable' #339, wrong declarations - Initializers are not allowed in ambient contexts. #188)
• Using the external format for Compiler Options (Compiler options are expected in internal format #393, (feature) Support overriding compilerOptions settings and tslint config #112)
• Unified issues processing (include, exclude, issues hook) (TS|TSX files are linted with useTypescriptIncrementalApi #396, eslint emitWarning option #374, add option to enable --quiet in eslint #340, Feature request: option to warn instead of failing build #232, Fail CI build on TSLint warning / Support tslintEmitErrors config #216)
• External configuration (Doesn't read the memoryLimit from tsconfig.json #397)
• Review breaking changes and help with migration for major packages that cooperates with this plugin (ts-loader, create-react-app, pnp-webpack-plugin - please let me know if I should consider other packages too)
• Integrate with webpack-dev-server with async: true mode (No type errors in browser console #180)
• Set default skipLibCheck: true option (Type checking for node_modules #128)
• Don't pollute --json output of stats (Don't print info when running webpack --json #101)
• Better debugging experience (for example: debug: true flag) (Enable typescript's traceResolution option #59)

This release should fix also: #309, #303, #273

Plan:

1. release first alpha version when unit tests will be ready to have at least minimal test coverage.
2. release second alpha version when integration test will be ready to have it stable
3. update documentation
4. go through the rest of checklist items, implement it in a separate PRs and release

I'm not sure if I will go through all these points before releasing stable 5.0.0 - some of these points can be implemented later 🚀

[johnnyreilly]

Amazing work so far @piotr-oles!

cc @sheetalkamat and @andrewbranch - I thought you might be interested in the work Piotr has been putting into making fork-ts-checker-webpack-plugin project references and tsbuildinfo friendly ☺️

[johnnyreilly]

Yeah this is looking really promising! 🤗

[piotr-oles]

Hi @johnnyreilly , I implemented most of the points from the checklist, wrote end-to-end tests, and updated the documentation. Could you re-review this PR?

[piotr-oles]

As this is an only alpha release and all tests passed, I will merge it :)

@johnnyreilly , @phryneas I know it's a big PR, so please review it when you have more time and if you have any comments, I will address them in the next alpha releases.

[phryneas]

This is huuuge 😄
Congrats to that big hunk of work you pulled off there - very impressive!

Is's not really possible to review this as a diff, so I just took a deep dive at the source code.

I really like the new architecture, it's a lot cleaner - great job on that 👍
After reading it, I have to say: I understand what's going on, but if there are any bugs, I probably missed those because I'm not too accustomed to the code base and also haven't had a lot of time to spend with webpack in the recent past. So my review comments are primarily of a more generic nature.

I'll definitely start dogfooding this as soon as I get back into our react project (doing a lot of infra at the moment) and will report back if I find any anomalies there.

[phryneas]

Generally, there is a lot of compiler as any going on and that makes some stuff hard to read. Maybe it would make sense to define some interface extending webpack.Compiler and cast that at a central location once or twice?

Something like

type Webpack4Or5 = webpack.Compiler & ({
// webpack 5 stuff
} | {
// webpack 4 stuff
})

The compiler should be able to use the relevant properties as discriminator from there.

[piotr-oles]

I will try that :)

[johnnyreilly]

Just wanted to share these timings that @Timer was kind enough to do here: vercel/next.js#13529 (comment)

Base build: 7s (no TypeScript features enabled)

[email protected]: 90s, computer sounds like an airplane
[email protected]: 84s, computer did not sound like an airplane
[email protected]: 90s, regressed
npx tsc -p tsconfig.json --noEmit: 12s (time: 18.57s user 0.97s system 169% cpu 11.525 total)

[weyert]

John, do you think this is due the rewrite to TypeScript or has more changed during the rewrite? I can imagine the TypeScript transpilling does some more runtime checks

[piotr-oles]

🎉 This PR is included in version 5.0.0-alpha.17 🎉

The release is available on:

• npm package (@alpha dist-tag)
• GitHub release

Your semantic-release bot 📦🚀

[piotr-oles]

🎉 This PR is included in version 5.0.0-beta.2 🎉

The release is available on:

• npm package (@beta dist-tag)
• GitHub release

Your semantic-release bot 📦🚀