Merge branch 'main' of github.com:TypeStrong/fork-ts-checker-webpack-plugin into alpha

Author: piotr-oles

.github/workflows/codeql-analysis.yml

@@ -13,10 +13,10 @@ name: "CodeQL"
 
 on:
   push:
-    branches: [ master ]
+    branches: [ main ]
   pull_request:
     # The branches below must be a subset of the branches above
-    branches: [ master ]
+    branches: [ main ]
   schedule:
     - cron: '42 12 * * 1'
 

.github/workflows/main.yml

@@ -83,7 +83,7 @@ jobs:
       GH_TOKEN: ${{ secrets.GH_PERSONAL_TOKEN }}
       NPM_TOKEN: ${{ secrets.NPM_TOKEN }}
     needs: [build, test]
-    if: github.event_name == 'push' && (github.ref == 'refs/heads/master' || github.ref == 'refs/heads/alpha' || github.ref == 'refs/heads/beta')
+    if: github.event_name == 'push' && (github.ref == 'refs/heads/main' || github.ref == 'refs/heads/alpha' || github.ref == 'refs/heads/beta')
     steps:
       - uses: actions/checkout@v1
 

CONTRIBUTING.md

@@ -57,8 +57,8 @@ Here is a summary of the steps to follow:
 2. If you cloned a while ago, get the latest changes from upstream and update dependencies:
 
 ```bash
-$ git checkout master
-$ git pull upstream master
+$ git checkout main
+$ git pull upstream main
 $ yarn install
 ```
 
@@ -75,7 +75,7 @@ $ git checkout -b <topic-branch-name>
 $ git push origin <topic-branch-name>
 ```
 
-6. [Open a Pull Request](https://help.github.com/articles/creating-a-pull-request/#creating-the-pull-request) to the `master` branch with a clear title and description.
+6. [Open a Pull Request](https://help.github.com/articles/creating-a-pull-request/#creating-the-pull-request) to the `main` branch with a clear title and description.
 
 **Tips**:
 
@@ -217,5 +217,5 @@ otherwise use **rebase and merge**.
 
 ### Releasing a stable version
 
-Fixes and tested features from the `beta` branch can be merged with the `master` branch. Please ensure your branch is
-up to date with the `master` and then [open a Pull Request](https://github.com/TypeStrong/fork-ts-checker-webpack-plugin/compare/master...).
+Fixes and tested features from the `beta` branch can be merged with the `main` branch. Please ensure your branch is
+up to date with the `main` and then [open a Pull Request](https://github.com/TypeStrong/fork-ts-checker-webpack-plugin/compare/main...).

README.md

@@ -4,7 +4,7 @@
 <p>Webpack plugin that runs TypeScript type checker on a separate process.</p>
 
 [![npm version](https://img.shields.io/npm/v/fork-ts-checker-webpack-plugin.svg)](https://www.npmjs.com/package/fork-ts-checker-webpack-plugin)
-[![build status](https://github.com/TypeStrong/fork-ts-checker-webpack-plugin/workflows/CI/CD/badge.svg?branch=master&event=push)](https://github.com/TypeStrong/fork-ts-checker-webpack-plugin/actions?query=branch%3Amaster+event%3Apush)
+[![build status](https://github.com/TypeStrong/fork-ts-checker-webpack-plugin/workflows/CI/CD/badge.svg?branch=main&event=push)](https://github.com/TypeStrong/fork-ts-checker-webpack-plugin/actions?query=branch%3Amain+event%3Apush)
 [![downloads](http://img.shields.io/npm/dm/fork-ts-checker-webpack-plugin.svg)](https://npmjs.org/package/fork-ts-checker-webpack-plugin)
 [![commitizen friendly](https://img.shields.io/badge/commitizen-friendly-brightgreen.svg)](http://commitizen.github.io/cz-cli/)
 [![code style: prettier](https://img.shields.io/badge/code_style-prettier-ff69b4.svg)](https://github.com/prettier/prettier)
@@ -70,7 +70,6 @@ module.exports = {
 
 It's very important to be aware that **this plugin uses [TypeScript](https://github.com/Microsoft/TypeScript)'s, not
 [webpack](https://github.com/webpack/webpack)'s modules resolution**. It means that you have to setup `tsconfig.json` correctly. 
-For example if you set `files: ['./src/index.ts']` in `tsconfig.json`, this plugin will check only `index.ts` for errors. 
 
 > It's because of the performance - with TypeScript's module resolution we don't have to wait for webpack to compile files.
 >
@@ -137,13 +136,13 @@ you can place your configuration in the:
 
 Options passed to the plugin constructor will overwrite options from the cosmiconfig (using [deepmerge](https://github.com/TehShrike/deepmerge)).
 
-| Name              | Type                  | Default value                                                      | Description |
-| ----------------- | --------------------- | ------------------------------------------------------------------ | ----------- |
-| `async`           | `boolean`             | `compiler.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. | 
-| `typescript`      | `object` or `boolean` | `true`                                                             | If a `boolean`, it enables/disables TypeScript checker. If an `object`, see [TypeScript options](#typescript-options). |
-| `eslint`          | `object`              | `undefined`                                                        | If `undefined`, it disables ESLint linter. If an `object`, see [ESLint options](#eslint-options). |
-| `issue`           | `object`              | `{}`                                                               | See [Issues options](#issues-options). |
-| `formatter`       | `string` or `object`  | `codeframe`                                                        | Available formatters are `basic` and `codeframe`. To [configure](https://babeljs.io/docs/en/babel-code-frame#options) `codeframe` formatter, pass object: `{ type: 'codeframe', options: { <coderame options> } }`. |
+| Name              | Type                               | Default value                                                      | Description |
+| ----------------- | ---------------------------------- | ------------------------------------------------------------------ | ----------- |
+| `async`           | `boolean`                          | `compiler.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. |
+| `typescript`      | `object` or `boolean`              | `true`                                                             | If a `boolean`, it enables/disables TypeScript checker. If an `object`, see [TypeScript options](#typescript-options). |
+| `eslint`          | `object`                           | `undefined`                                                        | If `undefined`, it disables ESLint linter. If an `object`, see [ESLint options](#eslint-options). |
+| `issue`           | `object`                           | `{}`                                                               | See [Issues options](#issues-options). |
+| `formatter`       | `string` or `object` or `function` | `codeframe`                                                        | Available formatters are `basic`, `codeframe` and a custom `function`. To [configure](https://babeljs.io/docs/en/babel-code-frame#options) `codeframe` formatter, pass object: `{ type: 'codeframe', options: { <coderame options> } }`. |
 | `logger`          | `object`              | `{ infrastructure: 'silent', issues: 'console', devServer: true }` | Available loggers are `silent`, `console`, and `webpack-infrastructure`. Infrastructure logger prints additional information, issue logger prints `issues` in the `async` mode. If `devServer` is set to `false`, errors will not be reported to Webpack Dev Server. |
 
 ### TypeScript options

package.json

@@ -67,6 +67,7 @@
     "cosmiconfig": "^6.0.0",
     "deepmerge": "^4.2.2",
     "fs-extra": "^9.0.0",
+    "glob": "^7.1.6",
     "memfs": "^3.1.2",
     "minimatch": "^3.0.4",
     "schema-utils": "2.7.0",

release.config.js

@@ -1,6 +1,6 @@
 module.exports = {
   branches: [
-    'master',
+    'main',
     {
       name: 'alpha',
       prerelease: true,

src/eslint-reporter/reporter/EsLintReporter.ts

@@ -3,54 +3,108 @@ import { CLIEngine, LintReport, LintResult } from '../types/eslint';
 import { createIssuesFromEsLintResults } from '../issue/EsLintIssueFactory';
 import { EsLintReporterConfiguration } from '../EsLintReporterConfiguration';
 import { Reporter } from '../../reporter';
+import { normalize } from 'path';
 import minimatch from 'minimatch';
+import glob from 'glob';
 
 function createEsLintReporter(configuration: EsLintReporterConfiguration): Reporter {
   // eslint-disable-next-line @typescript-eslint/no-var-requires
   const { CLIEngine } = require('eslint');
   const engine: CLIEngine = new CLIEngine(configuration.options);
 
   let isInitialRun = true;
+  let isInitialGetFiles = true;
+
   const lintResults = new Map<string, LintResult>();
-  const includedFilesPatterns = engine.resolveFileGlobPatterns(configuration.files);
+  const includedGlobPatterns = engine.resolveFileGlobPatterns(configuration.files);
+  const includedFiles = new Set<string>();
+
+  function isFileIncluded(path: string) {
+    return (
+      includedGlobPatterns.some((pattern) => minimatch(path, pattern)) &&
+      !engine.isPathIgnored(path)
+    );
+  }
+
+  async function getFiles() {
+    if (isInitialGetFiles) {
+      isInitialGetFiles = false;
+
+      const resolvedGlobs = await Promise.all(
+        includedGlobPatterns.map(
+          (globPattern) =>
+            new Promise<string[]>((resolve) => {
+              glob(globPattern, (error, resolvedFiles) => {
+                if (error) {
+                  // fail silently
+                  resolve([]);
+                } else {
+                  resolve(resolvedFiles || []);
+                }
+              });
+            })
+        )
+      );
+
+      for (const resolvedGlob of resolvedGlobs) {
+        for (const resolvedFile of resolvedGlob) {
+          if (isFileIncluded(resolvedFile)) {
+            includedFiles.add(resolvedFile);
+          }
+        }
+      }
+    }
+
+    return Array.from(includedFiles);
+  }
+
+  function getDirs() {
+    return includedGlobPatterns || [];
+  }
+
+  function getExtensions() {
+    return configuration.options.extensions || [];
+  }
 
   return {
     getReport: async ({ changedFiles = [], deletedFiles = [] }) => {
       return {
         async getDependencies() {
+          for (const changedFile of changedFiles) {
+            if (isFileIncluded(changedFile)) {
+              includedFiles.add(changedFile);
+            }
+          }
+          for (const deletedFile of deletedFiles) {
+            includedFiles.delete(deletedFile);
+          }
+
           return {
-            files: [],
-            dirs: [],
-            extensions: [],
+            files: (await getFiles()).map((file) => normalize(file)),
+            dirs: getDirs().map((dir) => normalize(dir)),
+            extensions: getExtensions(),
           };
         },
         async getIssues() {
           // cleanup old results
-          changedFiles.forEach((changedFile) => {
+          for (const changedFile of changedFiles) {
             lintResults.delete(changedFile);
-          });
-          deletedFiles.forEach((removedFile) => {
-            lintResults.delete(removedFile);
-          });
+          }
+          for (const deletedFile of deletedFiles) {
+            lintResults.delete(deletedFile);
+          }
 
           // get reports
           const lintReports: LintReport[] = [];
 
           if (isInitialRun) {
-            lintReports.push(engine.executeOnFiles(includedFilesPatterns));
+            lintReports.push(engine.executeOnFiles(includedGlobPatterns));
             isInitialRun = false;
           } else {
             // we need to take care to not lint files that are not included by the configuration.
             // the eslint engine will not exclude them automatically
-            const changedAndIncludedFiles = changedFiles.filter(
-              (changedFile) =>
-                includedFilesPatterns.some((includedFilesPattern) =>
-                  minimatch(changedFile, includedFilesPattern)
-                ) &&
-                (configuration.options.extensions || []).some((extension) =>
-                  changedFile.endsWith(extension)
-                ) &&
-                !engine.isPathIgnored(changedFile)
+            const changedAndIncludedFiles = changedFiles.filter((changedFile) =>
+              isFileIncluded(changedFile)
             );
 
             if (changedAndIncludedFiles.length) {
@@ -64,11 +118,11 @@ function createEsLintReporter(configuration: EsLintReporterConfiguration): Repor
           }
 
           // store results
-          lintReports.forEach((lintReport) => {
-            lintReport.results.forEach((lintResult) => {
+          for (const lintReport of lintReports) {
+            for (const lintResult of lintReport.results) {
               lintResults.set(lintResult.filePath, lintResult);
-            });
-          });
+            }
+          }
 
           // get actual list of previous and current reports
           const results = Array.from(lintResults.values());

src/formatter/FormatterConfiguration.ts

@@ -6,7 +6,7 @@ type FormatterConfiguration = Formatter;
 
 function createFormatterConfiguration(options: FormatterOptions | undefined) {
   return createFormatter(
-    options ? (typeof options === 'string' ? options : options.type || 'codeframe') : 'codeframe',
+    options ? (typeof options === 'object' ? options.type || 'codeframe' : options) : 'codeframe',
     options && typeof options === 'object' ? options.options || {} : {}
   );
 }

src/formatter/FormatterFactory.ts

@@ -2,7 +2,7 @@ import { Formatter } from './Formatter';
 import { BabelCodeFrameOptions, createCodeFrameFormatter } from './CodeFrameFormatter';
 import { createBasicFormatter } from './BasicFormatter';
 
-type NotConfigurableFormatterType = undefined | 'basic';
+type NotConfigurableFormatterType = undefined | 'basic' | Formatter;
 type ConfigurableFormatterType = 'codeframe';
 type FormatterType = NotConfigurableFormatterType | ConfigurableFormatterType;
 
@@ -25,17 +25,21 @@ function createFormatter<T extends ConfigurableFormatterType>(
 function createFormatter<T extends FormatterType>(type: T, options?: object): Formatter;
 // declare function implementation
 function createFormatter(type?: FormatterType, options?: object): Formatter {
-  switch (type) {
-    case 'basic':
-    case undefined:
-      return createBasicFormatter();
+  if (typeof type === 'function') {
+    return type;
+  }
 
-    case 'codeframe':
-      return createCodeFrameFormatter(options);
+  if (typeof type === 'undefined' || type === 'basic') {
+    return createBasicFormatter();
+  }
 
-    default:
-      throw new Error(`Unknown "${type}" formatter. Available types are: basic, codeframe.`);
+  if (type === 'codeframe') {
+    return createCodeFrameFormatter(options);
   }
+
+  throw new Error(
+    `Unknown "${type}" formatter. Available types are: "basic", "codeframe" or a custom function.`
+  );
 }
 
 export {

src/formatter/types/babel__code-frame.ts

@@ -1,5 +1,5 @@
 // Base on the type definitions for @babel/code-frame 7.0
-// Project: https://github.com/babel/babel/tree/master/packages/babel-code-frame, https://babeljs.io
+// Project: https://github.com/babel/babel/tree/main/packages/babel-code-frame, https://babeljs.io
 // Definitions by: Mohsen Azimi <https://github.com/mohsen1>
 //                 Forbes Lindesay <https://github.com/ForbesLindesay>
 // Definitions: https://github.com/DefinitelyTyped/DefinitelyTyped