Big update!Announcing Socket for GitHub 1.0. Learn more →
Log in


Package Overview
File Explorer

Advanced tools


Runs typescript type checker and linter on separate process.


Version published
Weekly downloads
increased by0.73%

Weekly downloads




Fork TS Checker Webpack Plugin

Webpack plugin that runs TypeScript type checker on a separate process.

npm version build status downloads commitizen friendly code style: prettier semantic-release



This plugin requires Node.js >=12.13.0+, Webpack ^5.11.0, TypeScript ^3.6.0

  • If you depend on TypeScript 2.1 - 2.6.2, please use version 4 of the plugin.
  • If you depend on Webpack 4, TypeScript 2.7 - 3.5.3 or ESLint feature, please use version 6 of the plugin.
# with npm npm install --save-dev fork-ts-checker-webpack-plugin # with yarn yarn add --dev fork-ts-checker-webpack-plugin

The minimal webpack config (with ts-loader)

// webpack.config.js const ForkTsCheckerWebpackPlugin = require('fork-ts-checker-webpack-plugin'); module.exports = { context: __dirname, // to automatically find tsconfig.json entry: './src/index.ts', resolve: { extensions: [".ts", ".tsx", ".js"], }, module: { rules: [ { test: /\.tsx?$/, loader: 'ts-loader', // add transpileOnly option if you use ts-loader < 9.3.0 // options: { // transpileOnly: true // } } ] }, plugins: [new ForkTsCheckerWebpackPlugin()] };

Examples how to configure it with babel-loader, ts-loader and Visual Studio Code are in the examples directory.

Modules resolution

It's very important to be aware that this plugin uses TypeScript's, not webpack's modules resolution. It means that you have to setup tsconfig.json correctly.

It's because of the performance - with TypeScript's module resolution we don't have to wait for webpack to compile files.

To debug TypeScript's modules resolution, you can use tsc --traceResolution command.


This plugin uses cosmiconfig. This means that besides the plugin constructor, you can place your configuration in the:

  • "fork-ts-checker" field in the package.json
  • .fork-ts-checkerrc file in JSON or YAML format
  • fork-ts-checker.config.js file exporting a JS object

Options passed to the plugin constructor will overwrite options from the cosmiconfig (using deepmerge).

NameTypeDefault valueDescription
asyncbooleancompiler.options.mode === 'development'If true, reports issues after webpack's compilation is done. Thanks to that it doesn't block the compilation. Used only in the watch mode.
typescriptobject{}See TypeScript options.
issueobject{}See Issues options.
formatterstring or object or functioncodeframeAvailable formatters are basic, codeframe and a custom function. To configure codeframe formatter, pass object: { type: 'codeframe', options: { <coderame options> } }.
logger{ log: function, error: function } or webpack-infrastructureconsoleConsole-like object to print issues in async mode.
devServerbooleantrueIf set to false, errors will not be reported to Webpack Dev Server.

TypeScript options

Options for the TypeScript checker (typescript option object).

NameTypeDefault valueDescription
memoryLimitnumber2048Memory limit for the checker process in MB. If the process exits with the allocation failed error, try to increase this number.
configFilestring'tsconfig.json'Path to the tsconfig.json file (path relative to the compiler.options.context or absolute path)
configOverwriteobject{ compilerOptions: { skipLibCheck: true, sourceMap: false, inlineSourceMap: false, declarationMap: false } }This configuration will overwrite configuration from the tsconfig.json file. Supported fields are: extends, compilerOptions, include, exclude, files, and references.
contextstringdirname(configuration.configFile)The base path for finding files specified in the tsconfig.json. Same as the context option from the ts-loader. Useful if you want to keep your tsconfig.json in an external package. Keep in mind that not having a tsconfig.json in your project root can cause different behaviour between fork-ts-checker-webpack-plugin and tsc. When using editors like VS Code it is advised to add a tsconfig.json file to the root of the project and extend the config file referenced in option configFile.
buildbooleanfalseThe equivalent of the --build flag for the tsc command.
mode'readonly' or 'write-dts' or 'write-tsbuildinfo' or 'write-references'build === true ? 'write-tsbuildinfo' ? 'readonly'Use readonly if you don't want to write anything on the disk, write-dts to write only .d.ts files, write-tsbuildinfo to write only .tsbuildinfo files, write-references to write both .js and .d.ts files of project references (last 2 modes requires build: true).
diagnosticOptionsobject{ syntactic: false, semantic: true, declaration: false, global: false }Settings to select which diagnostics do we want to perform.
extensionsobject{}See TypeScript extensions options.
profilebooleanfalseMeasures and prints timings related to the TypeScript performance.
typescriptPathstringrequire.resolve('typescript')If supplied this is a custom path where TypeScript can be found.
TypeScript extensions options

Options for the TypeScript checker extensions (typescript.extensions option object).

NameTypeDefault valueDescription
vueobject or booleanfalseIf true, it enables Vue Single File Component support.
vue.enabledbooleanfalseSame as the vue option
vue.compilerstring'vue-template-compiler'The package name of the compiler that will be used to parse .vue files. You can use 'nativescript-vue-template-compiler' if you use nativescript-vue

Issues options

Options for the issues filtering (issue option object). I could write some plain text explanation of these options but I think code will explain it better:

interface Issue { severity: 'error' | 'warning'; code: string; file?: string; } type IssueMatch = Partial<Issue>; // file field supports glob matching type IssuePredicate = (issue: Issue) => boolean; type IssueFilter = IssueMatch | IssuePredicate | (IssueMatch | IssuePredicate)[];
NameTypeDefault valueDescription
includeIssueFilterundefinedIf object, defines issue properties that should be matched. If function, acts as a predicate where issue is an argument.
excludeIssueFilterundefinedSame as include but issues that match this predicate will be excluded.
Expand example

Include issues from the src directory, exclude issues from .spec.ts files:

module.exports = { // ...the webpack configuration plugins: [ new ForkTsCheckerWebpackPlugin({ issue: { include: [ { file: '**/src/**/*' } ], exclude: [ { file: '**/*.spec.ts' } ] } }) ] };


⚠️ There are additional constraints regarding Vue.js Single File Component support: ⚠️

  • It requires TypeScript >= 3.8.0 (it's a limitation of the transpileOnly mode from ts-loader)
  • It doesn't work with the build mode (project references)

To enable Vue.js support, follow these steps:

Expand Vue.js set up instruction
  1. Ensure you have all required packages installed:
# with npm npm install --save vue vue-class-component npm install --save-dev vue-loader ts-loader css-loader vue-template-compiler # with yarn yarn add vue vue-class-component yarn add --dev vue-loader ts-loader css-loader vue-template-compiler
  1. Add tsconfig.json configuration:
{ "compilerOptions": { "experimentalDecorators": true, "jsx": "preserve", "target": "ES5", "lib": ["ES6", "DOM"], "baseUrl": ".", "paths": { "@/*": ["src/*"], "~/*": ["src/*"] }, "sourceMap": true, "importsNotUsedAsValues": "preserve" }, "include": [ "src/**/*.ts", "src/**/*.vue" ], "exclude": [ "node_modules" ] }
  1. Add webpack.config.js configuration:
const path = require('path'); const VueLoaderPlugin = require('vue-loader/lib/plugin'); const ForkTsCheckerWebpackPlugin = require('fork-ts-checker-webpack-plugin'); module.exports = { entry: './src/index.ts', output: { filename: 'index.js', path: path.resolve(__dirname, 'dist'), }, module: { rules: [ { test: /\.vue$/, loader: 'vue-loader' }, { test: /\.ts$/, loader: 'ts-loader', exclude: /node_modules/, options: { appendTsSuffixTo: [/\.vue$/], // add transpileOnly option if you use ts-loader < 9.3.0 // transpileOnly: true } }, { test: /\.css$/, loader: 'css-loader' }, ], }, resolve: { extensions: ['.ts', '.js', '.vue', '.json'], alias: { '@': path.resolve(__dirname, './src'), '~': path.resolve(__dirname, './src'), } }, plugins: [ new VueLoaderPlugin(), new ForkTsCheckerWebpackPlugin({ typescript: { extensions: { vue: true } } }) ] };
  1. Add src/types/vue.d.ts file to shim .vue modules:
declare module "*.vue" { import Vue from "vue"; export default Vue; }
  1. If you are working in VSCode, you can get the Vetur extension to complete the developer workflow.

Plugin hooks

This plugin provides some custom webpack hooks:

Hook keyTypeParamsDescription
startAsyncSeriesWaterfallHookchange, compilationStarts issues checking for a compilation. It's an async waterfall hook, so you can modify the list of changed and removed files or delay the start of the service.
waitingSyncHookcompilationWaiting for the issues checking.
canceledSyncHookcompilationIssues checking for the compilation has been canceled.
errorSyncHookcompilationAn error occurred during issues checking.
issuesSyncWaterfallHookissues, compilationIssues have been received and will be reported. It's a waterfall hook, so you can modify the list of received issues.

To access plugin hooks and tap into the event, we need to use the getCompilerHooks static method. When we call this method with a webpack compiler instance, it returns the object with tapable hooks where you can pass in your callbacks.

// ./src/webpack/MyWebpackPlugin.js const ForkTsCheckerWebpackPlugin = require('fork-ts-checker-webpack-plugin'); class MyWebpackPlugin { apply(compiler) { const hooks = ForkTsCheckerWebpackPlugin.getCompilerHooks(compiler); // log some message on waiting hooks.waiting.tap('MyPlugin', () => { console.log('waiting for issues'); }); // don't show warnings hooks.issues.tap('MyPlugin', (issues) => issues.filter((issue) => issue.severity === 'error') ); } } module.exports = MyWebpackPlugin; // webpack.config.js const ForkTsCheckerWebpackPlugin = require('fork-ts-checker-webpack-plugin'); const MyWebpackPlugin = require('./src/webpack/MyWebpackPlugin'); module.exports = { /* ... */ plugins: [ new ForkTsCheckerWebpackPlugin(), new MyWebpackPlugin() ] };

Profiling types resolution

When using TypeScript 4.3.0 or newer you can profile long type checks by setting "generateTrace" compiler option. This is an instruction from microsoft/TypeScript#40063:

  1. Set "generateTrace": "{folderName}" in your tsconfig.json (under compilerOptions)
  2. Look in the resulting folder. If you used build mode, there will be a legend.json telling you what went where. Otherwise, there will be trace.json file and types.json files.
  3. Navigate to edge://tracing or chrome://tracing and load trace.json
  4. Expand Process 1 with the little triangle in the left sidebar
  5. Click on different blocks to see their payloads in the bottom pane
  6. Open types.json in an editor
  7. When you see a type ID in the tracing output, go-to-line {id} to find data about that type

Enabling incremental mode

You must both set "incremental": true in your tsconfig.json (under compilerOptions) and also specify mode: 'write-references' in ForkTsCheckerWebpackPlugin settings.


This plugin was created in Realytics in 2017. Thank you for supporting Open Source.


MIT License



What is fork-ts-checker-webpack-plugin?

Runs typescript type checker and linter on separate process.

Is fork-ts-checker-webpack-plugin popular?

The npm package fork-ts-checker-webpack-plugin receives a total of 13,913,593 weekly downloads. As such, fork-ts-checker-webpack-plugin popularity was classified as popular.

Is fork-ts-checker-webpack-plugin well maintained?

We found that fork-ts-checker-webpack-plugin demonstrated a healthy version release cadence and project activity. It has 1 open source maintainer collaborating on the project.

Last updated on 18 Jul 2022


Subscribe to our newsletter

Get open source security insights delivered straight into your inbox. Be the first to learn about new features and product updates.

  • Terms
  • Privacy
  • Security

Made with ⚡️ by Socket Inc