stylelint-webpack-plugin 3.2.0 → 4.0.0

package/README.md

@@ -5,7 +5,6 @@
 
 [![npm][npm]][npm-url]
 [![node][node]][node-url]
-[![deps][deps]][deps-url]
 [![tests][tests]][tests-url]
 [![coverage][cover]][cover-url]
 [![chat][chat]][chat-url]
@@ -28,7 +27,7 @@ npm install stylelint-webpack-plugin --save-dev
 or
 
 ```console
-yarn add -D install stylelint-webpack-plugin
+yarn add -D stylelint-webpack-plugin
 ```
 
 or
@@ -37,7 +36,9 @@ or
 pnpm add -D stylelint-webpack-plugin
 ```
 
-**Note**: You also need to install `stylelint >= 13` from npm, if you haven't already:
+> **Note**:
+>
+> You also need to install `stylelint >= 13` from npm, if you haven't already:
 
 ```console
 npm install stylelint --save-dev
@@ -55,7 +56,9 @@ or
 pnpm add -D stylelint
 ```
 
-**Note**: If you are using Stylelint 13 rather than 14+, you might also need to install `@types/stylelint` as a dev dependency if getting stylelint related type errors.
+> **Note**:
+>
+> If you are using Stylelint 13 rather than 14+, you might also need to install `@types/stylelint` as a dev dependency if getting stylelint related type errors.
 
 Then add the plugin to your webpack config. For example:
 
@@ -85,7 +88,9 @@ type context = string;
 
 Specify the config file location to be used by `stylelint`.
 
-**Note:** By default this is [handled by `stylelint`](https://stylelint.io/user-guide/configure).
+> **Note:**
+>
+> By default this is [handled by `stylelint`](https://stylelint.io/user-guide/configure).
 
 ### `context`
 
@@ -305,8 +310,6 @@ You can pass in a different formatter for the output file, if none is passed in
 [npm-url]: https://npmjs.com/package/stylelint-webpack-plugin
 [node]: https://img.shields.io/node/v/stylelint-webpack-plugin.svg
 [node-url]: https://nodejs.org
-[deps]: https://david-dm.org/webpack-contrib/stylelint-webpack-plugin.svg
-[deps-url]: https://david-dm.org/webpack-contrib/stylelint-webpack-plugin
 [tests]: https://github.com/webpack-contrib/stylelint-webpack-plugin/workflows/stylelint-webpack-plugin/badge.svg
 [tests-url]: https://github.com/webpack-contrib/stylelint-webpack-plugin/actions
 [cover]: https://codecov.io/gh/webpack-contrib/stylelint-webpack-plugin/branch/master/graph/badge.svg

package/dist/StylelintError.js

@@ -5,11 +5,9 @@ class StylelintError extends Error {
    * @param {string=} messages
    */
   constructor(messages) {
-    super(messages);
+    super(`[stylelint] ${messages}`);
     this.name = 'StylelintError';
     this.stack = '';
   }
-
 }
-
 module.exports = StylelintError;

package/dist/getStylelint.js

@@ -3,94 +3,90 @@
 const {
   cpus
 } = require('os');
-
 const {
   Worker: JestWorker
-} = require('jest-worker'); // @ts-ignore
-
+} = require('jest-worker');
 
+// @ts-ignore
 const {
   setup,
   lintFiles
 } = require('./worker');
-
 const {
   jsonStringifyReplacerSortKeys
 } = require('./utils');
-
 const {
   getStylelintOptions
 } = require('./options');
-/** @type {{[key: string]: any}} */
-
 
+/** @type {{[key: string]: any}} */
 const cache = {};
-/** @typedef {import('stylelint')} Stylelint */
 
+/** @typedef {import('stylelint')} Stylelint */
 /** @typedef {import('stylelint').LintResult} LintResult */
-
 /** @typedef {import('./options').Options} Options */
-
+/** @typedef {(stylelint: Stylelint, filePath: string) => Promise<boolean>} isPathIgnored */
 /** @typedef {() => Promise<void>} AsyncTask */
-
 /** @typedef {(files: string|string[]) => Promise<LintResult[]>} LintTask */
-
-/** @typedef {{api: import('stylelint').InternalApi, stylelint: Stylelint, lintFiles: LintTask, cleanup: AsyncTask, threads: number, }} Linter */
-
-/** @typedef {import('jest-worker').Worker & {lintFiles: LintTask}} Worker */
+/** @typedef {{stylelint: Stylelint, isPathIgnored: isPathIgnored, lintFiles: LintTask, cleanup: AsyncTask, threads: number }} Linter */
+/** @typedef {JestWorker & {lintFiles: LintTask}} Worker */
 
 /**
  * @param {Options} options
  * @returns {Linter}
  */
-
 function loadStylelint(options) {
   const stylelintOptions = getStylelintOptions(options);
   const stylelint = setup(options, stylelintOptions);
+
+  /** @type {isPathIgnored} */
+  let isPathIgnored;
+  try {
+    isPathIgnored = require(`${options.stylelintPath}/lib/isPathIgnored`);
+  } catch (e) {
+    try {
+      // @ts-ignore
+      isPathIgnored = require('stylelint/lib/isPathIgnored');
+    } catch (_) {
+      isPathIgnored = () => Promise.resolve(false);
+    }
+  }
   return {
     stylelint,
-    api: stylelint.createLinter(stylelintOptions),
+    isPathIgnored,
     lintFiles,
     cleanup: async () => {},
     threads: 1
   };
 }
+
 /**
  * @param {string|undefined} key
  * @param {number} poolSize
  * @param {Options} options
  * @returns {Linter}
  */
-
-
 function loadStylelintThreaded(key, poolSize, options) {
   const cacheKey = getCacheKey(key, options);
-
   const source = require.resolve('./worker');
-
   const workerOptions = {
     enableWorkerThreads: true,
     numWorkers: poolSize,
     setupArgs: [options, getStylelintOptions(options)]
   };
   const local = loadStylelint(options);
-  let worker =
-  /** @type {Worker?} */
-  new JestWorker(source, workerOptions);
-  /** @type {Linter} */
+  let worker = /** @type {Worker?} */new JestWorker(source, workerOptions);
 
-  const context = { ...local,
+  /** @type {Linter} */
+  const context = {
+    ...local,
     threads: poolSize,
-    lintFiles: async files =>
-    /* istanbul ignore next */
+    lintFiles: async files => /* istanbul ignore next */
     worker ? worker.lintFiles(files) : local.lintFiles(files),
     cleanup: async () => {
       cache[cacheKey] = local;
-
       context.lintFiles = files => local.lintFiles(files);
       /* istanbul ignore next */
-
-
       if (worker) {
         worker.end();
         worker = null;
@@ -99,13 +95,12 @@ function loadStylelintThreaded(key, poolSize, options) {
   };
   return context;
 }
+
 /**
  * @param {string|undefined} key
  * @param {Options} options
  * @returns {Linter}
  */
-
-
 function getStylelint(key, {
   threads,
   ...options
@@ -115,25 +110,21 @@ function getStylelint(key, {
     threads,
     ...options
   });
-
   if (!cache[cacheKey]) {
     cache[cacheKey] = max > 1 ? loadStylelintThreaded(key, max, options) : loadStylelint(options);
   }
-
   return cache[cacheKey];
 }
+
 /**
  * @param {string|undefined} key
  * @param {Options} options
  * @returns {string}
  */
-
-
 function getCacheKey(key, options) {
   return JSON.stringify({
     key,
     options
   }, jsonStringifyReplacerSortKeys);
 }
-
 module.exports = getStylelint;

package/dist/index.js

@@ -4,36 +4,27 @@ const {
   isAbsolute,
   join
 } = require('path');
-
 const globby = require('globby');
-
 const {
   isMatch
 } = require('micromatch');
-
 const {
   getOptions
 } = require('./options');
-
 const linter = require('./linter');
-
 const {
   arrify,
   parseFiles,
   parseFoldersToGlobs
 } = require('./utils');
-/** @typedef {import('webpack').Compiler} Compiler */
 
+/** @typedef {import('webpack').Compiler} Compiler */
 /** @typedef {import('webpack').Module} Module */
-
 /** @typedef {import('./options').Options} Options */
-
 /** @typedef {Partial<{timestamp:number} | number>} FileSystemInfoEntry */
 
-
 const STYLELINT_PLUGIN = 'StylelintWebpackPlugin';
 let counter = 0;
-
 class StylelintWebpackPlugin {
   /**
    * @param {Options} options
@@ -45,74 +36,78 @@ class StylelintWebpackPlugin {
     this.startTime = Date.now();
     this.prevTimestamps = new Map();
   }
+
   /**
    * @param {Compiler} compiler
    * @returns {void}
    */
-
-
   apply(compiler) {
     // Generate key for each compilation,
     // this differentiates one from the other when being cached.
-    this.key = compiler.name || `${this.key}_${counter += 1}`; // If `lintDirtyModulesOnly` is disabled,
-    // execute the linter on the build
+    this.key = compiler.name || `${this.key}_${counter += 1}`;
+    const context = this.getContext(compiler);
+    const excludeDefault = ['**/node_modules/**', String(compiler.options.output.path)];
+    const options = {
+      ...this.options,
+      context,
+      exclude: parseFiles(this.options.exclude || excludeDefault, context),
+      extensions: arrify(this.options.extensions),
+      files: parseFiles(this.options.files || '', context)
+    };
+    const wanted = parseFoldersToGlobs(options.files, options.extensions);
+    const exclude = parseFoldersToGlobs(options.exclude);
 
+    // If `lintDirtyModulesOnly` is disabled,
+    // execute the linter on the build
     if (!this.options.lintDirtyModulesOnly) {
-      compiler.hooks.run.tapPromise(this.key, this.run);
+      compiler.hooks.run.tapPromise(this.key, c => this.run(c, options, wanted, exclude));
     }
-
     let isFirstRun = this.options.lintDirtyModulesOnly;
     compiler.hooks.watchRun.tapPromise(this.key, c => {
       if (isFirstRun) {
         isFirstRun = false;
         return Promise.resolve();
       }
-
-      return this.run(c);
+      return this.run(c, options, wanted, exclude);
     });
   }
+
   /**
    * @param {Compiler} compiler
+   * @param {Options} options
+   * @param {string[]} wanted
+   * @param {string[]} exclude
    */
-
-
-  async run(compiler) {
+  async run(compiler, options, wanted, exclude) {
     // Do not re-hook
-
     /* istanbul ignore if */
-    if ( // @ts-ignore
+    if (
+    // @ts-ignore
     compiler.hooks.thisCompilation.taps.find(({
       name
     }) => name === this.key)) {
       return;
     }
-
-    const context = this.getContext(compiler);
-    const excludeDefault = ['**/node_modules/**', String(compiler.options.output.path)];
-    const options = { ...this.options,
-      exclude: parseFiles(this.options.exclude || excludeDefault, context),
-      extensions: arrify(this.options.extensions),
-      files: parseFiles(this.options.files || '', context)
-    };
-    const wanted = parseFoldersToGlobs(options.files, options.extensions);
-    const exclude = parseFoldersToGlobs(options.exclude);
     compiler.hooks.thisCompilation.tap(this.key, compilation => {
+      /** @type {import('stylelint')} */
+      let stylelint;
+
       /** @type {import('./linter').Linter} */
       let lint;
-      /** @type {import('stylelint').InternalApi} */
 
-      let api;
-      /** @type {import('./linter').Reporter} */
+      /** @type {import('./linter').isPathIgnored} */
+      let isPathIgnored;
 
+      /** @type {import('./linter').Reporter} */
       let report;
-      /** @type number */
 
+      /** @type number */
       let threads;
-
       try {
         ({
+          stylelint,
           lint,
-          api,
+          isPathIgnored,
           report,
           threads
         } = linter(this.key, options, compilation));
@@ -120,7 +115,6 @@ class StylelintWebpackPlugin {
         compilation.errors.push(e);
         return;
       }
-
       compilation.hooks.finishModules.tapPromise(this.key, async () => {
         /** @type {string[]} */
         // @ts-ignore
@@ -133,30 +127,28 @@ class StylelintWebpackPlugin {
           ignore: exclude
         })).map(async file => {
           try {
-            return (await api.isPathIgnored(file)) ? false : file;
+            return (await isPathIgnored(stylelint, file)) ? false : file;
           } catch (e) {
             return file;
           }
         }))).filter(file => file !== false);
-
         if (threads > 1) {
           for (const file of files) {
-            lint(parseFiles(file, context));
+            lint(parseFiles(file, String(options.context)));
           }
         } else if (files.length > 0) {
-          lint(parseFiles(files, context));
+          lint(parseFiles(files, String(options.context)));
         }
-      }); // await and interpret results
+      });
 
+      // await and interpret results
       compilation.hooks.additionalAssets.tapPromise(this.key, processResults);
-
       async function processResults() {
         const {
           errors,
           warnings,
           generateReportAsset
         } = await report();
-
         if (warnings && !options.failOnWarning) {
           // @ts-ignore
           compilation.warnings.push(warnings);
@@ -164,7 +156,6 @@ class StylelintWebpackPlugin {
           // @ts-ignore
           compilation.errors.push(warnings);
         }
-
         if (errors && options.failOnError) {
           // @ts-ignore
           compilation.errors.push(errors);
@@ -172,32 +163,26 @@ class StylelintWebpackPlugin {
           // @ts-ignore
           compilation.warnings.push(errors);
         }
-
         if (generateReportAsset) {
           await generateReportAsset(compilation);
         }
       }
     });
   }
+
   /**
    *
    * @param {Compiler} compiler
    * @returns {string}
    */
-
-
   getContext(compiler) {
     if (!this.options.context) {
       return String(compiler.options.context);
     }
-
     if (!isAbsolute(this.options.context)) {
       return join(String(compiler.options.context), this.options.context);
     }
-
     return this.options.context;
   }
-
 }
-
 module.exports = StylelintWebpackPlugin;