stylelint-webpack-plugin 2.2.0 → 2.3.1

package/README.md

@@ -64,7 +64,7 @@ A string indicating the root of your files.
 ### `exclude`
 
 - Type: `String|Array[String]`
-- Default: `'node_modules'`
+- Default: `['node_modules', compiler.options.output.path]`
 
 Specify the files and/or directories to exclude. Must be relative to `options.context`.
 

package/declarations/getStylelint.d.ts

@@ -1,3 +1,4 @@
+/// <reference types="stylelint" />
 /**
  * @param {string|undefined} key
  * @param {Options} options
@@ -7,7 +8,54 @@ export default function getStylelint(
   key: string | undefined,
   { threads, ...options }: Options
 ): Linter;
-export type Stylelint = typeof import('stylelint');
+export type Stylelint = import('stylelint/node_modules/postcss').PluginCreator<
+  import('stylelint').PostcssPluginOptions
+> & {
+  lint: (
+    options: import('stylelint').LinterOptions
+  ) => Promise<import('stylelint').LinterResult>;
+  rules: {
+    [k: string]: import('stylelint').Rule<any, any>;
+  };
+  formatters: {
+    [k: string]: import('stylelint').Formatter;
+  };
+  createPlugin: (
+    ruleName: string,
+    plugin: import('stylelint').Plugin<any, any>
+  ) => {
+    ruleName: string;
+    rule: import('stylelint').Rule<any, any>;
+  };
+  createLinter: (
+    options: import('stylelint').LinterOptions
+  ) => import('stylelint').InternalApi;
+  utils: {
+    report: (problem: import('stylelint').Problem) => void;
+    ruleMessages: <
+      T extends import('stylelint').RuleMessages,
+      R extends { [K in keyof T]: T[K] }
+    >(
+      ruleName: string,
+      messages: T
+    ) => R;
+    validateOptions: (
+      result: import('stylelint').PostcssResult,
+      ruleName: string,
+      ...optionDescriptions: import('stylelint').RuleOptions[]
+    ) => boolean;
+    checkAgainstRule: <T_1, O extends Object>(
+      options: {
+        ruleName: string;
+        ruleSettings: import('stylelint').ConfigRuleSettings<T_1, O>;
+        root: import('stylelint/node_modules/postcss').Root;
+      },
+      callback: (
+        warning: import('stylelint/node_modules/postcss').Warning
+      ) => void
+    ) => void;
+  };
+};
 export type LintResult = import('stylelint').LintResult;
 export type Options = import('./options').Options;
 export type AsyncTask = () => Promise<void>;

package/declarations/index.d.ts

@@ -20,7 +20,11 @@ declare class StylelintWebpackPlugin {
    */
   run(compiler: Compiler): Promise<void>;
   startTime: number;
-  prevTimestamps: Map<any, any>;
+  /** @type {ReadonlyMap<string, null | FileSystemInfoEntry | "ignore" | undefined>} */
+  prevTimestamps: ReadonlyMap<
+    string,
+    'ignore' | FileSystemInfoEntry | null | undefined
+  >;
   /**
    * @param {Compiler} compiler
    * @returns {void}
@@ -33,17 +37,20 @@ declare class StylelintWebpackPlugin {
    */
   getContext(compiler: Compiler): string;
   /**
-   * @param {string[]} glob
    * @param {Compiler} compiler
-   * @param {Module} module
+   * @param {string[]} wanted
+   * @param {string[]} exclude
    * @returns {string[]}
    */
-  getFiles(glob: string[], compiler: Compiler, module: Module): string[];
+  getFiles(compiler: Compiler, wanted: string[], exclude: string[]): string[];
   /**
-   * @param {Map<string, null | FileSystemInfoEntry | "ignore">} fileTimestamps
+   * @param {ReadonlyMap<string, null | FileSystemInfoEntry | "ignore" | undefined>} fileTimestamps
    * @returns {string[]}
    */
   getChangedFiles(
-    fileTimestamps: Map<string, 'ignore' | FileSystemInfoEntry | null>
+    fileTimestamps: ReadonlyMap<
+      string,
+      'ignore' | FileSystemInfoEntry | null | undefined
+    >
   ): string[];
 }

package/declarations/linter.d.ts

@@ -1,3 +1,4 @@
+/// <reference types="stylelint" />
 /**
  * @param {string|undefined} key
  * @param {Options} options
@@ -13,7 +14,54 @@ export default function linter(
   report: Reporter;
   threads: number;
 };
-export type Stylelint = typeof import('stylelint');
+export type Stylelint = import('stylelint/node_modules/postcss').PluginCreator<
+  import('stylelint').PostcssPluginOptions
+> & {
+  lint: (
+    options: import('stylelint').LinterOptions
+  ) => Promise<import('stylelint').LinterResult>;
+  rules: {
+    [k: string]: import('stylelint').Rule<any, any>;
+  };
+  formatters: {
+    [k: string]: import('stylelint').Formatter;
+  };
+  createPlugin: (
+    ruleName: string,
+    plugin: import('stylelint').Plugin<any, any>
+  ) => {
+    ruleName: string;
+    rule: import('stylelint').Rule<any, any>;
+  };
+  createLinter: (
+    options: import('stylelint').LinterOptions
+  ) => import('stylelint').InternalApi;
+  utils: {
+    report: (problem: import('stylelint').Problem) => void;
+    ruleMessages: <
+      T extends import('stylelint').RuleMessages,
+      R extends { [K in keyof T]: T[K] }
+    >(
+      ruleName: string,
+      messages: T
+    ) => R;
+    validateOptions: (
+      result: import('stylelint').PostcssResult,
+      ruleName: string,
+      ...optionDescriptions: import('stylelint').RuleOptions[]
+    ) => boolean;
+    checkAgainstRule: <T_1, O extends Object>(
+      options: {
+        ruleName: string;
+        ruleSettings: import('stylelint').ConfigRuleSettings<T_1, O>;
+        root: import('stylelint/node_modules/postcss').Root;
+      },
+      callback: (
+        warning: import('stylelint/node_modules/postcss').Warning
+      ) => void
+    ) => void;
+  };
+};
 export type LintResult = import('stylelint').LintResult;
 export type Compiler = import('webpack').Compiler;
 export type Compilation = import('webpack').Compilation;

package/declarations/options.d.ts

@@ -1,3 +1,4 @@
+/// <reference types="stylelint" />
 /** @typedef {import("stylelint")} stylelint */
 /** @typedef {import("stylelint").LinterOptions} StylelintOptions */
 /** @typedef {import("stylelint").FormatterType} FormatterType */
@@ -36,7 +37,54 @@ export function getOptions(pluginOptions: Options): Partial<PluginOptions>;
 export function getStylelintOptions(
   pluginOptions: Options
 ): Partial<StylelintOptions>;
-export type stylelint = typeof import('stylelint');
+export type stylelint = import('stylelint/node_modules/postcss').PluginCreator<
+  import('stylelint').PostcssPluginOptions
+> & {
+  lint: (
+    options: import('stylelint').LinterOptions
+  ) => Promise<import('stylelint').LinterResult>;
+  rules: {
+    [k: string]: import('stylelint').Rule<any, any>;
+  };
+  formatters: {
+    [k: string]: import('stylelint').Formatter;
+  };
+  createPlugin: (
+    ruleName: string,
+    plugin: import('stylelint').Plugin<any, any>
+  ) => {
+    ruleName: string;
+    rule: import('stylelint').Rule<any, any>;
+  };
+  createLinter: (
+    options: import('stylelint').LinterOptions
+  ) => import('stylelint').InternalApi;
+  utils: {
+    report: (problem: import('stylelint').Problem) => void;
+    ruleMessages: <
+      T extends import('stylelint').RuleMessages,
+      R extends { [K in keyof T]: T[K] }
+    >(
+      ruleName: string,
+      messages: T
+    ) => R;
+    validateOptions: (
+      result: import('stylelint').PostcssResult,
+      ruleName: string,
+      ...optionDescriptions: import('stylelint').RuleOptions[]
+    ) => boolean;
+    checkAgainstRule: <T_1, O extends Object>(
+      options: {
+        ruleName: string;
+        ruleSettings: import('stylelint').ConfigRuleSettings<T_1, O>;
+        root: import('stylelint/node_modules/postcss').Root;
+      },
+      callback: (
+        warning: import('stylelint/node_modules/postcss').Warning
+      ) => void
+    ) => void;
+  };
+};
 export type StylelintOptions = import('stylelint').LinterOptions;
 export type FormatterType = import('stylelint').FormatterType;
 export type OutputReport = {

package/declarations/utils.d.ts

@@ -1,9 +1,12 @@
 /**
- * @param {string|string[]} files
+ * @param {string|(string|undefined)[]} files
  * @param {string} context
  * @returns {string[]}
  */
-export function parseFiles(files: string | string[], context: string): string[];
+export function parseFiles(
+  files: string | (string | undefined)[],
+  context: string
+): string[];
 /**
  * @param {string|string[]} patterns
  * @param {string|string[]} extensions

package/declarations/worker.d.ts

@@ -1,3 +1,51 @@
-export type Stylelint = typeof import('stylelint');
+/// <reference types="stylelint" />
+export type Stylelint = import('stylelint/node_modules/postcss').PluginCreator<
+  import('stylelint').PostcssPluginOptions
+> & {
+  lint: (
+    options: import('stylelint').LinterOptions
+  ) => Promise<import('stylelint').LinterResult>;
+  rules: {
+    [k: string]: import('stylelint').Rule<any, any>;
+  };
+  formatters: {
+    [k: string]: import('stylelint').Formatter;
+  };
+  createPlugin: (
+    ruleName: string,
+    plugin: import('stylelint').Plugin<any, any>
+  ) => {
+    ruleName: string;
+    rule: import('stylelint').Rule<any, any>;
+  };
+  createLinter: (
+    options: import('stylelint').LinterOptions
+  ) => import('stylelint').InternalApi;
+  utils: {
+    report: (problem: import('stylelint').Problem) => void;
+    ruleMessages: <
+      T extends import('stylelint').RuleMessages,
+      R extends { [K in keyof T]: T[K] }
+    >(
+      ruleName: string,
+      messages: T
+    ) => R;
+    validateOptions: (
+      result: import('stylelint').PostcssResult,
+      ruleName: string,
+      ...optionDescriptions: import('stylelint').RuleOptions[]
+    ) => boolean;
+    checkAgainstRule: <T_1, O extends Object>(
+      options: {
+        ruleName: string;
+        ruleSettings: import('stylelint').ConfigRuleSettings<T_1, O>;
+        root: import('stylelint/node_modules/postcss').Root;
+      },
+      callback: (
+        warning: import('stylelint/node_modules/postcss').Warning
+      ) => void
+    ) => void;
+  };
+};
 export type StylelintOptions = import('stylelint').LinterOptions;
 export type Options = import('./options').Options;

package/dist/index.js

@@ -9,7 +9,7 @@ var _path = require("path");
 
 var _arrify = _interopRequireDefault(require("arrify"));
 
-var _fastGlob = _interopRequireDefault(require("fast-glob"));
+var _globby = _interopRequireDefault(require("globby"));
 
 var _micromatch = require("micromatch");
 
@@ -43,6 +43,8 @@ class StylelintWebpackPlugin {
     this.options = (0, _options.getOptions)(options);
     this.run = this.run.bind(this);
     this.startTime = Date.now();
+    /** @type {ReadonlyMap<string, null | FileSystemInfoEntry | "ignore" | undefined>} */
+
     this.prevTimestamps = new Map();
   }
   /**
@@ -89,12 +91,12 @@ class StylelintWebpackPlugin {
 
     const context = this.getContext(compiler);
     const options = { ...this.options,
-      exclude: (0, _utils.parseFiles)(this.options.exclude || [], context),
+      exclude: (0, _utils.parseFiles)(this.options.exclude || ['**/node_modules/**', compiler.options.output.path], context),
       extensions: (0, _arrify.default)(this.options.extensions),
       files: (0, _utils.parseFiles)(this.options.files || '', context)
     };
     const wanted = (0, _utils.parseFoldersToGlobs)(options.files, options.extensions);
-    const exclude = (0, _utils.parseFoldersToGlobs)(this.options.exclude ? options.exclude : '**/node_modules/**', []);
+    const exclude = (0, _utils.parseFoldersToGlobs)(options.exclude);
     compiler.hooks.thisCompilation.tap(this.key, compilation => {
       /** @type {import('./linter').Linter} */
       let lint;
@@ -115,29 +117,15 @@ class StylelintWebpackPlugin {
         compilation.errors.push(e);
         return;
       }
-      /** @type {string[]} */
-
-
-      const files = []; // Add the file to be linted
-
-      compilation.hooks.succeedModule.tap(this.key, module => {
-        const filteredFiles = this.getFiles(wanted, compiler, module).filter(file => !files.includes(file) && (0, _micromatch.isMatch)(file, wanted, {
-          dot: true
-        }) && !(0, _micromatch.isMatch)(file, exclude, {
-          dot: true
-        }));
 
-        for (const file of filteredFiles) {
-          files.push(file);
+      compilation.hooks.finishModules.tap(this.key, () => {
+        const files = this.getFiles(compiler, wanted, exclude);
 
-          if (threads > 1) {
+        if (threads > 1) {
+          for (const file of files) {
             lint((0, _utils.parseFiles)(file, context));
           }
-        }
-      }); // Lint all files added
-
-      compilation.hooks.finishModules.tap(this.key, () => {
-        if (files.length > 0 && threads <= 1) {
+        } else if (files.length > 0) {
           lint((0, _utils.parseFiles)(files, context));
         }
       }); // await and interpret results
@@ -192,63 +180,42 @@ class StylelintWebpackPlugin {
     return this.options.context;
   }
   /**
-   * @param {string[]} glob
    * @param {Compiler} compiler
-   * @param {Module} module
+   * @param {string[]} wanted
+   * @param {string[]} exclude
    * @returns {string[]}
    */
   // eslint-disable-next-line no-unused-vars
 
 
-  getFiles(glob, compiler, module) {
-    // TODO: how to get module dependencies on css files?
-    // maybe implemented on next major version v3
-    // Temporaly lint all css files on start webpack
-    // on watch lint only modified files
-    // on webpack 5 not safe to use `module.buildInfo.snapshot`
-    // on webpack `module.buildInfo.fileDependencies` not working correclty
-    // webpack 5
-
-    /*
-    if (
-      module.buildInfo &&
-      module.buildInfo.snapshot &&
-      module.buildInfo.snapshot.fileTimestamps
-    ) {
-      files = this.getChangedFiles(module.buildInfo.snapshot.fileTimestamps);
-    }
-     // webpack 4
-    else if (module.buildInfo && module.buildInfo.fileDependencies) {
-      files = Array.from(module.buildInfo.fileDependencies);
-       if (compiler.fileTimestamps && compiler.fileTimestamps.size > 0) {
-        const fileDependencies = new Map();
-         for (const [filename, timestamp] of compiler.fileTimestamps.entries()) {
-          if (files.includes(filename)) {
-            fileDependencies.set(filename, timestamp);
-          }
-        }
-         files = this.getChangedFiles(fileDependencies);
-      }
-    }
-    */
+  getFiles(compiler, wanted, exclude) {
     // webpack 5
     if (compiler.modifiedFiles) {
-      return Array.from(compiler.modifiedFiles);
+      return Array.from(compiler.modifiedFiles).filter(file => (0, _micromatch.isMatch)(file, wanted, {
+        dot: true
+      }) && !(0, _micromatch.isMatch)(file, exclude, {
+        dot: true
+      }));
     } // webpack 4
 
     /* istanbul ignore next */
 
 
     if (compiler.fileTimestamps && compiler.fileTimestamps.size > 0) {
-      return this.getChangedFiles(compiler.fileTimestamps);
+      return this.getChangedFiles(compiler.fileTimestamps).filter(file => (0, _micromatch.isMatch)(file, wanted, {
+        dot: true
+      }) && !(0, _micromatch.isMatch)(file, exclude, {
+        dot: true
+      }));
     }
 
-    return _fastGlob.default.sync(glob, {
-      dot: true
+    return _globby.default.sync(wanted, {
+      dot: true,
+      ignore: exclude
     });
   }
   /**
-   * @param {Map<string, null | FileSystemInfoEntry | "ignore">} fileTimestamps
+   * @param {ReadonlyMap<string, null | FileSystemInfoEntry | "ignore" | undefined>} fileTimestamps
    * @returns {string[]}
    */
 
@@ -257,7 +224,7 @@ class StylelintWebpackPlugin {
 
   getChangedFiles(fileTimestamps) {
     /**
-     * @param {null | FileSystemInfoEntry | "ignore"} fileSystemInfoEntry
+     * @param {null | FileSystemInfoEntry | "ignore" | undefined} fileSystemInfoEntry
      * @returns {Partial<number>}
      */
     const getTimestamps = fileSystemInfoEntry => {
@@ -272,7 +239,7 @@ class StylelintWebpackPlugin {
     };
     /**
      * @param {string} filename
-     * @param {null | FileSystemInfoEntry | "ignore"} fileSystemInfoEntry
+     * @param {null | FileSystemInfoEntry | "ignore" | undefined} fileSystemInfoEntry
      * @returns {boolean}
      */
 

package/dist/linter.js

@@ -105,7 +105,7 @@ function linter(key, options, compilation) {
     await cleanup();
 
     for (const result of results) {
-      crossRunResultStorage[result.source] = result;
+      crossRunResultStorage[String(result.source)] = result;
     }
 
     results = Object.values(crossRunResultStorage); // do not analyze if there are no results or stylelint config
@@ -215,24 +215,20 @@ function parseResults(options, results) {
 
   const warnings = [];
   results.forEach(file => {
-    if (fileHasErrors(file)) {
-      const messages = file.warnings.filter(message => options.emitError && message.severity === 'error');
+    const fileErrors = file.warnings.filter(message => options.emitError && message.severity === 'error');
 
-      if (messages.length > 0) {
-        errors.push({ ...file,
-          warnings: messages
-        });
-      }
+    if (fileErrors.length > 0) {
+      errors.push({ ...file,
+        warnings: fileErrors
+      });
     }
 
-    if (fileHasWarnings(file)) {
-      const messages = file.warnings.filter(message => options.emitWarning && message.severity === 'warning');
+    const fileWarnings = file.warnings.filter(message => options.emitWarning && message.severity === 'warning');
 
-      if (messages.length > 0) {
-        warnings.push({ ...file,
-          warnings: messages
-        });
-      }
+    if (fileWarnings.length > 0) {
+      warnings.push({ ...file,
+        warnings: fileWarnings
+      });
     }
   });
   return {
@@ -240,24 +236,6 @@ function parseResults(options, results) {
     warnings
   };
 }
-/**
- * @param {LintResult} file
- * @returns {boolean}
- */
-
-
-function fileHasErrors(file) {
-  return !!file.errored;
-}
-/**
- * @param {LintResult} file
- * @returns {boolean}
- */
-
-
-function fileHasWarnings(file) {
-  return file.warnings && file.warnings.length > 0;
-}
 /**
  * @param {Stylelint} stylelint
  * @param {FormatterType=} formatter

package/dist/utils.js

@@ -3,9 +3,9 @@
 Object.defineProperty(exports, "__esModule", {
   value: true
 });
+exports.jsonStringifyReplacerSortKeys = void 0;
 exports.parseFiles = parseFiles;
 exports.parseFoldersToGlobs = parseFoldersToGlobs;
-exports.jsonStringifyReplacerSortKeys = void 0;
 
 var _path = require("path");
 
@@ -21,12 +21,14 @@ function _interopRequireDefault(obj) { return obj && obj.__esModule ? obj : { de
 // @ts-ignore
 
 /**
- * @param {string|string[]} files
+ * @param {string|(string|undefined)[]} files
  * @param {string} context
  * @returns {string[]}
  */
 function parseFiles(files, context) {
-  return (0, _arrify.default)(files).map((
+  return (0, _arrify.default)(files).filter((
+  /** @type {string} */
+  file) => typeof file === 'string').map((
   /** @type {string} */
   file) => (0, _normalizePath.default)((0, _path.resolve)(context, file)));
 }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "stylelint-webpack-plugin",
-  "version": "2.2.0",
+  "version": "2.3.1",
   "description": "A Stylelint plugin for webpack",
   "license": "MIT",
   "repository": "webpack-contrib/stylelint-webpack-plugin",
@@ -42,49 +42,50 @@
     "declarations"
   ],
   "peerDependencies": {
-    "stylelint": "^13.0.0",
+    "stylelint": "^13.0.0 || ^14.0.0",
     "webpack": "^4.0.0 || ^5.0.0"
   },
   "dependencies": {
-    "@types/stylelint": "^13.13.0",
+    "@types/stylelint": "^13.13.3",
     "arrify": "^2.0.1",
-    "fast-glob": "^3.2.5",
-    "jest-worker": "^27.0.2",
+    "jest-worker": "^27.3.1",
+    "globby": "^11.0.4",
     "micromatch": "^4.0.4",
     "normalize-path": "^3.0.0",
-    "schema-utils": "^3.0.0"
+    "schema-utils": "^3.1.1"
   },
   "devDependencies": {
-    "@babel/cli": "^7.14.5",
-    "@babel/core": "^7.14.6",
-    "@babel/preset-env": "^7.14.5",
+    "@babel/cli": "^7.16.0",
+    "@babel/core": "^7.16.0",
+    "@babel/preset-env": "^7.16.0",
     "@commitlint/cli": "^12.1.4",
     "@commitlint/config-conventional": "^12.1.4",
-    "@types/fs-extra": "^9.0.11",
-    "@types/micromatch": "^4.0.1",
+    "@types/fs-extra": "^9.0.13",
+    "@types/micromatch": "^4.0.2",
     "@types/normalize-path": "^3.0.0",
     "@types/webpack": "^5.28.0",
     "@webpack-contrib/eslint-config-webpack": "^3.0.0",
     "babel-eslint": "^10.1.0",
-    "babel-jest": "^27.0.2",
+    "babel-jest": "^27.3.1",
     "chokidar": "^3.5.2",
     "cross-env": "^7.0.3",
     "del": "^6.0.0",
     "del-cli": "^3.0.1",
-    "eslint": "^7.28.0",
+    "eslint": "^7.32.0",
     "eslint-config-prettier": "^8.3.0",
-    "eslint-plugin-import": "^2.23.4",
+    "eslint-plugin-import": "^2.25.2",
     "file-loader": "^6.2.0",
     "fs-extra": "^9.1.0",
     "husky": "^6.0.0",
-    "jest": "^27.0.4",
+    "jest": "^27.3.1",
     "lint-staged": "^10.5.4",
     "npm-run-all": "^4.1.5",
-    "prettier": "^2.3.1",
-    "standard-version": "^9.3.0",
-    "stylelint": "^13.13.1",
-    "typescript": "^4.3.2",
-    "webpack": "^5.39.0"
+    "postcss-scss": "^3.0.5",
+    "prettier": "^2.4.1",
+    "standard-version": "^9.3.2",
+    "stylelint": "^14.0.1",
+    "typescript": "^4.4.4",
+    "webpack": "^5.62.1"
   },
   "keywords": [
     "stylelint",