feat: drop support for webpack 4 (#638)

BREAKING CHANGE: 🧨 Webpack 4 is no longer supported. Please upgrade to Webpack ^5.11.0 or use an older version of the plugin.

Author: piotr-oles

README.md

@@ -21,7 +21,7 @@
 
 ## Installation
 
-This plugin requires minimum **Node.js 12**, **Webpack 5**, **TypeScript 3.6**
+This plugin requires minimum **Node.js 12+**, **Webpack ^5.11.0**, **TypeScript ^3.6.0**
 
 * If you depend on **TypeScript 2.1 - 2.6.2**, please use [version 4](https://github.com/TypeStrong/fork-ts-checker-webpack-plugin/tree/v4.1.4) of the plugin.
 * If you depend on **Webpack 4**, **TypeScript 2.7 - 3.5.3** or **ESLint** feature, please use [version 6](https://github.com/TypeStrong/fork-ts-checker-webpack-plugin/tree/v6.2.6) of the plugin.

package.json

@@ -72,7 +72,10 @@
     "minimatch": "^3.0.4",
     "schema-utils": "2.7.0",
     "semver": "^7.3.2",
-    "tapable": "^1.0.0"
+    "tapable": "^2.0.0"
+  },
+  "peerDependencies": {
+    "webpack": "^5.11.0"
   },
   "devDependencies": {
     "@commitlint/config-conventional": "^11.0.0",
@@ -90,7 +93,6 @@
     "@types/node": "^14.11.10",
     "@types/rimraf": "^3.0.0",
     "@types/semver": "^7.3.4",
-    "@types/webpack": "^4.41.22",
     "@typescript-eslint/eslint-plugin": "^2.27.0",
     "@typescript-eslint/parser": "^2.27.0",
     "commitlint": "^11.0.0",
@@ -115,7 +117,7 @@
     "tree-kill": "^1.2.2",
     "ts-jest": "^26.4.1",
     "typescript": "^3.8.3",
-    "webpack": "^4.42.1"
+    "webpack": "^5.11.0"
   },
   "engines": {
     "node": ">=10",

src/ForkTsCheckerWebpackPlugin.ts

@@ -21,7 +21,7 @@ import { tapAfterEnvironmentToPatchWatching } from './hooks/tapAfterEnvironmentT
 import { createPool, Pool } from './utils/async/pool';
 import os from 'os';
 
-class ForkTsCheckerWebpackPlugin implements webpack.Plugin {
+class ForkTsCheckerWebpackPlugin {
   /**
    * Current version of the plugin
    */

src/ForkTsCheckerWebpackPluginState.ts

@@ -1,4 +1,4 @@
-import { Tap } from 'tapable';
+import { FullTap } from 'tapable';
 import { FilesMatch, Report } from './reporter';
 import { Issue } from './issue';
 
@@ -9,7 +9,7 @@ interface ForkTsCheckerWebpackPluginState {
   lastDependencies: FilesMatch | undefined;
   watching: boolean;
   initialized: boolean;
-  webpackDevServerDoneTap: Tap | undefined;
+  webpackDevServerDoneTap: FullTap | undefined;
 }
 
 function createForkTsCheckerWebpackPluginState(): ForkTsCheckerWebpackPluginState {

src/hooks/pluginHooks.ts

@@ -10,14 +10,14 @@ const compilerHookMap = new WeakMap<
 
 function createForkTsCheckerWebpackPluginHooks() {
   return {
-    start: new AsyncSeriesWaterfallHook<FilesChange, webpack.compilation.Compilation>([
+    start: new AsyncSeriesWaterfallHook<[FilesChange, webpack.Compilation]>([
       'change',
       'compilation',
     ]),
-    waiting: new SyncHook<webpack.compilation.Compilation>(['compilation']),
-    canceled: new SyncHook<webpack.compilation.Compilation>(['compilation']),
-    error: new SyncHook<Error, webpack.compilation.Compilation>(['error', 'compilation']),
-    issues: new SyncWaterfallHook<Issue[], webpack.compilation.Compilation | undefined, void>([
+    waiting: new SyncHook<[webpack.Compilation]>(['compilation']),
+    canceled: new SyncHook<[webpack.Compilation]>(['compilation']),
+    error: new SyncHook<[Error, webpack.Compilation]>(['error', 'compilation']),
+    issues: new SyncWaterfallHook<[Issue[], webpack.Compilation | undefined], void>([
       'issues',
       'compilation',
     ]),

src/hooks/tapAfterEnvironmentToPatchWatching.ts

@@ -1,18 +1,19 @@
 import webpack from 'webpack';
 import { ForkTsCheckerWebpackPluginState } from '../ForkTsCheckerWebpackPluginState';
 import { InclusiveNodeWatchFileSystem } from '../watch/InclusiveNodeWatchFileSystem';
-import { CompilerWithWatchFileSystem } from '../watch/CompilerWithWatchFileSystem';
+import { WatchFileSystem } from '../watch/WatchFileSystem';
 
 function tapAfterEnvironmentToPatchWatching(
   compiler: webpack.Compiler,
   state: ForkTsCheckerWebpackPluginState
 ) {
   compiler.hooks.afterEnvironment.tap('ForkTsCheckerWebpackPlugin', () => {
-    const watchFileSystem = (compiler as CompilerWithWatchFileSystem).watchFileSystem;
+    const watchFileSystem = compiler.watchFileSystem;
     if (watchFileSystem) {
       // wrap original watch file system
-      (compiler as CompilerWithWatchFileSystem).watchFileSystem = new InclusiveNodeWatchFileSystem(
-        watchFileSystem,
+      compiler.watchFileSystem = new InclusiveNodeWatchFileSystem(
+        // we use some internals here
+        watchFileSystem as WatchFileSystem,
         compiler,
         state
       );

src/hooks/tapDoneToAsyncGetIssues.ts

@@ -83,7 +83,7 @@ function tapDoneToAsyncGetIssues(
     }
 
     if (stats.startTime) {
-      configuration.logger.infrastructure.info(
+      configuration.logger.infrastructure.log(
         `Time: ${Math.round(Date.now() - stats.startTime).toString()} ms`
       );
     }

src/hooks/tapStartToConnectAndRunReporter.ts

@@ -52,15 +52,15 @@ function tapStartToConnectAndRunReporter(
     if (state.watching) {
       change = getFilesChange(compiler);
 
-      configuration.logger.infrastructure.info(
+      configuration.logger.infrastructure.log(
         [
           'Calling reporter service for incremental check.',
           `  Changed files: ${JSON.stringify(change.changedFiles)}`,
           `  Deleted files: ${JSON.stringify(change.deletedFiles)}`,
         ].join('\n')
       );
     } else {
-      configuration.logger.infrastructure.info('Calling reporter service for single check.');
+      configuration.logger.infrastructure.log('Calling reporter service for single check.');
     }
 
     let resolveDependencies: (dependencies: FilesMatch | undefined) => void;

src/issue/IssueWebpackError.ts

@@ -1,11 +1,12 @@
+import webpack from 'webpack';
 import { relative } from 'path';
 import { Issue } from './Issue';
 import { formatIssueLocation } from './IssueLocation';
 import forwardSlash from '../utils/path/forwardSlash';
 
-class IssueWebpackError extends Error {
+class IssueWebpackError extends webpack.WebpackError {
   readonly hideStack = true;
-  readonly file: string | undefined;
+  readonly file: string = '';
 
   constructor(message: string, readonly issue: Issue) {
     super(message);

src/logger/LoggerConfiguration.ts

@@ -14,7 +14,10 @@ function createLoggerConfiguration(
   options: LoggerOptions | undefined
 ): LoggerConfiguration {
   return {
-    infrastructure: createLogger((options && options.infrastructure) || 'silent', compiler),
+    infrastructure: createLogger(
+      (options && options.infrastructure) || 'webpack-infrastructure',
+      compiler
+    ),
     issues: createLogger((options && options.issues) || 'console', compiler),
     devServer: options?.devServer !== false,
   };