stylelint-webpack-plugin 1.2.3 → 2.2.0

package/dist/index.js

@@ -7,9 +7,13 @@ exports.default = void 0;
 
 var _path = require("path");
 
-var _getOptions = _interopRequireDefault(require("./getOptions"));
+var _arrify = _interopRequireDefault(require("arrify"));
 
-var _LintDirtyModulesPlugin = _interopRequireDefault(require("./LintDirtyModulesPlugin"));
+var _fastGlob = _interopRequireDefault(require("fast-glob"));
+
+var _micromatch = require("micromatch");
+
+var _options = require("./options");
 
 var _linter = _interopRequireDefault(require("./linter"));
 
@@ -17,54 +21,279 @@ var _utils = require("./utils");
 
 function _interopRequireDefault(obj) { return obj && obj.__esModule ? obj : { default: obj }; }
 
+// @ts-ignore
+// @ts-ignore
+
+/** @typedef {import('webpack').Compiler} Compiler */
+
+/** @typedef {import('webpack').Module} Module */
+
+/** @typedef {import('./options').Options} Options */
+
+/** @typedef {Partial<{timestamp:number} | number>} FileSystemInfoEntry */
+const STYLELINT_PLUGIN = 'StylelintWebpackPlugin';
+let counter = 0;
+
 class StylelintWebpackPlugin {
+  /**
+   * @param {Options} options
+   */
   constructor(options = {}) {
-    this.options = (0, _getOptions.default)(options);
+    this.key = STYLELINT_PLUGIN;
+    this.options = (0, _options.getOptions)(options);
+    this.run = this.run.bind(this);
+    this.startTime = Date.now();
+    this.prevTimestamps = new Map();
   }
+  /**
+   * @param {Compiler} compiler
+   * @returns {void}
+   */
+
 
   apply(compiler) {
-    const options = { ...this.options,
-      files: (0, _utils.parseFiles)(this.options.files, this.getContext(compiler))
-    }; // eslint-disable-next-line
+    // Generate key for each compilation,
+    // this differentiates one from the other when being cached.
+    this.key = compiler.name || `${this.key}_${counter += 1}`; // If `lintDirtyModulesOnly` is disabled,
+    // execute the linter on the build
+
+    if (!this.options.lintDirtyModulesOnly) {
+      compiler.hooks.run.tapPromise(this.key, this.run);
+    }
 
-    const {
-      lint
-    } = require(options.stylelintPath);
+    let isFirstRun = this.options.lintDirtyModulesOnly;
+    compiler.hooks.watchRun.tapPromise(this.key, c => {
+      if (isFirstRun) {
+        isFirstRun = false;
+        return Promise.resolve();
+      }
 
-    const plugin = {
-      name: this.constructor.name
-    };
+      return this.run(c);
+    });
+  }
+  /**
+   * @param {Compiler} compiler
+   */
+
+
+  async run(compiler) {
+    // Do not re-hook
 
-    if (options.lintDirtyModulesOnly) {
-      const lintDirty = new _LintDirtyModulesPlugin.default(lint, compiler, options);
-      /* istanbul ignore next */
-
-      compiler.hooks.watchRun.tapAsync(plugin, (compilation, callback) => {
-        lintDirty.apply(compilation, callback);
-      });
-    } else {
-      compiler.hooks.run.tapAsync(plugin, (compilation, callback) => {
-        (0, _linter.default)(lint, options, compilation, callback);
-      });
-      /* istanbul ignore next */
-
-      compiler.hooks.watchRun.tapAsync(plugin, (compilation, callback) => {
-        (0, _linter.default)(lint, options, compilation, callback);
-      });
+    /* istanbul ignore if */
+    if ( // @ts-ignore
+    compiler.hooks.thisCompilation.taps.find(({
+      name
+    }) => name === this.key)) {
+      return;
     }
+
+    const context = this.getContext(compiler);
+    const options = { ...this.options,
+      exclude: (0, _utils.parseFiles)(this.options.exclude || [], 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/**', []);
+    compiler.hooks.thisCompilation.tap(this.key, compilation => {
+      /** @type {import('./linter').Linter} */
+      let lint;
+      /** @type {import('./linter').Reporter} */
+
+      let report;
+      /** @type number */
+
+      let threads;
+
+      try {
+        ({
+          lint,
+          report,
+          threads
+        } = (0, _linter.default)(this.key, options, compilation));
+      } catch (e) {
+        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);
+
+          if (threads > 1) {
+            lint((0, _utils.parseFiles)(file, context));
+          }
+        }
+      }); // Lint all files added
+
+      compilation.hooks.finishModules.tap(this.key, () => {
+        if (files.length > 0 && threads <= 1) {
+          lint((0, _utils.parseFiles)(files, context));
+        }
+      }); // await and interpret results
+
+      compilation.hooks.additionalAssets.tapPromise(this.key, processResults);
+
+      async function processResults() {
+        const {
+          errors,
+          warnings,
+          generateReportAsset
+        } = await report();
+
+        if (warnings && !options.failOnWarning) {
+          // @ts-ignore
+          compilation.warnings.push(warnings);
+        } else if (warnings && options.failOnWarning) {
+          // @ts-ignore
+          compilation.errors.push(warnings);
+        }
+
+        if (errors && options.failOnError) {
+          // @ts-ignore
+          compilation.errors.push(errors);
+        } else if (errors && !options.failOnError) {
+          // @ts-ignore
+          compilation.warnings.push(errors);
+        }
+
+        if (generateReportAsset) {
+          await generateReportAsset(compilation);
+        }
+      }
+    });
   }
+  /**
+   *
+   * @param {Compiler} compiler
+   * @returns {string}
+   */
+
 
   getContext(compiler) {
     if (!this.options.context) {
-      return compiler.options.context;
+      return String(compiler.options.context);
     }
 
     if (!(0, _path.isAbsolute)(this.options.context)) {
-      return (0, _path.join)(compiler.options.context, this.options.context);
+      return (0, _path.join)(String(compiler.options.context), this.options.context);
     }
 
     return this.options.context;
   }
+  /**
+   * @param {string[]} glob
+   * @param {Compiler} compiler
+   * @param {Module} module
+   * @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);
+      }
+    }
+    */
+    // webpack 5
+    if (compiler.modifiedFiles) {
+      return Array.from(compiler.modifiedFiles);
+    } // webpack 4
+
+    /* istanbul ignore next */
+
+
+    if (compiler.fileTimestamps && compiler.fileTimestamps.size > 0) {
+      return this.getChangedFiles(compiler.fileTimestamps);
+    }
+
+    return _fastGlob.default.sync(glob, {
+      dot: true
+    });
+  }
+  /**
+   * @param {Map<string, null | FileSystemInfoEntry | "ignore">} fileTimestamps
+   * @returns {string[]}
+   */
+
+  /* istanbul ignore next */
+
+
+  getChangedFiles(fileTimestamps) {
+    /**
+     * @param {null | FileSystemInfoEntry | "ignore"} 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"} 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

@@ -5,65 +5,195 @@ Object.defineProperty(exports, "__esModule", {
 });
 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 }; }
 
-function linter(lint, options, compiler, callback) {
-  let errors = [];
-  let warnings = [];
-  lint(options).then(({
-    results
-  }) => {
+// @ts-ignore
+
+/** @typedef {import('stylelint')} Stylelint */
+
+/** @typedef {import('stylelint').LintResult} LintResult */
+
+/** @typedef {import('webpack').Compiler} Compiler */
+
+/** @typedef {import('webpack').Compilation} Compilation */
+
+/** @typedef {import('./options').Options} Options */
+
+/** @typedef {import('./options').FormatterType} FormatterType */
+
+/** @typedef {((results: LintResult[]) => string)} FormatterFunction */
+
+/** @typedef {(compilation: Compilation) => Promise<void>} GenerateReport */
+
+/** @typedef {{errors?: StylelintError, warnings?: StylelintError, generateReportAsset?: GenerateReport}} Report */
+
+/** @typedef {() => Promise<Report>} Reporter */
+
+/** @typedef {(files: string|string[]) => void} Linter */
+
+/** @typedef {{[files: string]: LintResult}} LintResultMap */
+
+/** @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}}
+ */
+
+function linter(key, options, compilation) {
+  /** @type {Stylelint} */
+  let stylelint;
+  /** @type {(files: string|string[]) => Promise<LintResult[]>} */
+
+  let lintFiles;
+  /** @type {() => Promise<void>} */
+
+  let cleanup;
+  /** @type number */
+
+  let threads;
+  /** @type {Promise<LintResult[]>[]} */
+
+  const rawResults = [];
+  const crossRunResultStorage = getResultStorage(compilation);
+
+  try {
     ({
+      stylelint,
+      lintFiles,
+      cleanup,
+      threads
+    } = (0, _getStylelint.default)(key, options));
+  } catch (e) {
+    throw new _StylelintError.default(e.message);
+  }
+
+  return {
+    lint,
+    report,
+    threads
+  };
+  /**
+   * @param {string | string[]} files
+   */
+
+  function lint(files) {
+    for (const file of (0, _arrify.default)(files)) {
+      delete crossRunResultStorage[file];
+    }
+
+    rawResults.push(lintFiles(files).catch(e => {
+      compilation.errors.push(e);
+      return [];
+    }));
+  }
+
+  async function report() {
+    // Filter out ignored files.
+    let results = removeIgnoredWarnings( // Get the current results, resetting the rawResults to empty
+    await flatten(rawResults.splice(0, rawResults.length)));
+    await cleanup();
+
+    for (const result of results) {
+      crossRunResultStorage[result.source] = result;
+    }
+
+    results = Object.values(crossRunResultStorage); // do not analyze if there are no results or stylelint config
+
+    if (!results || results.length < 1) {
+      return {};
+    }
+
+    const formatter = loadFormatter(stylelint, options.formatter);
+    const {
       errors,
       warnings
-    } = parseResults(options, results));
-    compiler.hooks.afterEmit.tapAsync('StylelintWebpackPlugin', (compilation, next) => {
-      if (warnings.length) {
-        compilation.warnings.push(_StylelintError.default.format(options, warnings));
-        warnings = [];
-      }
+    } = formatResults(formatter, parseResults(options, results));
+    return {
+      errors,
+      warnings,
+      generateReportAsset
+    };
+    /**
+     * @param {Compilation} compilation
+     * @returns {Promise<void>}
+     */
+
+    async function generateReportAsset({
+      compiler
+    }) {
+      const {
+        outputReport
+      } = options;
+      /**
+       * @param {string} name
+       * @param {string | Buffer} content
+       */
 
-      if (errors.length) {
-        compilation.errors.push(_StylelintError.default.format(options, errors));
-        errors = [];
+      const save = (name, content) =>
+      /** @type {Promise<void>} */
+      new Promise((finish, bail) => {
+        const {
+          mkdir,
+          writeFile
+        } = compiler.outputFileSystem; // ensure directory exists
+        // @ts-ignore - the types for `outputFileSystem` are missing the 3 arg overload
+
+        mkdir((0, _path.dirname)(name), {
+          recursive: true
+        }, err => {
+          /* istanbul ignore if */
+          if (err) bail(err);else writeFile(name, content, err2 => {
+            /* istanbul ignore if */
+            if (err2) bail(err2);else finish();
+          });
+        });
+      });
+
+      if (!outputReport || !outputReport.filePath) {
+        return;
       }
 
-      next();
-    });
+      const content = outputReport.formatter ? loadFormatter(stylelint, outputReport.formatter)(results) : formatter(results);
+      let {
+        filePath
+      } = outputReport;
 
-    if (options.failOnError && errors.length) {
-      callback(_StylelintError.default.format(options, errors));
-    } else if (options.failOnWarning && warnings.length) {
-      callback(_StylelintError.default.format(options, warnings));
-    } else {
-      callback();
+      if (!(0, _path.isAbsolute)(filePath)) {
+        filePath = (0, _path.join)(compiler.outputPath, filePath);
+      }
+
+      await save(filePath, content);
     }
-  }).catch(e => {
-    compiler.hooks.afterEmit.tapAsync('StylelintWebpackPlugin', (compilation, next) => {
-      compilation.errors.push(new _StylelintError.default(e.message));
-      next();
-    });
-    callback();
-  });
+  }
 }
+/**
+ * @param {FormatterFunction} formatter
+ * @param {{ errors: LintResult[]; warnings: LintResult[]; }} results
+ * @returns {{errors?: StylelintError, warnings?: StylelintError}}
+ */
 
-function parseResults(options, results) {
-  let errors = [];
-  let warnings = [];
-
-  if (options.emitError) {
-    errors = results.filter(file => fileHasErrors(file) || fileHasWarnings(file));
-  } else if (options.emitWarning) {
-    warnings = results.filter(file => fileHasErrors(file) || fileHasWarnings(file));
-  } else {
-    warnings = results.filter(file => !fileHasErrors(file) && fileHasWarnings(file));
-    errors = results.filter(fileHasErrors);
+
+function formatResults(formatter, results) {
+  let errors;
+  let warnings;
+
+  if (results.warnings.length > 0) {
+    warnings = new _StylelintError.default(formatter(results.warnings));
   }
 
-  if (options.quiet && warnings.length) {
-    warnings = [];
+  if (results.errors.length > 0) {
+    errors = new _StylelintError.default(formatter(results.errors));
   }
 
   return {
@@ -71,11 +201,122 @@ function parseResults(options, results) {
     warnings
   };
 }
+/**
+ * @param {Options} options
+ * @param {LintResult[]} results
+ * @returns {{errors: LintResult[], warnings: LintResult[]}}
+ */
+
+
+function parseResults(options, results) {
+  /** @type {LintResult[]} */
+  const errors = [];
+  /** @type {LintResult[]} */
+
+  const warnings = [];
+  results.forEach(file => {
+    if (fileHasErrors(file)) {
+      const messages = file.warnings.filter(message => options.emitError && message.severity === 'error');
+
+      if (messages.length > 0) {
+        errors.push({ ...file,
+          warnings: messages
+        });
+      }
+    }
+
+    if (fileHasWarnings(file)) {
+      const messages = file.warnings.filter(message => options.emitWarning && message.severity === 'warning');
+
+      if (messages.length > 0) {
+        warnings.push({ ...file,
+          warnings: messages
+        });
+      }
+    }
+  });
+  return {
+    errors,
+    warnings
+  };
+}
+/**
+ * @param {LintResult} file
+ * @returns {boolean}
+ */
+
 
 function fileHasErrors(file) {
-  return file.errored;
+  return !!file.errored;
 }
+/**
+ * @param {LintResult} file
+ * @returns {boolean}
+ */
+
 
 function fileHasWarnings(file) {
-  return file.warnings && file.warnings.length;
+  return file.warnings && file.warnings.length > 0;
+}
+/**
+ * @param {Stylelint} stylelint
+ * @param {FormatterType=} formatter
+ * @returns {FormatterFunction}
+ */
+
+
+function loadFormatter(stylelint, formatter) {
+  if (typeof formatter === 'function') {
+    return formatter;
+  }
+
+  if (typeof formatter === 'string') {
+    try {
+      return stylelint.formatters[formatter];
+    } catch (_) {// Load the default formatter.
+    }
+  }
+
+  return stylelint.formatters.string;
+}
+/**
+ * @param {LintResult[]} results
+ * @returns {LintResult[]}
+ */
+
+
+function removeIgnoredWarnings(results) {
+  return results.filter(result => !result.ignored);
+}
+/**
+ * @param {Promise<LintResult[]>[]} results
+ * @returns {Promise<LintResult[]>}
+ */
+
+
+async function flatten(results) {
+  /**
+   * @param {LintResult[]} acc
+   * @param {LintResult[]} list
+   */
+  const flat = (acc, list) => [...acc, ...list];
+
+  return (await Promise.all(results)).reduce(flat, []);
+}
+/**
+ * @param {Compilation} compilation
+ * @returns {LintResultMap}
+ */
+
+
+function getResultStorage({
+  compiler
+}) {
+  let storage = resultStorage.get(compiler);
+
+  if (!storage) {
+    resultStorage.set(compiler, storage = {});
+  }
+
+  return storage;
 }