chore: update plugin (#230)

* chore: update plugin

* test: fix output report

* test: fix

* test: fix

* test: fix

* test: fix

* test: fix

* test: skip watch test for now

* ci: update node version

* ci: update node version

* fix: threads

* ci: disable temporarly windows

* style: formatting

* style: formatting

* ci: debug on windows

* fix: always normalize path

* style: formatting

* test: normalize path

* ci: enable ubuntu-latest and macos-latest

* test: watch

* style: use `fs-extra`

* style: formatting

* test: fix watch test

* test: fix

* test: debug watch

* test: fix

* fix: get files on watch mode

* fix: get files

* fix: get files using `fast-glob`

* fix: export

* test: increase coverage

* test: fix context path

* fix: changed files

* test: skip watch

* test: increase coverage

Author: ricardogobbosouza

.eslintrc.js

@@ -1,4 +1,8 @@
 module.exports = {
   root: true,
   extends: ['@webpack-contrib/eslint-config-webpack', 'prettier'],
+  rules: {
+    'global-require': 'off',
+    'import/no-dynamic-require': 'off',
+  },
 };

.github/workflows/nodejs.yml

@@ -30,7 +30,7 @@ jobs:
           fetch-depth: 0
 
       - name: Use Node.js ${{ env.node-version }}
-        uses: actions/setup-node@v1
+        uses: actions/setup-node@v2
         with:
           node-version: ${{ env.node-version }}
 
@@ -43,8 +43,8 @@ jobs:
       - name: Lint
         run: npm run lint
 
-      #- name: Security audit
-      #  run: npm run security
+      - name: Security audit
+        run: npm run security
 
       - name: Check commit message
         uses: wagoid/commitlint-github-action@v1
@@ -68,7 +68,7 @@ jobs:
       - uses: actions/checkout@v2
 
       - name: Use Node.js ${{ matrix.node-version }}
-        uses: actions/setup-node@v1
+        uses: actions/setup-node@v2
         with:
           node-version: ${{ matrix.node-version }}
 

.husky/.gitignore

@@ -0,0 +1 @@
+_

README.md

@@ -61,12 +61,26 @@ Specify the config file location to be used by `stylelint`.
 
 A string indicating the root of your files.
 
+### `exclude`
+
+- Type: `String|Array[String]`
+- Default: `'node_modules'`
+
+Specify the files and/or directories to exclude. Must be relative to `options.context`.
+
+### `extensions`
+
+- Type: `String|Array[String]`
+- Default: `['css', 'scss', 'sass']`
+
+Specify extensions that should be checked.
+
 ### `files`
 
 - Type: `String|Array[String]`
-- Default: `'**/*.(s(c|a)ss|css)'`
+- Default: `null`
 
-Specify the glob pattern for finding files. Must be relative to `options.context`.
+Specify directories, files, or globs. Must be relative to `options.context`. Directories are traveresed recursively looking for files matching `options.extensions`. File and glob patterns ignore `options.extensions`.
 
 ### `fix`
 
@@ -96,6 +110,13 @@ Lint only changed files, skip lint on start.
 
 Path to `stylelint` instance that will be used for linting.
 
+### `threads`
+
+- Type: `Boolean | Number`
+- Default: `false`
+
+Set to true for an auto-selected pool size based on number of cpus. Set to a number greater than 1 to set an explicit pool size. Set to false, 1, or less to disable and only run in main process.
+
 ### Errors and Warning
 
 **By default the plugin will auto adjust error reporting depending on stylelint errors/warnings counts.**
@@ -106,21 +127,21 @@ You can still force this behavior by using `emitError` **or** `emitWarning` opti
 - Type: `Boolean`
 - Default: `false`
 
-Will always return errors, if set to `true`.
+The errors found will always be emitted, to disable set to `false`.
 
 #### `emitWarning`
 
 - Type: `Boolean`
 - Default: `false`
 
-Will always return warnings, if set to `true`.
+The warnings found will always be emitted, to disable set to `false`.
 
 #### `failOnError`
 
 - Type: `Boolean`
 - Default: `false`
 
-Will cause the module build to fail if there are any errors, if set to `true`.
+Will cause the module build to fail if there are any errors, to disable set to `false`.
 
 #### `failOnWarning`
 
@@ -136,6 +157,22 @@ Will cause the module build to fail if there are any warnings, if set to `true`.
 
 Will process and report errors only and ignore warnings, if set to `true`.
 
+#### `outputReport`
+
+- Type: `Boolean|Object`
+- Default: `false`
+
+Write the output of the errors to a file, for example a `json` file for use for reporting.
+The `filePath` is relative to the webpack config: `output.path`.
+You can pass in a different formatter for the output file, if none is passed in the default/configured formatter will be used.
+
+```js
+{
+  filePath: 'path/to/file';
+  formatter: 'json';
+}
+```
+
 ## Changelog
 
 [Changelog](CHANGELOG.md)

declarations/LintDirtyModulesPlugin.d.ts

@@ -1,30 +1,2 @@
-/** @typedef {import('stylelint').LintResult} LintResult */
-/** @typedef {import('./getOptions').Options} Options */
-export default class StylelintError extends Error {
-  /**
-   * @param {Options} options
-   * @param {Array<LintResult>} messages
-   * @returns {StylelintError}
-   */
-  static format(
-    { formatter }: Options,
-    messages: Array<LintResult>
-  ): StylelintError;
-  /**
-   * @param {Partial<string>} messages
-   */
-  constructor(messages: Partial<string>);
-}
-export type LintResult = import('stylelint').LintResult;
-export type Options = {
-  context?: string | undefined;
-  emitError?: boolean | undefined;
-  emitWarning?: boolean | undefined;
-  failOnError?: boolean | undefined;
-  failOnWarning?: boolean | undefined;
-  files: string | string[];
-  formatter: TimerHandler;
-  lintDirtyModulesOnly?: boolean | undefined;
-  quiet?: boolean | undefined;
-  stylelintPath: string;
-};
+export default StylelintError;
+declare class StylelintError extends Error {}

declarations/StylelintError.d.ts

@@ -1,2 +1,3 @@
-declare const _exports: typeof import('.').default;
+declare const _exports: typeof plugin.default;
 export = _exports;
+import plugin = require('./index');

declarations/cjs.d.ts

@@ -0,0 +1,47 @@
+/** @typedef {import('stylelint')} Stylelint */
+/** @typedef {import('stylelint').LintResult} LintResult */
+/** @typedef {import('./options').Options} Options */
+/** @typedef {() => Promise<void>} AsyncTask */
+/** @typedef {(files: string|string[]) => Promise<LintResult[]>} LintTask */
+/** @typedef {JestWorker & {lintFiles: LintTask}} Worker */
+/** @typedef {{stylelint: Stylelint, lintFiles: LintTask, cleanup: AsyncTask, threads: number, }} Linter */
+/**
+ * @param {Options} options
+ * @returns {Linter}
+ */
+export function loadStylelint(options: Options): Linter;
+/**
+ * @param {string|undefined} key
+ * @param {number} poolSize
+ * @param {Options} options
+ * @returns {Linter}
+ */
+export function loadStylelintThreaded(
+  key: string | undefined,
+  poolSize: number,
+  options: Options
+): Linter;
+/**
+ * @param {string|undefined} key
+ * @param {Options} options
+ * @returns {Linter}
+ */
+export default function getStylelint(
+  key: string | undefined,
+  { threads, ...options }: Options
+): Linter;
+export type Stylelint = typeof import('stylelint');
+export type LintResult = import('stylelint').LintResult;
+export type Options = import('./options').Options;
+export type AsyncTask = () => Promise<void>;
+export type LintTask = (files: string | string[]) => Promise<LintResult[]>;
+export type Worker = JestWorker & {
+  lintFiles: LintTask;
+};
+export type Linter = {
+  stylelint: Stylelint;
+  lintFiles: LintTask;
+  cleanup: AsyncTask;
+  threads: number;
+};
+import JestWorker from 'jest-worker';

declarations/getOptions.d.ts

@@ -1,9 +1,26 @@
 export default StylelintWebpackPlugin;
 export type Compiler = import('webpack').Compiler;
-/** @typedef {import('webpack').Compiler} Compiler */
+export type Module = import('webpack').Module;
+export type Options = import('./options').Options;
+export type FileSystemInfoEntry = Partial<
+  | {
+      timestamp: number;
+    }
+  | number
+>;
 declare class StylelintWebpackPlugin {
-  constructor(options?: {});
-  options: import('./getOptions').Options;
+  /**
+   * @param {Options} options
+   */
+  constructor(options?: Options);
+  key: string;
+  options: Partial<import('./options').PluginOptions>;
+  /**
+   * @param {Compiler} compiler
+   */
+  run(compiler: Compiler): Promise<void>;
+  startTime: number;
+  prevTimestamps: Map<any, any>;
   /**
    * @param {Compiler} compiler
    * @returns {void}
@@ -15,4 +32,17 @@ declare class StylelintWebpackPlugin {
    * @returns {string}
    */
   getContext(compiler: Compiler): string;
+  /**
+   * @param {Compiler} compiler
+   * @param {Module} module
+   * @returns {string[]}
+   */
+  getFiles({ fileTimestamps }: Compiler, { buildInfo }: Module): string[];
+  /**
+   * @param {Map<string, null | FileSystemInfoEntry | "ignore">} fileTimestamps
+   * @returns {string[]}
+   */
+  getChangedFiles(
+    fileTimestamps: Map<string, 'ignore' | FileSystemInfoEntry | null>
+  ): string[];
 }