stylelint-webpack-plugin 4.1.0 → 5.0.0

package/README.md

@@ -7,12 +7,12 @@
 [![node][node]][node-url]
 [![tests][tests]][tests-url]
 [![coverage][cover]][cover-url]
-[![chat][chat]][chat-url]
+[![discussion][discussion]][discussion-url]
 [![size][size]][size-url]
 
 # stylelint-webpack-plugin
 
-> This is stylelint-webpack-plugin 3.0 which works only with webpack 5. For the webpack 4, see the [2.x branch](https://github.com/webpack-contrib/stylelint-webpack-plugin/tree/2.x).
+> This version of stylelint-webpack-plugin only works with webpack 5. For the webpack 4, see the [2.x branch](https://github.com/webpack-contrib/stylelint-webpack-plugin/tree/2.x).
 
 This plugin uses [`stylelint`](https://stylelint.io/) that helps you avoid errors and enforce conventions in your styles.
 
@@ -76,6 +76,30 @@ module.exports = {
 
 See [stylelint's options](https://stylelint.io/user-guide/usage/node-api#options) for the complete list of options available. These options are passed through to the `stylelint` directly.
 
+### `cache`
+
+- Type:
+
+```ts
+type cache = boolean;
+```
+
+- Default: `true`
+
+The cache is enabled by default to decrease execution time.
+
+### `cacheLocation`
+
+- Type:
+
+```ts
+type cacheLocation = string;
+```
+
+- Default: `node_modules/.cache/stylelint-webpack-plugin/.stylelintcache`
+
+Specify the path to the cache location. Can be a file or a directory.
+
 ### `configFile`
 
 - Type:
@@ -314,7 +338,7 @@ You can pass in a different formatter for the output file, if none is passed in
 [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
 [cover-url]: https://codecov.io/gh/webpack-contrib/stylelint-webpack-plugin
-[chat]: https://badges.gitter.im/webpack/webpack.svg
-[chat-url]: https://gitter.im/webpack/webpack
+[discussion]: https://img.shields.io/github/discussions/webpack/webpack
+[discussion-url]: https://github.com/webpack/webpack/discussions
 [size]: https://packagephobia.now.sh/badge?p=stylelint-webpack-plugin
 [size-url]: https://packagephobia.now.sh/result?p=stylelint-webpack-plugin

package/dist/getStylelint.js

@@ -29,10 +29,9 @@ const cache = {};
 /** @typedef {import('stylelint').Formatter} Formatter */
 /** @typedef {import('stylelint').FormatterType} FormatterType */
 /** @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 {{stylelint: Stylelint, isPathIgnored: isPathIgnored, lintFiles: LintTask, cleanup: AsyncTask, threads: number }} Linter */
+/** @typedef {{stylelint: Stylelint, lintFiles: LintTask, cleanup: AsyncTask, threads: number }} Linter */
 /** @typedef {JestWorker & {lintFiles: LintTask}} Worker */
 
 /**
@@ -42,22 +41,8 @@ const cache = {};
 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,
-    isPathIgnored,
     lintFiles,
     cleanup: async () => {},
     threads: 1

package/dist/index.js

@@ -89,15 +89,9 @@ class StylelintWebpackPlugin {
       return;
     }
     compiler.hooks.thisCompilation.tap(this.key, compilation => {
-      /** @type {import('./getStylelint').Stylelint} */
-      let stylelint;
-
       /** @type {import('./linter').Linter} */
       let lint;
 
-      /** @type {import('./linter').isPathIgnored} */
-      let isPathIgnored;
-
       /** @type {import('./linter').Reporter} */
       let report;
 
@@ -105,9 +99,7 @@ class StylelintWebpackPlugin {
       let threads;
       try {
         ({
-          stylelint,
           lint,
-          isPathIgnored,
           report,
           threads
         } = linter(this.key, options, compilation));
@@ -118,20 +110,14 @@ class StylelintWebpackPlugin {
       compilation.hooks.finishModules.tapPromise(this.key, async () => {
         /** @type {string[]} */
         // @ts-ignore
-        const files = (await Promise.all((compiler.modifiedFiles ? Array.from(compiler.modifiedFiles).filter(file => isMatch(file, wanted, {
+        const files = compiler.modifiedFiles ? Array.from(compiler.modifiedFiles).filter(file => isMatch(file, wanted, {
           dot: true
         }) && !isMatch(file, exclude, {
           dot: true
         })) : globby.sync(wanted, {
           dot: true,
           ignore: exclude
-        })).map(async file => {
-          try {
-            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, String(options.context)));

package/dist/linter.js

@@ -18,7 +18,6 @@ const {
 /** @typedef {import('./getStylelint').LinterResult} LinterResult */
 /** @typedef {import('./getStylelint').Formatter} Formatter */
 /** @typedef {import('./getStylelint').FormatterType} FormatterType */
-/** @typedef {import('./getStylelint').isPathIgnored} isPathIgnored */
 /** @typedef {import('./options').Options} Options */
 /** @typedef {(compilation: Compilation) => Promise<void>} GenerateReport */
 /** @typedef {{errors?: StylelintError, warnings?: StylelintError, generateReportAsset?: GenerateReport}} Report */
@@ -33,15 +32,12 @@ const resultStorage = new WeakMap();
  * @param {string|undefined} key
  * @param {Options} options
  * @param {Compilation} compilation
- * @returns {{stylelint: Stylelint, isPathIgnored: isPathIgnored, lint: Linter, report: Reporter, threads: number}}
+ * @returns {{lint: Linter, report: Reporter, threads: number}}
  */
 function linter(key, options, compilation) {
   /** @type {Stylelint} */
   let stylelint;
 
-  /** @type {isPathIgnored} */
-  let isPathIgnored;
-
   /** @type {(files: string|string[]) => Promise<LintResult[]>} */
   let lintFiles;
 
@@ -57,7 +53,6 @@ function linter(key, options, compilation) {
   try {
     ({
       stylelint,
-      isPathIgnored,
       lintFiles,
       cleanup,
       threads
@@ -66,9 +61,7 @@ function linter(key, options, compilation) {
     throw new StylelintError(e.message);
   }
   return {
-    stylelint,
     lint,
-    isPathIgnored,
     report,
     threads
   };
@@ -101,7 +94,7 @@ function linter(key, options, compilation) {
     if (!results || results.length < 1) {
       return {};
     }
-    const formatter = loadFormatter(stylelint, options.formatter);
+    const formatter = await loadFormatter(stylelint, options.formatter);
 
     /** @type {LinterResult} */
     const returnValue = {
@@ -137,7 +130,7 @@ function linter(key, options, compilation) {
        * @param {string} name
        * @param {string | Buffer} content
        */
-      const save = (name, content) => /** @type {Promise<void>} */
+      const save = (name, content) => ( /** @type {Promise<void>} */
       new Promise((finish, bail) => {
         const {
           mkdir,
@@ -154,12 +147,12 @@ function linter(key, options, compilation) {
             if (err2) bail(err2);else finish();
           });
         });
-      });
+      }));
       if (!outputReport || !outputReport.filePath) {
         return;
       }
       const content = outputReport.formatter;
-      loadFormatter(stylelint, outputReport.formatter)(results, returnValue);
+      (await loadFormatter(stylelint, outputReport.formatter))(results, returnValue);
       formatter(results, returnValue);
       let {
         filePath
@@ -229,7 +222,7 @@ function parseResults(options, results) {
 /**
  * @param {Stylelint} stylelint
  * @param {FormatterType=} formatter
- * @returns {Formatter}
+ * @returns {Promise<Formatter>|Formatter}
  */
 function loadFormatter(stylelint, formatter) {
   if (typeof formatter === 'function') {

package/dist/options.js

@@ -40,6 +40,8 @@ const schema = require('./options.json');
  */
 function getOptions(pluginOptions) {
   const options = {
+    cache: true,
+    cacheLocation: 'node_modules/.cache/stylelint-webpack-plugin/.stylelintcache',
     extensions: ['css', 'scss', 'sass'],
     emitError: true,
     emitWarning: true,

package/dist/options.json

@@ -36,7 +36,11 @@
     },
     "formatter": {
       "description": "Specify the formatter that you would like to use to format your results.",
-      "anyOf": [{ "type": "string" }, { "instanceof": "Function" }]
+      "anyOf": [
+        { "type": "string" },
+        { "instanceof": "Function" },
+        { "instanceof": "Promise" }
+      ]
     },
     "lintDirtyModulesOnly": {
       "description": "Lint only changed files, skip lint on start.",

package/dist/worker.js

@@ -33,7 +33,8 @@ async function lintFiles(files) {
     results
   } = await stylelint.lint({
     ...linterOptions,
-    files
+    files,
+    quietDeprecationWarnings: true
   });
 
   // Reset result to work with worker

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "stylelint-webpack-plugin",
-  "version": "4.1.0",
+  "version": "5.0.0",
   "description": "A Stylelint plugin for webpack",
   "license": "MIT",
   "repository": "webpack-contrib/stylelint-webpack-plugin",
@@ -14,7 +14,7 @@
   "main": "dist/index.js",
   "types": "types/index.d.ts",
   "engines": {
-    "node": ">= 14.15.0"
+    "node": ">= 18.12.0"
   },
   "scripts": {
     "start": "npm run build -- -w",
@@ -30,7 +30,10 @@
     "lint:spelling": "cspell \"**/*.*\"",
     "lint:types": "tsc --pretty --noEmit",
     "lint": "npm-run-all -l -p \"lint:**\"",
-    "test:only": "cross-env NODE_ENV=test jest --testTimeout=60000",
+    "fix:js": "npm run lint:js -- --fix",
+    "fix:prettier": "npm run lint:prettier -- --write",
+    "fix": "npm-run-all -l fix:js fix:prettier",
+    "test:only": "cross-env NODE_OPTIONS=--experimental-vm-modules NODE_ENV=test jest --testTimeout=60000",
     "test:watch": "npm run test:only -- --watch",
     "test:coverage": "npm run test:only -- --collectCoverageFrom=\"src/**/*.js\" --coverage",
     "pretest": "npm run lint",
@@ -43,51 +46,51 @@
     "types"
   ],
   "peerDependencies": {
-    "stylelint": "^13.0.0 || ^14.0.0 || ^15.0.0",
+    "stylelint": "^13.0.0 || ^14.0.0 || ^15.0.0 || ^16.0.0",
     "webpack": "^5.0.0"
   },
   "dependencies": {
     "globby": "^11.1.0",
-    "jest-worker": "^29.4.2",
+    "jest-worker": "^29.7.0",
     "micromatch": "^4.0.5",
     "normalize-path": "^3.0.0",
-    "schema-utils": "^4.0.0"
+    "schema-utils": "^4.2.0"
   },
   "devDependencies": {
-    "@babel/cli": "^7.20.7",
-    "@babel/core": "^7.20.12",
-    "@babel/preset-env": "^7.20.2",
-    "@commitlint/cli": "^17.4.2",
-    "@commitlint/config-conventional": "^17.4.2",
-    "@types/file-entry-cache": "^5.0.2",
-    "@types/fs-extra": "^9.0.13",
-    "@types/micromatch": "^4.0.2",
-    "@types/node": "^18.13.0",
-    "@types/normalize-path": "^3.0.0",
-    "@types/webpack": "^5.28.0",
+    "@babel/cli": "^7.23.4",
+    "@babel/core": "^7.23.7",
+    "@babel/preset-env": "^7.23.8",
+    "@commitlint/cli": "^18.6.0",
+    "@commitlint/config-conventional": "^18.6.0",
+    "@types/file-entry-cache": "^5.0.4",
+    "@types/fs-extra": "^11.0.4",
+    "@types/micromatch": "^4.0.6",
+    "@types/node": "^20.11.6",
+    "@types/normalize-path": "^3.0.2",
+    "@types/webpack": "^5.28.5",
     "@webpack-contrib/eslint-config-webpack": "^3.0.0",
     "babel-eslint": "^10.1.0",
-    "babel-jest": "^29.4.2",
+    "babel-jest": "^29.7.0",
     "chokidar": "^3.5.3",
     "cross-env": "^7.0.3",
-    "cspell": "^6.22.0",
-    "del": "^6.1.1",
-    "del-cli": "^4.0.1",
-    "eslint": "^8.34.0",
-    "eslint-config-prettier": "^8.6.0",
-    "eslint-plugin-import": "^2.27.5",
+    "cspell": "^8.3.2",
+    "del": "^7.1.0",
+    "del-cli": "^5.1.0",
+    "eslint": "^8.56.0",
+    "eslint-config-prettier": "^9.1.0",
+    "eslint-plugin-import": "^2.29.1",
     "file-loader": "^6.2.0",
-    "fs-extra": "^10.1.0",
+    "fs-extra": "^11.2.0",
     "husky": "^8.0.3",
-    "jest": "^29.4.2",
-    "lint-staged": "^13.1.1",
+    "jest": "^29.7.0",
+    "lint-staged": "^15.2.0",
     "npm-run-all": "^4.1.5",
-    "postcss-scss": "^4.0.6",
-    "prettier": "^2.8.4",
+    "postcss-scss": "^4.0.9",
+    "prettier": "^3.2.4",
     "standard-version": "^9.5.0",
-    "stylelint": "^15.0.0",
-    "typescript": "^4.9.5",
-    "webpack": "^5.75.0"
+    "stylelint": "^16.2.0",
+    "typescript": "^5.3.3",
+    "webpack": "^5.90.0"
   },
   "keywords": [
     "stylelint",

package/types/getStylelint.d.ts

@@ -1,4 +1,3 @@
-/// <reference types="stylelint" />
 export = getStylelint;
 /**
  * @param {string|undefined} key
@@ -7,7 +6,7 @@ export = getStylelint;
  */
 declare function getStylelint(
   key: string | undefined,
-  { threads, ...options }: Options
+  { threads, ...options }: Options,
 ): Linter;
 declare namespace getStylelint {
   export {
@@ -18,7 +17,6 @@ declare namespace getStylelint {
     Formatter,
     FormatterType,
     Options,
-    isPathIgnored,
     AsyncTask,
     LintTask,
     Linter,
@@ -28,7 +26,6 @@ declare namespace getStylelint {
 type Options = import('./options').Options;
 type Linter = {
   stylelint: Stylelint;
-  isPathIgnored: isPathIgnored;
   lintFiles: LintTask;
   cleanup: AsyncTask;
   threads: number;
@@ -44,10 +41,6 @@ type LinterOptions = import('stylelint').LinterOptions;
 type LinterResult = import('stylelint').LinterResult;
 type Formatter = import('stylelint').Formatter;
 type FormatterType = import('stylelint').FormatterType;
-type isPathIgnored = (
-  stylelint: Stylelint,
-  filePath: string
-) => Promise<boolean>;
 type AsyncTask = () => Promise<void>;
 type LintTask = (files: string | string[]) => Promise<LintResult[]>;
 type Worker = JestWorker & {

package/types/index.d.ts

@@ -16,7 +16,7 @@ declare class StylelintWebpackPlugin {
     compiler: Compiler,
     options: Options,
     wanted: string[],
-    exclude: string[]
+    exclude: string[],
   ): Promise<void>;
   startTime: number;
   prevTimestamps: Map<any, any>;
@@ -36,8 +36,8 @@ declare namespace StylelintWebpackPlugin {
   export { Compiler, Module, Options, FileSystemInfoEntry };
 }
 type Compiler = import('webpack').Compiler;
-type Options = import('./options').Options;
 type Module = import('webpack').Module;
+type Options = import('./options').Options;
 type FileSystemInfoEntry = Partial<
   | {
       timestamp: number;

package/types/linter.d.ts

@@ -1,18 +1,15 @@
-/// <reference types="stylelint" />
 export = linter;
 /**
  * @param {string|undefined} key
  * @param {Options} options
  * @param {Compilation} compilation
- * @returns {{stylelint: Stylelint, isPathIgnored: isPathIgnored, lint: Linter, report: Reporter, threads: number}}
+ * @returns {{lint: Linter, report: Reporter, threads: number}}
  */
 declare function linter(
   key: string | undefined,
   options: Options,
-  compilation: Compilation
+  compilation: Compilation,
 ): {
-  stylelint: Stylelint;
-  isPathIgnored: getStylelint.isPathIgnored;
   lint: Linter;
   report: Reporter;
   threads: number;
@@ -26,7 +23,6 @@ declare namespace linter {
     LinterResult,
     Formatter,
     FormatterType,
-    isPathIgnored,
     Options,
     GenerateReport,
     Report,
@@ -37,16 +33,14 @@ declare namespace linter {
 }
 type Options = import('./options').Options;
 type Compilation = import('webpack').Compilation;
-type Stylelint = import('./getStylelint').Stylelint;
 type Linter = (files: string | string[]) => void;
 type Reporter = () => Promise<Report>;
-import getStylelint = require('./getStylelint');
 type Compiler = import('webpack').Compiler;
+type Stylelint = import('./getStylelint').Stylelint;
 type LintResult = import('./getStylelint').LintResult;
 type LinterResult = import('./getStylelint').LinterResult;
 type Formatter = import('./getStylelint').Formatter;
 type FormatterType = import('./getStylelint').FormatterType;
-type isPathIgnored = import('./getStylelint').isPathIgnored;
 type GenerateReport = (compilation: Compilation) => Promise<void>;
 type Report = {
   errors?: StylelintError;

package/types/options.d.ts

@@ -56,5 +56,5 @@ export function getOptions(pluginOptions: Options): Partial<PluginOptions>;
  * @returns {Partial<StylelintOptions>}
  */
 export function getStylelintOptions(
-  pluginOptions: Options
+  pluginOptions: Options,
 ): Partial<StylelintOptions>;

package/types/utils.d.ts

@@ -14,16 +14,16 @@
  }
  */
 export function arrify<T>(
-  value: T
+  value: T,
 ): T extends null | undefined
   ? []
   : T extends string
-  ? [string]
-  : T extends readonly unknown[]
-  ? T
-  : T extends Iterable<infer T_1>
-  ? T_1[]
-  : [T];
+    ? [string]
+    : T extends readonly unknown[]
+      ? T
+      : T extends Iterable<infer T_1>
+        ? T_1[]
+        : [T];
 /**
  * @param {string|string[]} files
  * @param {string} context
@@ -37,7 +37,7 @@ export function parseFiles(files: string | string[], context: string): string[];
  */
 export function parseFoldersToGlobs(
   patterns: string | string[],
-  extensions?: string | string[]
+  extensions?: string | string[],
 ): string[];
 /**
  *