feat: rename tsconfig option to configFile for consistency (#436)

As ts-loader and tsconfig-paths-webpack-plugin uses `configFile` option, the plugin should use the same for consistency. BREAKING CHANGE: 🧨 `typescript.tsconfig` option renamed to the `tsconfig.configFile`
TypeStrong · Jun 3, 2020 · aa8f74d · aa8f74d
1 parent 944e0c9
commit aa8f74d
Show file tree

Hide file tree

Showing 10 changed files with 31 additions and 31 deletions.
diff --git a/README.md b/README.md
@@ -157,9 +157,9 @@ Options for the TypeScript checker (`typescript` option object).
 | -------------------- | --------- | -------------------------------------------------------------------------------------- | ----------- |
 | `enabled`            | `boolean` | `true`                                                                                 | If `true`, it enables TypeScript checker. |
 | `memoryLimit`        | `number`  | `2048`                                                                                 | Memory limit for the checker process in MB. If the process exits with the allocation failed error, try to increase this number. |
-| `tsconfig`           | `string`  | `'tsconfig.json'`                                                                      | Path to the `tsconfig.json` file (path relative to the `compiler.options.context` or absolute path) |
-| `context`            | `string`  | `dirname(configuration.tsconfig)`                                                      | The base path for finding files specified in the `tsconfig.json`. Same as the `context` option from the [ts-loader](https://github.com/TypeStrong/ts-loader#context). 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 `tsconfig`.  |
-| `build`              | `boolean` | `false`                                                                                | The equivalent of the `--build` flag for the `tsc` command. To enable `incremental` mode, set it in the `tsconfig.json` file. |
+| `configFile`         | `string`  | `'tsconfig.json'`                                                                      | Path to the `tsconfig.json` file (path relative to the `compiler.options.context` or absolute path) |
+| `context`            | `string`  | `dirname(configuration.configFile)`                                                    | The base path for finding files specified in the `tsconfig.json`. Same as the `context` option from the [ts-loader](https://github.com/TypeStrong/ts-loader#context). 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`.  |
+| `build`              | `boolean` | `false`                                                                                | The equivalent of the `--build` flag for the `tsc` command. |
 | `mode`               | `'readonly'` or `'write-tsbuildinfo'` or `'write-references'` | `'write-tsbuildinfo'`              | If you use the `babel-loader`, it's recommended to use `write-references` mode to improve initial compilation time. If you use `ts-loader`, it's recommended to use `write-tsbuildinfo` mode to not overwrite filed emitted by the `ts-loader`. |
 | `compilerOptions`    | `object`  | `{ skipLibCheck: true, sourceMap: false, inlineSourceMap: false, incremental: true  }` | These options will overwrite compiler options from the `tsconfig.json` file. |
 | `diagnosticsOptions` | `object`  | `{ syntactic: false, semantic: true, declaration: false, global: false }`              | Settings to select which diagnostics do we want to perform. |

diff --git a/src/ForkTsCheckerWebpackPluginOptions.json b/src/ForkTsCheckerWebpackPluginOptions.json
@@ -113,7 +113,7 @@
               "type": "number",
               "description": "Memory limit for TypeScript reporter process."
             },
-            "tsconfig": {
+            "configFile": {
               "type": "string",
               "description": "Path to tsconfig.json. By default plugin uses context or process.cwd() to localize tsconfig.json file."
             },

diff --git a/src/hooks/tapAfterCompileToAddDependencies.ts b/src/hooks/tapAfterCompileToAddDependencies.ts
@@ -9,7 +9,7 @@ function tapAfterCompileToAddDependencies(
   compiler.hooks.afterCompile.tap('ForkTsCheckerWebpackPlugin', (compilation) => {
     if (configuration.typescript.enabled) {
       // watch tsconfig.json file
-      compilation.fileDependencies.add(path.normalize(configuration.typescript.tsconfig));
+      compilation.fileDependencies.add(path.normalize(configuration.typescript.configFile));
     }
   });
 }

diff --git a/src/typescript-reporter/TypeScriptReporterConfiguration.ts b/src/typescript-reporter/TypeScriptReporterConfiguration.ts
@@ -12,7 +12,7 @@ import {
 interface TypeScriptReporterConfiguration {
   enabled: boolean;
   memoryLimit: number;
-  tsconfig: string;
+  configFile: string;
   build: boolean;
   context: string;
   mode: 'readonly' | 'write-tsbuildinfo' | 'write-references';
@@ -29,14 +29,14 @@ function createTypeScriptReporterConfiguration(
   compiler: webpack.Compiler,
   options: TypeScriptReporterOptions | undefined
 ): TypeScriptReporterConfiguration {
-  let tsconfig =
-    typeof options === 'object' ? options.tsconfig || 'tsconfig.json' : 'tsconfig.json';
+  let configFile =
+    typeof options === 'object' ? options.configFile || 'tsconfig.json' : 'tsconfig.json';
 
-  // ensure that `tsconfig` is an absolute normalized path
-  tsconfig = path.normalize(
-    path.isAbsolute(tsconfig)
-      ? tsconfig
-      : path.resolve(compiler.options.context || process.cwd(), tsconfig)
+  // ensure that `configFile` is an absolute normalized path
+  configFile = path.normalize(
+    path.isAbsolute(configFile)
+      ? configFile
+      : path.resolve(compiler.options.context || process.cwd(), configFile)
   );
 
   const optionsAsObject: Exclude<TypeScriptReporterOptions, boolean> =
@@ -61,8 +61,8 @@ function createTypeScriptReporterConfiguration(
     mode: 'write-tsbuildinfo',
     profile: false,
     ...optionsAsObject,
-    tsconfig: tsconfig,
-    context: optionsAsObject.context || path.dirname(tsconfig),
+    configFile: configFile,
+    context: optionsAsObject.context || path.dirname(configFile),
     compilerOptions: {
       ...defaultCompilerOptions,
       ...(optionsAsObject.compilerOptions || {}),

diff --git a/src/typescript-reporter/TypeScriptReporterOptions.ts b/src/typescript-reporter/TypeScriptReporterOptions.ts
@@ -6,7 +6,7 @@ type TypeScriptReporterOptions =
   | {
       enabled?: boolean;
       memoryLimit?: number;
-      tsconfig?: string;
+      configFile?: string;
       context?: string;
       build?: boolean;
       mode?: 'readonly' | 'write-tsbuildinfo' | 'write-references';

diff --git a/src/typescript-reporter/TypeScriptSupport.ts b/src/typescript-reporter/TypeScriptSupport.ts
@@ -36,14 +36,14 @@ function assertTypeScriptSupport(configuration: TypeScriptReporterConfiguration)
     );
   }
 
-  if (!fs.existsSync(configuration.tsconfig)) {
+  if (!fs.existsSync(configuration.configFile)) {
     throw new Error(
       [
-        `Cannot find the "${configuration.tsconfig}" file.`,
+        `Cannot find the "${configuration.configFile}" file.`,
         `Please check webpack and ForkTsCheckerWebpackPlugin configuration.`,
         `Possible errors:`,
-        '  - wrong `context` directory in webpack configuration (if `tsconfig` is not set or is a relative path in the fork plugin configuration)',
-        '  - wrong `typescript.tsconfig` path in the plugin configuration (should be a relative or absolute path)',
+        '  - wrong `context` directory in webpack configuration (if `configFile` is not set or is a relative path in the fork plugin configuration)',
+        '  - wrong `typescript.configFile` path in the plugin configuration (should be a relative or absolute path)',
       ].join(os.EOL)
     );
   }

diff --git a/src/typescript-reporter/reporter/TypeScriptReporter.ts b/src/typescript-reporter/reporter/TypeScriptReporter.ts
@@ -99,7 +99,7 @@ function createTypeScriptReporter(configuration: TypeScriptReporterConfiguration
       if (
         [...changedFiles, ...deletedFiles]
           .map((affectedFile) => path.normalize(affectedFile))
-          .includes(path.normalize(configuration.tsconfig))
+          .includes(path.normalize(configuration.configFile))
       ) {
         // we need to re-create programs
         parsedConfiguration = undefined;
@@ -117,7 +117,7 @@ function createTypeScriptReporter(configuration: TypeScriptReporterConfiguration
 
         performance.markStart('Parse Configuration');
         parsedConfiguration = parseTypeScriptConfiguration(
-          configuration.tsconfig,
+          configuration.configFile,
           configuration.context,
           configuration.compilerOptions,
           {
@@ -140,7 +140,7 @@ function createTypeScriptReporter(configuration: TypeScriptReporterConfiguration
 
           issues.forEach((issue) => {
             if (!issue.file) {
-              issue.file = configuration.tsconfig;
+              issue.file = configuration.configFile;
             }
           });
 
@@ -210,7 +210,7 @@ function createTypeScriptReporter(configuration: TypeScriptReporterConfiguration
           performance.markStart('Create Solution Builder');
           solutionBuilder = ts.createSolutionBuilderWithWatch(
             watchSolutionBuilderHost,
-            [configuration.tsconfig],
+            [configuration.configFile],
             {}
           );
           performance.markEnd('Create Solution Builder');

diff --git a/test/e2e/TypeScriptContextOption.spec.ts b/test/e2e/TypeScriptContextOption.spec.ts
@@ -70,7 +70,7 @@ describe('TypeScript Context Option', () => {
       [
         '      typescript: {',
         '        enabled: true,',
-        '        tsconfig: "build/tsconfig.json",',
+        '        configFile: "build/tsconfig.json",',
         '        context: __dirname,',
         '      },',
         '      logger: {',

diff --git a/test/unit/typescript-reporter/TypeScriptReporterConfiguration.spec.ts b/test/unit/typescript-reporter/TypeScriptReporterConfiguration.spec.ts
@@ -11,7 +11,7 @@ describe('typescript-reporter/TypeScriptsReporterConfiguration', () => {
   const configuration: TypeScriptReporterConfiguration = {
     enabled: true,
     memoryLimit: 2048,
-    tsconfig: path.normalize(path.resolve(context, 'tsconfig.json')),
+    configFile: path.normalize(path.resolve(context, 'tsconfig.json')),
     context: path.normalize(path.dirname(path.resolve(context, 'tsconfig.json'))),
     build: false,
     mode: 'write-tsbuildinfo',
@@ -63,10 +63,10 @@ describe('typescript-reporter/TypeScriptsReporterConfiguration', () => {
     [{ enabled: false }, { ...configuration, enabled: false }],
     [{ memoryLimit: 512 }, { ...configuration, memoryLimit: 512 }],
     [
-      { tsconfig: 'tsconfig.another.json' },
+      { configFile: 'tsconfig.another.json' },
       {
         ...configuration,
-        tsconfig: path.normalize(path.resolve(context, 'tsconfig.another.json')),
+        configFile: path.normalize(path.resolve(context, 'tsconfig.another.json')),
       },
     ],
     [{ build: true }, { ...configuration, build: true }],

diff --git a/test/unit/typescript-reporter/TypeScriptSupport.spec.ts b/test/unit/typescript-reporter/TypeScriptSupport.spec.ts
@@ -8,7 +8,7 @@ describe('typescript-reporter/TypeScriptSupport', () => {
     jest.resetModules();
 
     configuration = {
-      tsconfig: './tsconfig.json',
+      configFile: './tsconfig.json',
       context: '.',
       compilerOptions: {},
       build: false,
@@ -97,8 +97,8 @@ describe('typescript-reporter/TypeScriptSupport', () => {
         `Cannot find the "./tsconfig.json" file.`,
         `Please check webpack and ForkTsCheckerWebpackPlugin configuration.`,
         `Possible errors:`,
-        '  - wrong `context` directory in webpack configuration (if `tsconfig` is not set or is a relative path in the fork plugin configuration)',
-        '  - wrong `typescript.tsconfig` path in the plugin configuration (should be a relative or absolute path)',
+        '  - wrong `context` directory in webpack configuration (if `configFile` is not set or is a relative path in the fork plugin configuration)',
+        '  - wrong `typescript.configFile` path in the plugin configuration (should be a relative or absolute path)',
       ].join(os.EOL)
     );
   });