stylelint-webpack-plugin 2.3.2 → 3.1.1

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 */
@@ -35,21 +32,19 @@ 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}
    */
 
 
@@ -73,8 +68,8 @@ class StylelintWebpackPlugin {
       return this.run(c);
     });
   }
-  /**
-   * @param {Compiler} compiler
+  /**
+   * @param {Compiler} compiler
    */
 
 
@@ -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) {
@@ -161,10 +164,10 @@ class StylelintWebpackPlugin {
       }
     });
   }
-  /**
-   *
-   * @param {Compiler} compiler
-   * @returns {string}
+  /**
+   *
+   * @param {Compiler} compiler
+   * @returns {string}
    */
 
 
@@ -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 */
 
@@ -43,11 +41,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,12 +81,12 @@ function linter(key, options, compilation) {
     report,
     threads
   };
-  /**
-   * @param {string | string[]} files
+  /**
+   * @param {string | string[]} files
    */
 
   function lint(files) {
-    for (const file of (0, _arrify.default)(files)) {
+    for (const file of (0, _utils.arrify)(files)) {
       delete crossRunResultStorage[file];
     }
 
@@ -124,9 +122,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 +133,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 +175,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 +199,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[]}}
  */
 
 
@@ -236,10 +234,10 @@ function parseResults(options, results) {
     warnings
   };
 }
-/**
- * @param {Stylelint} stylelint
- * @param {FormatterType=} formatter
- * @returns {FormatterFunction}
+/**
+ * @param {Stylelint} stylelint
+ * @param {FormatterType=} formatter
+ * @returns {FormatterFunction}
  */
 
 
@@ -257,33 +255,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" }]
+    }
+  }
+}