stylelint-webpack-plugin 2.3.2 → 2.5.0

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" }]
+    }
+  }
+}

package/dist/utils.js

@@ -1,86 +1,66 @@
 "use strict";
 
-Object.defineProperty(exports, "__esModule", {
-  value: true
-});
-exports.jsonStringifyReplacerSortKeys = void 0;
-exports.parseFiles = parseFiles;
-exports.parseFoldersToGlobs = parseFoldersToGlobs;
-
-var _path = require("path");
-
-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
- * @param {string} context
- * @returns {string[]}
+const {
+  resolve
+} = require('path');
+const {
+  statSync
+} = require('fs');
+const normalizePath = require('normalize-path');
+const arrify = require('arrify');
+
+/**
+ * @param {string|(string|undefined)[]} files
+ * @param {string} context
+ * @returns {string[]}
  */
 function parseFiles(files, context) {
-  return (0, _arrify.default)(files).filter((
-  /** @type {string} */
-  file) => typeof file === 'string').map((
-  /** @type {string} */
-  file) => (0, _normalizePath.default)((0, _path.resolve)(context, file)));
+  return arrify(files).filter(file => typeof file === 'string').map(file => normalizePath(resolve(context, file || '')));
 }
-/**
- * @param {string|string[]} patterns
- * @param {string|string[]} extensions
- * @returns {string[]}
- */
-
 
+/**
+ * @param {string|string[]} patterns
+ * @param {string|string[]} extensions
+ * @returns {string[]}
+ */
 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((
-  /** @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 = (0, _fs.statSync)(pattern);
+      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
- */
-
 
+/**
+ *
+ * @param {string} _ key, but unused
+ * @param {any} value
+ */
 const jsonStringifyReplacerSortKeys = (_, value) => {
-  /**
-   * @param {{ [x: string]: any; }} sorted
-   * @param {string | number} key
+  /**
+   * @param {{ [x: string]: any; }} sorted
+   * @param {string | number} key
    */
   const insert = (sorted, key) => {
     // eslint-disable-next-line no-param-reassign
     sorted[key] = value[key];
     return sorted;
   };
-
   return value instanceof Object && !(value instanceof Array) ? Object.keys(value).sort().reduce(insert, {}) : value;
 };
-
-exports.jsonStringifyReplacerSortKeys = jsonStringifyReplacerSortKeys;
+module.exports = {
+  parseFiles,
+  parseFoldersToGlobs,
+  jsonStringifyReplacerSortKeys
+};

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
- */
 
+/**
+ * @param {Options} options
+ * @param {Partial<StylelintOptions>} stylelintOptions
+ */
 function setup(options, stylelintOptions) {
   stylelint = require(options.stylelintPath || 'stylelint');
   linterOptions = stylelintOptions;
   return stylelint;
 }
-/**
- * @param {string | string[]} files
- */
-
 
+/**
+ * @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,

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "stylelint-webpack-plugin",
-  "version": "2.3.2",
+  "version": "2.5.0",
   "description": "A Stylelint plugin for webpack",
   "license": "MIT",
   "repository": "webpack-contrib/stylelint-webpack-plugin",
@@ -11,16 +11,16 @@
     "type": "opencollective",
     "url": "https://opencollective.com/webpack"
   },
-  "main": "dist/cjs.js",
-  "types": "declarations/index.d.ts",
+  "main": "dist/index.js",
+  "types": "types/index.d.ts",
   "engines": {
     "node": ">= 10.13.0"
   },
   "scripts": {
     "start": "npm run build -- -w",
-    "clean": "del-cli dist declarations",
+    "clean": "del-cli dist types",
     "prebuild": "npm run clean",
-    "build:types": "tsc --declaration --emitDeclarationOnly --outDir declarations && prettier \"declarations/**/*.ts\" --write",
+    "build:types": "tsc --declaration --emitDeclarationOnly --outDir types && prettier \"types/**/*.ts\" --write",
     "build:code": "cross-env NODE_ENV=production babel src -d dist --copy-files",
     "build": "npm-run-all -p \"build:**\"",
     "commitlint": "commitlint --from=master",
@@ -39,52 +39,52 @@
   },
   "files": [
     "dist",
-    "declarations"
+    "types"
   ],
   "peerDependencies": {
-    "stylelint": "^13.0.0 || ^14.0.0",
+    "stylelint": "^13.0.0 || ^14.0.0 || ^15.0.0",
     "webpack": "^4.0.0 || ^5.0.0"
   },
   "dependencies": {
     "arrify": "^2.0.1",
-    "globby": "^11.0.4",
-    "jest-worker": "^27.3.1",
-    "micromatch": "^4.0.4",
+    "globby": "^11.1.0",
+    "jest-worker": "^28.1.3",
+    "micromatch": "^4.0.5",
     "normalize-path": "^3.0.0",
     "schema-utils": "^3.1.1"
   },
   "devDependencies": {
-    "@babel/cli": "^7.16.0",
-    "@babel/core": "^7.16.0",
-    "@babel/preset-env": "^7.16.0",
-    "@commitlint/cli": "^12.1.4",
-    "@commitlint/config-conventional": "^12.1.4",
+    "@babel/cli": "^7.21.0",
+    "@babel/core": "^7.21.0",
+    "@babel/preset-env": "^7.20.2",
+    "@commitlint/cli": "^16.2.4",
+    "@commitlint/config-conventional": "^16.2.4",
     "@types/fs-extra": "^9.0.13",
     "@types/micromatch": "^4.0.2",
+    "@types/node": "^18.14.6",
     "@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",
-    "chokidar": "^3.5.2",
+    "babel-jest": "^28.1.3",
     "cross-env": "^7.0.3",
-    "del": "^6.0.0",
+    "del": "^6.1.1",
     "del-cli": "^3.0.1",
     "eslint": "^7.32.0",
-    "eslint-config-prettier": "^8.3.0",
-    "eslint-plugin-import": "^2.25.2",
+    "eslint-config-prettier": "^8.7.0",
+    "eslint-plugin-import": "^2.27.5",
     "file-loader": "^6.2.0",
     "fs-extra": "^9.1.0",
     "husky": "^6.0.0",
-    "jest": "^27.3.1",
-    "lint-staged": "^10.5.4",
+    "jest": "^28.1.3",
+    "lint-staged": "^11.2.6",
     "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.8.4",
+    "standard-version": "^9.5.0",
+    "stylelint": "^15.2.0",
+    "typescript": "^4.9.5",
+    "webpack": "^5.76.0"
   },
   "keywords": [
     "stylelint",

package/types/StylelintError.d.ts

@@ -0,0 +1,8 @@
+export = StylelintError;
+declare class StylelintError extends Error {
+  /**
+   * @param {string=} messages
+   */
+  constructor(messages?: string | undefined);
+  stack: string;
+}

package/types/getStylelint.d.ts

@@ -0,0 +1,56 @@
+/// <reference types="stylelint" />
+export = getStylelint;
+/**
+ * @param {string|undefined} key
+ * @param {Options} options
+ * @returns {Linter}
+ */
+declare function getStylelint(
+  key: string | undefined,
+  { threads, ...options }: Options
+): Linter;
+declare namespace getStylelint {
+  export {
+    Stylelint,
+    LintResult,
+    LinterOptions,
+    LinterResult,
+    Formatter,
+    FormatterType,
+    Options,
+    isPathIgnored,
+    AsyncTask,
+    LintTask,
+    Linter,
+    Worker,
+  };
+}
+type Options = import('./options').Options;
+type Linter = {
+  stylelint: Stylelint;
+  isPathIgnored: isPathIgnored;
+  lintFiles: LintTask;
+  cleanup: AsyncTask;
+  threads: number;
+};
+type Stylelint = {
+  lint: (options: LinterOptions) => Promise<LinterResult>;
+  formatters: {
+    [k: string]: import('stylelint').Formatter;
+  };
+};
+type LintResult = import('stylelint').LintResult;
+type LinterOptions = import('stylelint').LinterOptions;
+type LinterResult = import('stylelint').LinterResult;
+type Formatter = import('stylelint').Formatter;
+type FormatterType = import('stylelint').FormatterType;
+type isPathIgnored = (
+  stylelint: Stylelint,
+  filePath: string
+) => Promise<boolean>;
+type AsyncTask = () => Promise<void>;
+type LintTask = (files: string | string[]) => Promise<LintResult[]>;
+type Worker = JestWorker & {
+  lintFiles: LintTask;
+};
+import { Worker as JestWorker } from 'jest-worker';

package/{declarations → types}/index.d.ts

@@ -1,13 +1,4 @@
-export default StylelintWebpackPlugin;
-export type Compiler = import('webpack').Compiler;
-export type Module = import('webpack').Module;
-export type Options = import('./options').Options;
-export type FileSystemInfoEntry = Partial<
-  | {
-      timestamp: number;
-    }
-  | number
->;
+export = StylelintWebpackPlugin;
 declare class StylelintWebpackPlugin {
   /**
    * @param {Options} options
@@ -17,8 +8,16 @@ declare class StylelintWebpackPlugin {
   options: Partial<import('./options').PluginOptions>;
   /**
    * @param {Compiler} compiler
+   * @param {Options} options
+   * @param {string[]} wanted
+   * @param {string[]} exclude
    */
-  run(compiler: Compiler): Promise<void>;
+  run(
+    compiler: Compiler,
+    options: Options,
+    wanted: string[],
+    exclude: string[]
+  ): Promise<void>;
   startTime: number;
   /** @type {ReadonlyMap<string, null | FileSystemInfoEntry | "ignore" | undefined>} */
   prevTimestamps: ReadonlyMap<
@@ -54,3 +53,15 @@ declare class StylelintWebpackPlugin {
     >
   ): string[];
 }
+declare namespace StylelintWebpackPlugin {
+  export { Compiler, Module, Options, FileSystemInfoEntry };
+}
+type Compiler = import('webpack').Compiler;
+type Options = import('./options').Options;
+type FileSystemInfoEntry = Partial<
+  | {
+      timestamp: number;
+    }
+  | number
+>;
+type Module = import('webpack').Module;

package/types/linter.d.ts

@@ -0,0 +1,59 @@
+/// <reference types="stylelint" />
+export = linter;
+/**
+ * @param {string|undefined} key
+ * @param {Options} options
+ * @param {Compilation} compilation
+ * @returns {{stylelint: Stylelint, isPathIgnored: isPathIgnored, lint: Linter, report: Reporter, threads: number}}
+ */
+declare function linter(
+  key: string | undefined,
+  options: Options,
+  compilation: Compilation
+): {
+  stylelint: Stylelint;
+  isPathIgnored: getStylelint.isPathIgnored;
+  lint: Linter;
+  report: Reporter;
+  threads: number;
+};
+declare namespace linter {
+  export {
+    Compiler,
+    Compilation,
+    Stylelint,
+    LintResult,
+    LinterResult,
+    Formatter,
+    FormatterType,
+    isPathIgnored,
+    Options,
+    GenerateReport,
+    Report,
+    Reporter,
+    Linter,
+    LintResultMap,
+  };
+}
+type Options = import('./options').Options;
+type Compilation = import('webpack').Compilation;
+type Stylelint = import('./getStylelint').Stylelint;
+type Linter = (files: string | string[]) => void;
+type Reporter = () => Promise<Report>;
+import getStylelint = require('./getStylelint');
+type Compiler = import('webpack').Compiler;
+type LintResult = import('./getStylelint').LintResult;
+type LinterResult = import('./getStylelint').LinterResult;
+type Formatter = import('./getStylelint').Formatter;
+type FormatterType = import('./getStylelint').FormatterType;
+type isPathIgnored = import('./getStylelint').isPathIgnored;
+type GenerateReport = (compilation: Compilation) => Promise<void>;
+type Report = {
+  errors?: StylelintError;
+  warnings?: StylelintError;
+  generateReportAsset?: GenerateReport;
+};
+type LintResultMap = {
+  [files: string]: import('stylelint').LintResult;
+};
+import StylelintError = require('./StylelintError');