stylelint-webpack-plugin 2.2.1 → 2.3.2

package/declarations/worker.d.ts

@@ -1,3 +1,49 @@
-export type Stylelint = typeof import('stylelint');
+/// <reference types="stylelint" />
+export type Stylelint = import('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('postcss').Root;
+      },
+      callback: (warning: import('postcss').Warning) => void
+    ) => void;
+  };
+};
 export type StylelintOptions = import('stylelint').LinterOptions;
 export type Options = import('./options').Options;

package/dist/StylelintError.js

@@ -6,8 +6,8 @@ Object.defineProperty(exports, "__esModule", {
 exports.default = void 0;
 
 class StylelintError extends Error {
-  /**
-   * @param {string=} messages
+  /**
+   * @param {string=} messages
    */
   constructor(messages) {
     super(messages);

package/dist/getStylelint.js

@@ -33,9 +33,9 @@ const cache = {};
 
 /** @typedef {{stylelint: Stylelint, lintFiles: LintTask, cleanup: AsyncTask, threads: number, }} Linter */
 
-/**
- * @param {Options} options
- * @returns {Linter}
+/**
+ * @param {Options} options
+ * @returns {Linter}
  */
 
 function loadStylelint(options) {
@@ -47,11 +47,11 @@ function loadStylelint(options) {
     threads: 1
   };
 }
-/**
- * @param {string|undefined} key
- * @param {number} poolSize
- * @param {Options} options
- * @returns {Linter}
+/**
+ * @param {string|undefined} key
+ * @param {number} poolSize
+ * @param {Options} options
+ * @returns {Linter}
  */
 
 
@@ -94,10 +94,10 @@ function loadStylelintThreaded(key, poolSize, options) {
   };
   return context;
 }
-/**
- * @param {string|undefined} key
- * @param {Options} options
- * @returns {Linter}
+/**
+ * @param {string|undefined} key
+ * @param {Options} options
+ * @returns {Linter}
  */
 
 
@@ -117,10 +117,10 @@ function getStylelint(key, {
 
   return cache[cacheKey];
 }
-/**
- * @param {string|undefined} key
- * @param {Options} options
- * @returns {string}
+/**
+ * @param {string|undefined} key
+ * @param {Options} options
+ * @returns {string}
  */
 
 

package/dist/index.js

@@ -35,19 +35,21 @@ const STYLELINT_PLUGIN = 'StylelintWebpackPlugin';
 let counter = 0;
 
 class StylelintWebpackPlugin {
-  /**
-   * @param {Options} options
+  /**
+   * @param {Options} options
    */
   constructor(options = {}) {
     this.key = STYLELINT_PLUGIN;
     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();
   }
-  /**
-   * @param {Compiler} compiler
-   * @returns {void}
+  /**
+   * @param {Compiler} compiler
+   * @returns {void}
    */
 
 
@@ -71,8 +73,8 @@ class StylelintWebpackPlugin {
       return this.run(c);
     });
   }
-  /**
-   * @param {Compiler} compiler
+  /**
+   * @param {Compiler} compiler
    */
 
 
@@ -159,10 +161,10 @@ class StylelintWebpackPlugin {
       }
     });
   }
-  /**
-   *
-   * @param {Compiler} compiler
-   * @returns {string}
+  /**
+   *
+   * @param {Compiler} compiler
+   * @returns {string}
    */
 
 
@@ -177,11 +179,11 @@ class StylelintWebpackPlugin {
 
     return this.options.context;
   }
-  /**
-   * @param {Compiler} compiler
-   * @param {string[]} wanted
-   * @param {string[]} exclude
-   * @returns {string[]}
+  /**
+   * @param {Compiler} compiler
+   * @param {string[]} wanted
+   * @param {string[]} exclude
+   * @returns {string[]}
    */
   // eslint-disable-next-line no-unused-vars
 
@@ -212,18 +214,18 @@ class StylelintWebpackPlugin {
       ignore: exclude
     });
   }
-  /**
-   * @param {Map<string, null | FileSystemInfoEntry | "ignore">} fileTimestamps
-   * @returns {string[]}
+  /**
+   * @param {ReadonlyMap<string, null | FileSystemInfoEntry | "ignore" | undefined>} fileTimestamps
+   * @returns {string[]}
    */
 
   /* istanbul ignore next */
 
 
   getChangedFiles(fileTimestamps) {
-    /**
-     * @param {null | FileSystemInfoEntry | "ignore"} fileSystemInfoEntry
-     * @returns {Partial<number>}
+    /**
+     * @param {null | FileSystemInfoEntry | "ignore" | undefined} fileSystemInfoEntry
+     * @returns {Partial<number>}
      */
     const getTimestamps = fileSystemInfoEntry => {
       // @ts-ignore
@@ -235,10 +237,10 @@ class StylelintWebpackPlugin {
 
       return fileSystemInfoEntry;
     };
-    /**
-     * @param {string} filename
-     * @param {null | FileSystemInfoEntry | "ignore"} fileSystemInfoEntry
-     * @returns {boolean}
+    /**
+     * @param {string} filename
+     * @param {null | FileSystemInfoEntry | "ignore" | undefined} fileSystemInfoEntry
+     * @returns {boolean}
      */
 
 

package/dist/linter.js

@@ -43,11 +43,11 @@ function _interopRequireDefault(obj) { return obj && obj.__esModule ? obj : { de
 
 /** @type {WeakMap<Compiler, LintResultMap>} */
 const resultStorage = new WeakMap();
-/**
- * @param {string|undefined} key
- * @param {Options} options
- * @param {Compilation} compilation
- * @returns {{lint: Linter, report: Reporter, threads: number}}
+/**
+ * @param {string|undefined} key
+ * @param {Options} options
+ * @param {Compilation} compilation
+ * @returns {{lint: Linter, report: Reporter, threads: number}}
  */
 
 function linter(key, options, compilation) {
@@ -83,8 +83,8 @@ function linter(key, options, compilation) {
     report,
     threads
   };
-  /**
-   * @param {string | string[]} files
+  /**
+   * @param {string | string[]} files
    */
 
   function lint(files) {
@@ -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
@@ -124,9 +124,9 @@ function linter(key, options, compilation) {
       warnings,
       generateReportAsset
     };
-    /**
-     * @param {Compilation} compilation
-     * @returns {Promise<void>}
+    /**
+     * @param {Compilation} compilation
+     * @returns {Promise<void>}
      */
 
     async function generateReportAsset({
@@ -135,9 +135,9 @@ function linter(key, options, compilation) {
       const {
         outputReport
       } = options;
-      /**
-       * @param {string} name
-       * @param {string | Buffer} content
+      /**
+       * @param {string} name
+       * @param {string | Buffer} content
        */
 
       const save = (name, content) =>
@@ -177,10 +177,10 @@ function linter(key, options, compilation) {
     }
   }
 }
-/**
- * @param {FormatterFunction} formatter
- * @param {{ errors: LintResult[]; warnings: LintResult[]; }} results
- * @returns {{errors?: StylelintError, warnings?: StylelintError}}
+/**
+ * @param {FormatterFunction} formatter
+ * @param {{ errors: LintResult[]; warnings: LintResult[]; }} results
+ * @returns {{errors?: StylelintError, warnings?: StylelintError}}
  */
 
 
@@ -201,10 +201,10 @@ function formatResults(formatter, results) {
     warnings
   };
 }
-/**
- * @param {Options} options
- * @param {LintResult[]} results
- * @returns {{errors: LintResult[], warnings: LintResult[]}}
+/**
+ * @param {Options} options
+ * @param {LintResult[]} results
+ * @returns {{errors: LintResult[], warnings: LintResult[]}}
  */
 
 
@@ -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,28 +236,10 @@ 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
- * @returns {FormatterFunction}
+/**
+ * @param {Stylelint} stylelint
+ * @param {FormatterType=} formatter
+ * @returns {FormatterFunction}
  */
 
 
@@ -279,33 +257,33 @@ function loadFormatter(stylelint, formatter) {
 
   return stylelint.formatters.string;
 }
-/**
- * @param {LintResult[]} results
- * @returns {LintResult[]}
+/**
+ * @param {LintResult[]} results
+ * @returns {LintResult[]}
  */
 
 
 function removeIgnoredWarnings(results) {
   return results.filter(result => !result.ignored);
 }
-/**
- * @param {Promise<LintResult[]>[]} results
- * @returns {Promise<LintResult[]>}
+/**
+ * @param {Promise<LintResult[]>[]} results
+ * @returns {Promise<LintResult[]>}
  */
 
 
 async function flatten(results) {
-  /**
-   * @param {LintResult[]} acc
-   * @param {LintResult[]} list
+  /**
+   * @param {LintResult[]} acc
+   * @param {LintResult[]} list
    */
   const flat = (acc, list) => [...acc, ...list];
 
   return (await Promise.all(results)).reduce(flat, []);
 }
-/**
- * @param {Compilation} compilation
- * @returns {LintResultMap}
+/**
+ * @param {Compilation} compilation
+ * @returns {LintResultMap}
  */
 
 

package/dist/options.js

@@ -20,35 +20,35 @@ function _interopRequireDefault(obj) { return obj && obj.__esModule ? obj : { de
 
 /** @typedef {import("stylelint").FormatterType} FormatterType */
 
-/**
- * @typedef {Object} OutputReport
- * @property {string=} filePath
- * @property {FormatterType=} formatter
+/**
+ * @typedef {Object} OutputReport
+ * @property {string=} filePath
+ * @property {FormatterType=} formatter
  */
 
-/**
- * @typedef {Object} PluginOptions
- * @property {string} context
- * @property {boolean} emitError
- * @property {boolean} emitWarning
- * @property {string|string[]=} exclude
- * @property {string|string[]} extensions
- * @property {boolean} failOnError
- * @property {boolean} failOnWarning
- * @property {string|string[]} files
- * @property {FormatterType} formatter
- * @property {boolean} lintDirtyModulesOnly
- * @property {boolean} quiet
- * @property {string} stylelintPath
- * @property {OutputReport} outputReport
- * @property {number|boolean=} threads
+/**
+ * @typedef {Object} PluginOptions
+ * @property {string} context
+ * @property {boolean} emitError
+ * @property {boolean} emitWarning
+ * @property {string|string[]=} exclude
+ * @property {string|string[]} extensions
+ * @property {boolean} failOnError
+ * @property {boolean} failOnWarning
+ * @property {string|string[]} files
+ * @property {FormatterType} formatter
+ * @property {boolean} lintDirtyModulesOnly
+ * @property {boolean} quiet
+ * @property {string} stylelintPath
+ * @property {OutputReport} outputReport
+ * @property {number|boolean=} threads
  */
 
 /** @typedef {Partial<PluginOptions & StylelintOptions>} Options */
 
-/**
- * @param {Options} pluginOptions
- * @returns {Partial<PluginOptions>}
+/**
+ * @param {Options} pluginOptions
+ * @returns {Partial<PluginOptions>}
  */
 function getOptions(pluginOptions) {
   const options = {
@@ -69,9 +69,9 @@ function getOptions(pluginOptions) {
   });
   return options;
 }
-/**
- * @param {Options} pluginOptions
- * @returns {Partial<StylelintOptions>}
+/**
+ * @param {Options} pluginOptions
+ * @returns {Partial<StylelintOptions>}
  */
 
 

package/dist/options.json

@@ -1,80 +1,80 @@
-{
-  "type": "object",
-  "additionalProperties": true,
-  "properties": {
-    "context": {
-      "description": "A string indicating the root of your files.",
-      "type": "string"
-    },
-    "emitError": {
-      "description": "The errors found will always be emitted, to disable set to `false`.",
-      "type": "boolean"
-    },
-    "emitWarning": {
-      "description": "The warnings found will always be emitted, to disable set to `false`.",
-      "type": "boolean"
-    },
-    "exclude": {
-      "description": "Specify the files and/or directories to exclude. Must be relative to `options.context`.",
-      "anyOf": [{ "type": "string" }, { "type": "array" }]
-    },
-    "extensions": {
-      "description": "Specify extensions that should be checked.",
-      "anyOf": [{ "type": "string" }, { "type": "array" }]
-    },
-    "failOnError": {
-      "description": "Will cause the module build to fail if there are any errors, to disable set to `false`.",
-      "type": "boolean"
-    },
-    "failOnWarning": {
-      "description": "Will cause the module build to fail if there are any warnings, if set to `true`.",
-      "type": "boolean"
-    },
-    "files": {
-      "description": "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`.",
-      "anyOf": [{ "type": "string" }, { "type": "array" }]
-    },
-    "formatter": {
-      "description": "Specify the formatter that you would like to use to format your results.",
-      "anyOf": [{ "type": "string" }, { "instanceof": "Function" }]
-    },
-    "lintDirtyModulesOnly": {
-      "description": "Lint only changed files, skip lint on start.",
-      "type": "boolean"
-    },
-    "quiet": {
-      "description": "Will process and report errors only and ignore warnings, if set to `true`.",
-      "type": "boolean"
-    },
-    "stylelintPath": {
-      "description": "Path to `stylelint` instance that will be used for linting.",
-      "type": "string"
-    },
-    "outputReport": {
-      "description": "Write the output of the errors to a file, for example a `json` file for use for reporting.",
-      "anyOf": [
-        {
-          "type": "boolean"
-        },
-        {
-          "type": "object",
-          "additionalProperties": false,
-          "properties": {
-            "filePath": {
-              "description": "The `filePath` is relative to the webpack config: `output.path`.",
-              "anyOf": [{ "type": "string" }]
-            },
-            "formatter": {
-              "description": "You can pass in a different formatter for the output file, if none is passed in the default/configured formatter will be used.",
-              "anyOf": [{ "type": "string" }, { "instanceof": "Function" }]
-            }
-          }
-        }
-      ]
-    },
-    "threads": {
-      "description": "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.",
-      "anyOf": [{ "type": "number" }, { "type": "boolean" }]
-    }
-  }
-}
+{
+  "type": "object",
+  "additionalProperties": true,
+  "properties": {
+    "context": {
+      "description": "A string indicating the root of your files.",
+      "type": "string"
+    },
+    "emitError": {
+      "description": "The errors found will always be emitted, to disable set to `false`.",
+      "type": "boolean"
+    },
+    "emitWarning": {
+      "description": "The warnings found will always be emitted, to disable set to `false`.",
+      "type": "boolean"
+    },
+    "exclude": {
+      "description": "Specify the files and/or directories to exclude. Must be relative to `options.context`.",
+      "anyOf": [{ "type": "string" }, { "type": "array" }]
+    },
+    "extensions": {
+      "description": "Specify extensions that should be checked.",
+      "anyOf": [{ "type": "string" }, { "type": "array" }]
+    },
+    "failOnError": {
+      "description": "Will cause the module build to fail if there are any errors, to disable set to `false`.",
+      "type": "boolean"
+    },
+    "failOnWarning": {
+      "description": "Will cause the module build to fail if there are any warnings, if set to `true`.",
+      "type": "boolean"
+    },
+    "files": {
+      "description": "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`.",
+      "anyOf": [{ "type": "string" }, { "type": "array" }]
+    },
+    "formatter": {
+      "description": "Specify the formatter that you would like to use to format your results.",
+      "anyOf": [{ "type": "string" }, { "instanceof": "Function" }]
+    },
+    "lintDirtyModulesOnly": {
+      "description": "Lint only changed files, skip lint on start.",
+      "type": "boolean"
+    },
+    "quiet": {
+      "description": "Will process and report errors only and ignore warnings, if set to `true`.",
+      "type": "boolean"
+    },
+    "stylelintPath": {
+      "description": "Path to `stylelint` instance that will be used for linting.",
+      "type": "string"
+    },
+    "outputReport": {
+      "description": "Write the output of the errors to a file, for example a `json` file for use for reporting.",
+      "anyOf": [
+        {
+          "type": "boolean"
+        },
+        {
+          "type": "object",
+          "additionalProperties": false,
+          "properties": {
+            "filePath": {
+              "description": "The `filePath` is relative to the webpack config: `output.path`.",
+              "anyOf": [{ "type": "string" }]
+            },
+            "formatter": {
+              "description": "You can pass in a different formatter for the output file, if none is passed in the default/configured formatter will be used.",
+              "anyOf": [{ "type": "string" }, { "instanceof": "Function" }]
+            }
+          }
+        }
+      ]
+    },
+    "threads": {
+      "description": "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.",
+      "anyOf": [{ "type": "number" }, { "type": "boolean" }]
+    }
+  }
+}