stylelint-webpack-plugin 3.3.0 → 4.1.0

package/dist/linter.js

@@ -5,75 +5,59 @@ const {
   isAbsolute,
   join
 } = require('path');
-
 const StylelintError = require('./StylelintError');
-
 const getStylelint = require('./getStylelint');
-
 const {
   arrify
 } = require('./utils');
-/** @typedef {import('stylelint')} Stylelint */
-
-/** @typedef {import('stylelint').LintResult} LintResult */
-
-/** @typedef {import('stylelint').InternalApi} InternalApi */
 
 /** @typedef {import('webpack').Compiler} Compiler */
-
 /** @typedef {import('webpack').Compilation} Compilation */
-
+/** @typedef {import('./getStylelint').Stylelint} Stylelint */
+/** @typedef {import('./getStylelint').LintResult} LintResult */
+/** @typedef {import('./getStylelint').LinterResult} LinterResult */
+/** @typedef {import('./getStylelint').Formatter} Formatter */
+/** @typedef {import('./getStylelint').FormatterType} FormatterType */
+/** @typedef {import('./getStylelint').isPathIgnored} isPathIgnored */
 /** @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 {{api: InternalApi, lint: Linter, report: Reporter, threads: number}}
+ * @returns {{stylelint: Stylelint, isPathIgnored: isPathIgnored, lint: Linter, report: Reporter, threads: number}}
  */
-
 function linter(key, options, compilation) {
   /** @type {Stylelint} */
   let stylelint;
-  /** @type {InternalApi} */
 
-  let api;
-  /** @type {(files: string|string[]) => Promise<LintResult[]>} */
+  /** @type {isPathIgnored} */
+  let isPathIgnored;
 
+  /** @type {(files: string|string[]) => Promise<LintResult[]>} */
   let lintFiles;
-  /** @type {() => Promise<void>} */
 
+  /** @type {() => Promise<void>} */
   let cleanup;
-  /** @type number */
 
+  /** @type number */
   let threads;
-  /** @type {Promise<LintResult[]>[]} */
 
+  /** @type {Promise<LintResult[]>[]} */
   const rawResults = [];
   const crossRunResultStorage = getResultStorage(compilation);
-
   try {
     ({
       stylelint,
-      api,
+      isPathIgnored,
       lintFiles,
       cleanup,
       threads
@@ -81,60 +65,68 @@ function linter(key, options, compilation) {
   } catch (e) {
     throw new StylelintError(e.message);
   }
-
   return {
+    stylelint,
     lint,
-    api,
+    isPathIgnored,
     report,
     threads
   };
+
   /**
    * @param {string | string[]} files
    */
-
   function lint(files) {
     for (const file of arrify(files)) {
       delete crossRunResultStorage[file];
     }
-
     rawResults.push(lintFiles(files).catch(e => {
       // @ts-ignore
       compilation.errors.push(new StylelintError(e.message));
       return [];
     }));
   }
-
   async function report() {
     // Filter out ignored files.
-    let results = removeIgnoredWarnings( // Get the current results, resetting the rawResults to empty
+    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[String(result.source)] = result;
     }
+    results = Object.values(crossRunResultStorage);
 
-    results = Object.values(crossRunResultStorage); // do not analyze if there are no results or stylelint config
-
+    // do not analyze if there are no results or stylelint config
     if (!results || results.length < 1) {
       return {};
     }
-
     const formatter = loadFormatter(stylelint, options.formatter);
+
+    /** @type {LinterResult} */
+    const returnValue = {
+      // @ts-ignore
+      cwd: options.cwd,
+      errored: false,
+      results: [],
+      output: '',
+      reportedDisables: [],
+      ruleMetadata: getRuleMetadata(results)
+    };
     const {
       errors,
       warnings
-    } = formatResults(formatter, parseResults(options, results));
+    } = formatResults(formatter, parseResults(options, results), returnValue);
     return {
       errors,
       warnings,
       generateReportAsset
     };
+
     /**
      * @param {Compilation} compilation
      * @returns {Promise<void>}
      */
-
     async function generateReportAsset({
       compiler
     }) {
@@ -145,16 +137,14 @@ function linter(key, options, compilation) {
        * @param {string} name
        * @param {string | Buffer} content
        */
-
-      const save = (name, content) =>
-      /** @type {Promise<void>} */
+      const save = (name, content) => /** @type {Promise<void>} */
       new Promise((finish, bail) => {
         const {
           mkdir,
           writeFile
-        } = compiler.outputFileSystem; // ensure directory exists
+        } = compiler.outputFileSystem;
+        // ensure directory exists
         // @ts-ignore - the types for `outputFileSystem` are missing the 3 arg overload
-
         mkdir(dirname(name), {
           recursive: true
         }, err => {
@@ -165,74 +155,67 @@ function linter(key, options, compilation) {
           });
         });
       });
-
       if (!outputReport || !outputReport.filePath) {
         return;
       }
-
-      const content = outputReport.formatter ? loadFormatter(stylelint, outputReport.formatter)(results) : formatter(results);
+      const content = outputReport.formatter;
+      loadFormatter(stylelint, outputReport.formatter)(results, returnValue);
+      formatter(results, returnValue);
       let {
         filePath
       } = outputReport;
-
       if (!isAbsolute(filePath)) {
         filePath = join(compiler.outputPath, filePath);
       }
-
-      await save(filePath, content);
+      await save(filePath, String(content));
     }
   }
 }
+
 /**
- * @param {FormatterFunction} formatter
+ * @param {Formatter} formatter
  * @param {{ errors: LintResult[]; warnings: LintResult[]; }} results
+ * @param {LinterResult} returnValue
  * @returns {{errors?: StylelintError, warnings?: StylelintError}}
  */
-
-
-function formatResults(formatter, results) {
+function formatResults(formatter, results, returnValue) {
   let errors;
   let warnings;
-
   if (results.warnings.length > 0) {
-    warnings = new StylelintError(formatter(results.warnings));
+    warnings = new StylelintError(formatter(results.warnings, returnValue));
   }
-
   if (results.errors.length > 0) {
-    errors = new StylelintError(formatter(results.errors));
+    errors = new StylelintError(formatter(results.errors, returnValue));
   }
-
   return {
     errors,
     warnings
   };
 }
+
 /**
  * @param {Options} options
  * @param {LintResult[]} results
  * @returns {{errors: LintResult[], warnings: LintResult[]}}
  */
-
-
 function parseResults(options, results) {
   /** @type {LintResult[]} */
   const errors = [];
-  /** @type {LintResult[]} */
 
+  /** @type {LintResult[]} */
   const warnings = [];
   results.forEach(file => {
     const fileErrors = file.warnings.filter(message => options.emitError && message.severity === 'error');
-
     if (fileErrors.length > 0) {
-      errors.push({ ...file,
+      errors.push({
+        ...file,
         warnings: fileErrors
       });
     }
-
     const fileWarnings = file.warnings.filter(message => options.emitWarning && message.severity === 'warning');
-
     if (fileWarnings.length > 0) {
-      warnings.push({ ...file,
+      warnings.push({
+        ...file,
         warnings: fileWarnings
       });
     }
@@ -242,67 +225,75 @@ function parseResults(options, results) {
     warnings
   };
 }
+
 /**
  * @param {Stylelint} stylelint
  * @param {FormatterType=} formatter
- * @returns {FormatterFunction}
+ * @returns {Formatter}
  */
-
-
 function loadFormatter(stylelint, formatter) {
   if (typeof formatter === 'function') {
     return formatter;
   }
-
   if (typeof formatter === 'string') {
     try {
       return stylelint.formatters[formatter];
-    } catch (_) {// Load the default 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;
 }
 
+/**
+ * @param {LintResult[]} lintResults
+ */
+/* istanbul ignore next */
+function getRuleMetadata(lintResults) {
+  const [lintResult] = lintResults;
+
+  // eslint-disable-next-line no-undefined
+  if (lintResult === undefined) return {};
+
+  // eslint-disable-next-line no-underscore-dangle, no-undefined
+  if (lintResult._postcssResult === undefined) return {};
+
+  // eslint-disable-next-line no-underscore-dangle
+  return lintResult._postcssResult.stylelint.ruleMetadata;
+}
 module.exports = linter;

package/dist/options.js

@@ -3,13 +3,10 @@
 const {
   validate
 } = require('schema-utils');
-
 const schema = require('./options.json');
-/** @typedef {import("stylelint")} stylelint */
-
-/** @typedef {import("stylelint").LinterOptions} StylelintOptions */
 
-/** @typedef {import("stylelint").FormatterType} FormatterType */
+/** @typedef {import('./getStylelint').LinterOptions} StylelintOptions */
+/** @typedef {import('./getStylelint').FormatterType} FormatterType */
 
 /**
  * @typedef {Object} OutputReport
@@ -41,8 +38,6 @@ const schema = require('./options.json');
  * @param {Options} pluginOptions
  * @returns {Partial<PluginOptions>}
  */
-
-
 function getOptions(pluginOptions) {
   const options = {
     extensions: ['css', 'scss', 'sass'],
@@ -54,39 +49,40 @@ function getOptions(pluginOptions) {
       emitError: true,
       emitWarning: false
     } : {})
-  }; // @ts-ignore
+  };
 
+  // @ts-ignore
   validate(schema, options, {
     name: 'Stylelint Webpack Plugin',
     baseDataPath: 'options'
   });
   return options;
 }
+
 /**
  * @param {Options} pluginOptions
  * @returns {Partial<StylelintOptions>}
  */
-
-
 function getStylelintOptions(pluginOptions) {
-  const stylelintOptions = { ...pluginOptions
-  }; // Keep the files and formatter option because it is common to both the plugin and Stylelint.
+  const stylelintOptions = {
+    ...pluginOptions
+  };
 
+  // Keep the files and formatter option because it is common to both the plugin and Stylelint.
   const {
     files,
     formatter,
     ...stylelintOnlyOptions
-  } = schema.properties; // No need to guard the for-in because schema.properties has hardcoded keys.
-  // eslint-disable-next-line guard-for-in
+  } = schema.properties;
 
+  // No need to guard the for-in because schema.properties has hardcoded keys.
+  // eslint-disable-next-line guard-for-in
   for (const option in stylelintOnlyOptions) {
     // @ts-ignore
     delete stylelintOptions[option];
   }
-
   return stylelintOptions;
 }
-
 module.exports = {
   getOptions,
   getStylelintOptions

package/dist/options.json

@@ -31,7 +31,7 @@
       "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`.",
+      "description": "Specify directories, files, or globs. Must be relative to `options.context`. Directories are traversed recursively looking for files matching `options.extensions`. File and glob patterns ignore `options.extensions`.",
       "anyOf": [{ "type": "string" }, { "type": "array" }]
     },
     "formatter": {

package/dist/utils.js

@@ -3,12 +3,11 @@
 const {
   resolve
 } = require('path');
-
 const {
   statSync
 } = require('fs');
-
 const normalizePath = require('normalize-path');
+
 /**
  * @template T
  * @param {T} value
@@ -24,85 +23,70 @@ const normalizePath = require('normalize-path');
            : [T]
  }
  */
-
 /* istanbul ignore next */
-
-
 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
-
+  }
 
+  // @ts-ignore
   if (typeof value[Symbol.iterator] === 'function') {
     // @ts-ignore
     return [...value];
-  } // @ts-ignore
-
+  }
 
+  // @ts-ignore
   return [value];
 }
+
 /**
  * @param {string|string[]} files
  * @param {string} context
  * @returns {string[]}
  */
-
-
 function parseFiles(files, context) {
-  return arrify(files).map((
-  /** @type {string} */
-  file) => normalizePath(resolve(context, file)));
+  return arrify(files).map(( /** @type {string} */file) => normalizePath(resolve(context, file)));
 }
+
 /**
  * @param {string|string[]} patterns
  * @param {string|string[]} extensions
  * @returns {string[]}
  */
-
-
 function parseFoldersToGlobs(patterns, extensions = []) {
   const extensionsList = arrify(extensions);
   const [prefix, postfix] = extensionsList.length > 1 ? ['{', '}'] : ['', ''];
-  const extensionsGlob = extensionsList.map((
-  /** @type {string} */
-  extension) => extension.replace(/^\./u, '')).join(',');
-  return arrify(patterns).map((
-  /** @type {string} */
-  pattern) => {
+  const extensionsGlob = extensionsList.map(( /** @type {string} */extension) => extension.replace(/^\./u, '')).join(',');
+  return arrify(patterns).map(( /** @type {string} */pattern) => {
     try {
       // The patterns are absolute because they are prepended with the context.
       const stats = statSync(pattern);
       /* istanbul ignore else */
-
       if (stats.isDirectory()) {
         return pattern.replace(/[/\\]*?$/u, `/**${extensionsGlob ? `/*.${prefix + extensionsGlob + postfix}` : ''}`);
       }
-    } catch (_) {// Return the pattern as is on error.
+    } catch (_) {
+      // Return the pattern as is on error.
     }
-
     return pattern;
   });
 }
+
 /**
  *
  * @param {string} _ key, but unused
  * @param {any} value
  */
-
-
 const jsonStringifyReplacerSortKeys = (_, value) => {
   /**
    * @param {{ [x: string]: any; }} sorted
@@ -113,10 +97,8 @@ const jsonStringifyReplacerSortKeys = (_, value) => {
     sorted[key] = value[key];
     return sorted;
   };
-
   return value instanceof Object && !(value instanceof Array) ? Object.keys(value).sort().reduce(insert, {}) : value;
 };
-
 module.exports = {
   arrify,
   parseFiles,

package/dist/worker.js

@@ -1,42 +1,42 @@
 "use strict";
 
-/** @typedef {import('stylelint')} Stylelint */
-
-/** @typedef {import("stylelint").LinterOptions} StylelintOptions */
-
+/** @typedef {import('./getStylelint').Stylelint} Stylelint */
+/** @typedef {import('./getStylelint').LinterOptions} StylelintOptions */
 /** @typedef {import('./options').Options} Options */
+
 Object.assign(module.exports, {
   lintFiles,
   setup
 });
-/** @type {Stylelint} */
 
+/** @type {Stylelint} */
 let stylelint;
-/** @type {Partial<StylelintOptions>} */
 
+/** @type {Partial<StylelintOptions>} */
 let linterOptions;
+
 /**
  * @param {Options} options
  * @param {Partial<StylelintOptions>} stylelintOptions
  */
-
 function setup(options, stylelintOptions) {
   stylelint = require(options.stylelintPath || 'stylelint');
   linterOptions = stylelintOptions;
   return stylelint;
 }
+
 /**
  * @param {string | string[]} files
  */
-
-
 async function lintFiles(files) {
   const {
     results
-  } = await stylelint.lint({ ...linterOptions,
+  } = await stylelint.lint({
+    ...linterOptions,
     files
-  }); // Reset result to work with worker
+  });
 
+  // Reset result to work with worker
   return results.map(result => {
     return {
       source: result.source,