stylelint-webpack-plugin 2.3.0 → 3.0.1

package/README.md

@@ -13,23 +13,23 @@
 
 # stylelint-webpack-plugin
 
-> A Stylelint plugin for webpack
+This plugin uses [`stylelint`](https://stylelint.io/) that helps you avoid errors and enforce conventions in your styles.
 
-## Install
+## Getting Started
+
+To begin, you'll need to install `stylelint-webpack-plugin`:
 
 ```bash
 npm install stylelint-webpack-plugin --save-dev
 ```
 
-**Note**: You also need to install `stylelint` from npm, if you haven't already:
+**Note**: You also need to install `stylelint >= 13` from npm, if you haven't already:
 
 ```bash
 npm install stylelint --save-dev
 ```
 
-## Usage
-
-In your webpack configuration:
+Then add the plugin to your webpack config. For example:
 
 ```js
 const StylelintPlugin = require('stylelint-webpack-plugin');

package/declarations/getStylelint.d.ts

@@ -1,4 +1,3 @@
-/// <reference types="stylelint" />
 /**
  * @param {string|undefined} key
  * @param {Options} options
@@ -8,54 +7,7 @@ export default function getStylelint(
   key: string | undefined,
   { threads, ...options }: Options
 ): Linter;
-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 Stylelint = typeof import('stylelint');
 export type LintResult = import('stylelint').LintResult;
 export type Options = import('./options').Options;
 export type AsyncTask = () => Promise<void>;

package/declarations/index.d.ts

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

package/declarations/linter.d.ts

@@ -1,4 +1,3 @@
-/// <reference types="stylelint" />
 /**
  * @param {string|undefined} key
  * @param {Options} options
@@ -14,54 +13,7 @@ export default function linter(
   report: Reporter;
   threads: number;
 };
-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 Stylelint = typeof import('stylelint');
 export type LintResult = import('stylelint').LintResult;
 export type Compiler = import('webpack').Compiler;
 export type Compilation = import('webpack').Compilation;

package/declarations/options.d.ts

@@ -1,4 +1,3 @@
-/// <reference types="stylelint" />
 /** @typedef {import("stylelint")} stylelint */
 /** @typedef {import("stylelint").LinterOptions} StylelintOptions */
 /** @typedef {import("stylelint").FormatterType} FormatterType */
@@ -37,54 +36,7 @@ export function getOptions(pluginOptions: Options): Partial<PluginOptions>;
 export function getStylelintOptions(
   pluginOptions: Options
 ): Partial<StylelintOptions>;
-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 stylelint = typeof import('stylelint');
 export type StylelintOptions = import('stylelint').LinterOptions;
 export type FormatterType = import('stylelint').FormatterType;
 export type OutputReport = {

package/declarations/utils.d.ts

@@ -1,12 +1,35 @@
 /**
- * @param {string|(string|undefined)[]} files
+ * @template T
+ * @param {T} value
+ * @return {
+   T extends (null | undefined)
+     ? []
+     : T extends string
+       ? [string]
+       : T extends readonly unknown[]
+         ? T
+         : T extends Iterable<infer T>
+           ? T[]
+           : [T]
+ }
+ */
+export function arrify<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];
+/**
+ * @param {string|string[]} files
  * @param {string} context
  * @returns {string[]}
  */
-export function parseFiles(
-  files: string | (string | undefined)[],
-  context: string
-): string[];
+export function parseFiles(files: string | string[], context: string): string[];
 /**
  * @param {string|string[]} patterns
  * @param {string|string[]} extensions

package/declarations/worker.d.ts

@@ -1,51 +1,3 @@
-/// <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 Stylelint = typeof import('stylelint');
 export type StylelintOptions = import('stylelint').LinterOptions;
 export type Options = import('./options').Options;

package/dist/index.js

@@ -7,8 +7,6 @@ exports.default = void 0;
 
 var _path = require("path");
 
-var _arrify = _interopRequireDefault(require("arrify"));
-
 var _globby = _interopRequireDefault(require("globby"));
 
 var _micromatch = require("micromatch");
@@ -21,7 +19,6 @@ var _utils = require("./utils");
 
 function _interopRequireDefault(obj) { return obj && obj.__esModule ? obj : { default: obj }; }
 
-// @ts-ignore
 // @ts-ignore
 
 /** @typedef {import('webpack').Compiler} Compiler */
@@ -43,8 +40,6 @@ 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();
   }
   /**
@@ -90,9 +85,10 @@ class StylelintWebpackPlugin {
     }
 
     const context = this.getContext(compiler);
+    const excludeDefault = ['**/node_modules/**', String(compiler.options.output.path)];
     const options = { ...this.options,
-      exclude: (0, _utils.parseFiles)(this.options.exclude || ['**/node_modules/**', compiler.options.output.path], context),
-      extensions: (0, _arrify.default)(this.options.extensions),
+      exclude: (0, _utils.parseFiles)(this.options.exclude || excludeDefault, context),
+      extensions: (0, _utils.arrify)(this.options.extensions),
       files: (0, _utils.parseFiles)(this.options.files || '', context)
     };
     const wanted = (0, _utils.parseFoldersToGlobs)(options.files, options.extensions);
@@ -119,7 +115,14 @@ class StylelintWebpackPlugin {
       }
 
       compilation.hooks.finishModules.tap(this.key, () => {
-        const files = this.getFiles(compiler, wanted, exclude);
+        const files = compiler.modifiedFiles ? Array.from(compiler.modifiedFiles).filter(file => (0, _micromatch.isMatch)(file, wanted, {
+          dot: true
+        }) && !(0, _micromatch.isMatch)(file, exclude, {
+          dot: true
+        })) : _globby.default.sync(wanted, {
+          dot: true,
+          ignore: exclude
+        });
 
         if (threads > 1) {
           for (const file of files) {
@@ -179,88 +182,6 @@ class StylelintWebpackPlugin {
 
     return this.options.context;
   }
-  /**
-   * @param {Compiler} compiler
-   * @param {string[]} wanted
-   * @param {string[]} exclude
-   * @returns {string[]}
-   */
-  // eslint-disable-next-line no-unused-vars
-
-
-  getFiles(compiler, wanted, exclude) {
-    // webpack 5
-    if (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).filter(file => (0, _micromatch.isMatch)(file, wanted, {
-        dot: true
-      }) && !(0, _micromatch.isMatch)(file, exclude, {
-        dot: true
-      }));
-    }
-
-    return _globby.default.sync(wanted, {
-      dot: true,
-      ignore: exclude
-    });
-  }
-  /**
-   * @param {ReadonlyMap<string, null | FileSystemInfoEntry | "ignore" | undefined>} fileTimestamps
-   * @returns {string[]}
-   */
-
-  /* istanbul ignore next */
-
-
-  getChangedFiles(fileTimestamps) {
-    /**
-     * @param {null | FileSystemInfoEntry | "ignore" | undefined} fileSystemInfoEntry
-     * @returns {Partial<number>}
-     */
-    const getTimestamps = fileSystemInfoEntry => {
-      // @ts-ignore
-      if (fileSystemInfoEntry && fileSystemInfoEntry.timestamp) {
-        // @ts-ignore
-        return fileSystemInfoEntry.timestamp;
-      } // @ts-ignore
-
-
-      return fileSystemInfoEntry;
-    };
-    /**
-     * @param {string} filename
-     * @param {null | FileSystemInfoEntry | "ignore" | undefined} fileSystemInfoEntry
-     * @returns {boolean}
-     */
-
-
-    const hasFileChanged = (filename, fileSystemInfoEntry) => {
-      const prevTimestamp = getTimestamps(this.prevTimestamps.get(filename));
-      const timestamp = getTimestamps(fileSystemInfoEntry);
-      return (prevTimestamp || this.startTime) < (timestamp || Infinity);
-    };
-
-    const changedFiles = [];
-
-    for (const [filename, timestamp] of fileTimestamps.entries()) {
-      if (hasFileChanged(filename, timestamp)) {
-        changedFiles.push(filename);
-      }
-    }
-
-    this.prevTimestamps = fileTimestamps;
-    return changedFiles;
-  }
 
 }
 

package/dist/linter.js

@@ -7,15 +7,13 @@ exports.default = linter;
 
 var _path = require("path");
 
-var _arrify = _interopRequireDefault(require("arrify"));
-
 var _StylelintError = _interopRequireDefault(require("./StylelintError"));
 
 var _getStylelint = _interopRequireDefault(require("./getStylelint"));
 
-function _interopRequireDefault(obj) { return obj && obj.__esModule ? obj : { default: obj }; }
+var _utils = require("./utils");
 
-// @ts-ignore
+function _interopRequireDefault(obj) { return obj && obj.__esModule ? obj : { default: obj }; }
 
 /** @typedef {import('stylelint')} Stylelint */
 
@@ -88,7 +86,7 @@ function linter(key, options, compilation) {
    */
 
   function lint(files) {
-    for (const file of (0, _arrify.default)(files)) {
+    for (const file of (0, _utils.arrify)(files)) {
       delete crossRunResultStorage[file];
     }
 
@@ -105,7 +103,7 @@ function linter(key, options, compilation) {
     await cleanup();
 
     for (const result of results) {
-      crossRunResultStorage[String(result.source)] = result;
+      crossRunResultStorage[result.source] = result;
     }
 
     results = Object.values(crossRunResultStorage); // do not analyze if there are no results or stylelint config

package/dist/utils.js

@@ -3,9 +3,10 @@
 Object.defineProperty(exports, "__esModule", {
   value: true
 });
-exports.jsonStringifyReplacerSortKeys = void 0;
+exports.arrify = arrify;
 exports.parseFiles = parseFiles;
 exports.parseFoldersToGlobs = parseFoldersToGlobs;
+exports.jsonStringifyReplacerSortKeys = void 0;
 
 var _path = require("path");
 
@@ -13,22 +14,60 @@ var _fs = require("fs");
 
 var _normalizePath = _interopRequireDefault(require("normalize-path"));
 
-var _arrify = _interopRequireDefault(require("arrify"));
-
 function _interopRequireDefault(obj) { return obj && obj.__esModule ? obj : { default: obj }; }
 
 // @ts-ignore
-// @ts-ignore
 
 /**
- * @param {string|(string|undefined)[]} files
+ * @template T
+ * @param {T} value
+ * @return {
+   T extends (null | undefined)
+     ? []
+     : T extends string
+       ? [string]
+       : T extends readonly unknown[]
+         ? T
+         : T extends Iterable<infer T>
+           ? T[]
+           : [T]
+ }
+ */
+function arrify(value) {
+  // eslint-disable-next-line no-undefined
+  if (value === null || value === undefined) {
+    // @ts-ignore
+    return [];
+  }
+
+  if (Array.isArray(value)) {
+    // @ts-ignore
+    return value;
+  }
+
+  if (typeof value === 'string') {
+    // @ts-ignore
+    return [value];
+  } // @ts-ignore
+
+
+  if (typeof value[Symbol.iterator] === 'function') {
+    // @ts-ignore
+    return [...value];
+  } // @ts-ignore
+
+
+  return [value];
+}
+/**
+ * @param {string|string[]} files
  * @param {string} context
  * @returns {string[]}
  */
+
+
 function parseFiles(files, context) {
-  return (0, _arrify.default)(files).filter((
-  /** @type {string} */
-  file) => typeof file === 'string').map((
+  return arrify(files).map((
   /** @type {string} */
   file) => (0, _normalizePath.default)((0, _path.resolve)(context, file)));
 }
@@ -40,12 +79,12 @@ function parseFiles(files, context) {
 
 
 function parseFoldersToGlobs(patterns, extensions = []) {
-  const extensionsList = (0, _arrify.default)(extensions);
+  const extensionsList = arrify(extensions);
   const [prefix, postfix] = extensionsList.length > 1 ? ['{', '}'] : ['', ''];
   const extensionsGlob = extensionsList.map((
   /** @type {string} */
   extension) => extension.replace(/^\./u, '')).join(',');
-  return (0, _arrify.default)(patterns).map((
+  return arrify(patterns).map((
   /** @type {string} */
   pattern) => {
     try {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "stylelint-webpack-plugin",
-  "version": "2.3.0",
+  "version": "3.0.1",
   "description": "A Stylelint plugin for webpack",
   "license": "MIT",
   "repository": "webpack-contrib/stylelint-webpack-plugin",
@@ -14,7 +14,7 @@
   "main": "dist/cjs.js",
   "types": "declarations/index.d.ts",
   "engines": {
-    "node": ">= 10.13.0"
+    "node": ">= 12.13.0"
   },
   "scripts": {
     "start": "npm run build -- -w",
@@ -42,50 +42,48 @@
     "declarations"
   ],
   "peerDependencies": {
-    "stylelint": "^13.0.0 || ^14.0.0",
-    "webpack": "^4.0.0 || ^5.0.0"
+    "stylelint": "^13.0.0",
+    "webpack": "^5.0.0"
   },
   "dependencies": {
-    "@types/stylelint": "^13.13.3",
-    "arrify": "^2.0.1",
-    "jest-worker": "^27.3.1",
+    "@types/stylelint": "^13.13.1",
+    "jest-worker": "^27.0.6",
     "globby": "^11.0.4",
     "micromatch": "^4.0.4",
     "normalize-path": "^3.0.0",
-    "schema-utils": "^3.1.1"
+    "schema-utils": "^3.1.0"
   },
   "devDependencies": {
-    "@babel/cli": "^7.16.0",
-    "@babel/core": "^7.16.0",
-    "@babel/preset-env": "^7.16.0",
+    "@babel/cli": "^7.14.5",
+    "@babel/core": "^7.14.6",
+    "@babel/preset-env": "^7.14.7",
     "@commitlint/cli": "^12.1.4",
     "@commitlint/config-conventional": "^12.1.4",
-    "@types/fs-extra": "^9.0.13",
+    "@types/fs-extra": "^9.0.12",
     "@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.3.1",
+    "babel-jest": "^27.0.6",
     "chokidar": "^3.5.2",
     "cross-env": "^7.0.3",
     "del": "^6.0.0",
-    "del-cli": "^3.0.1",
-    "eslint": "^7.32.0",
+    "del-cli": "^4.0.0",
+    "eslint": "^7.30.0",
     "eslint-config-prettier": "^8.3.0",
-    "eslint-plugin-import": "^2.25.2",
+    "eslint-plugin-import": "^2.23.4",
     "file-loader": "^6.2.0",
-    "fs-extra": "^9.1.0",
-    "husky": "^6.0.0",
-    "jest": "^27.3.1",
-    "lint-staged": "^10.5.4",
+    "fs-extra": "^10.0.0",
+    "husky": "^7.0.1",
+    "jest": "^27.0.6",
+    "lint-staged": "^11.0.0",
     "npm-run-all": "^4.1.5",
-    "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"
+    "prettier": "^2.3.2",
+    "standard-version": "^9.3.0",
+    "stylelint": "^13.13.1",
+    "typescript": "^4.3.5",
+    "webpack": "^5.44.0"
   },
   "keywords": [
     "stylelint",