stylelint-webpack-plugin 2.2.1 → 2.3.2

package/LICENSE

@@ -1,20 +1,20 @@
-Copyright JS Foundation and other contributors
-
-Permission is hereby granted, free of charge, to any person obtaining
-a copy of this software and associated documentation files (the
-'Software'), to deal in the Software without restriction, including
-without limitation the rights to use, copy, modify, merge, publish,
-distribute, sublicense, and/or sell copies of the Software, and to
-permit persons to whom the Software is furnished to do so, subject to
-the following conditions:
-
-The above copyright notice and this permission notice shall be
-included in all copies or substantial portions of the Software.
-
-THE SOFTWARE IS PROVIDED 'AS IS', WITHOUT WARRANTY OF ANY KIND,
-EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
-MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
-IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY
-CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
-TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE
-SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
+Copyright JS Foundation and other contributors
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+'Software'), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED 'AS IS', WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
+IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY
+CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
+TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE
+SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

package/README.md

@@ -1,197 +1,199 @@
-<div align="center">
-  <a href="https://github.com/stylelint/stylelint"><img width="200" height="200" src="https://cdn.worldvectorlogo.com/logos/stylelint.svg"></a>
-  <a href="https://github.com/webpack/webpack"><img width="200" height="200" src="https://webpack.js.org/assets/icon-square-big.svg"></a>
-</div>
-
-[![npm][npm]][npm-url]
-[![node][node]][node-url]
-[![deps][deps]][deps-url]
-[![tests][tests]][tests-url]
-[![coverage][cover]][cover-url]
-[![chat][chat]][chat-url]
-[![size][size]][size-url]
-
-# stylelint-webpack-plugin
-
-> A Stylelint plugin for webpack
-
-## Install
-
-```bash
-npm install stylelint-webpack-plugin --save-dev
-```
-
-**Note**: You also need to install `stylelint` from npm, if you haven't already:
-
-```bash
-npm install stylelint --save-dev
-```
-
-## Usage
-
-In your webpack configuration:
-
-```js
-const StylelintPlugin = require('stylelint-webpack-plugin');
-
-module.exports = {
-  // ...
-  plugins: [new StylelintPlugin(options)],
-  // ...
-};
-```
-
-## Options
-
-See [stylelint's options](http://stylelint.io/user-guide/node-api/#options) for the complete list of options available. These options are passed through to the `stylelint` directly.
-
-### `configFile`
-
-- Type: `String`
-- Default: `undefined`
-
-Specify the config file location to be used by `stylelint`.
-
-**Note:** By default this is [handled by `stylelint`](http://stylelint.io/user-guide/configuration/).
-
-### `context`
-
-- Type: `String`
-- Default: `compiler.context`
-
-A string indicating the root of your files.
-
-### `exclude`
-
-- Type: `String|Array[String]`
-- Default: `['node_modules', compiler.options.output.path]`
-
-Specify the files and/or directories to exclude. Must be relative to `options.context`.
-
-### `extensions`
-
-- Type: `String|Array[String]`
-- Default: `['css', 'scss', 'sass']`
-
-Specify extensions that should be checked.
-
-### `files`
-
-- Type: `String|Array[String]`
-- Default: `null`
-
-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`.
-
-### `fix`
-
-- Type: `Boolean`
-- Default: `false`
-
-If `true`, `stylelint` will fix as many errors as possible. The fixes are made to the actual source files. All unfixed errors will be reported. See [Autofixing errors](https://stylelint.io/user-guide/cli#autofixing-errors) docs.
-
-### `formatter`
-
-- Type: `String|Function`
-- Default: `'string'`
-
-Specify the formatter that you would like to use to format your results. See [formatter option](https://stylelint.io/user-guide/node-api#formatter).
-
-### `lintDirtyModulesOnly`
-
-- Type: `Boolean`
-- Default: `false`
-
-Lint only changed files, skip lint on start.
-
-### `stylelintPath`
-
-- Type: `String`
-- Default: `stylelint`
-
-Path to `stylelint` instance that will be used for linting.
-
-### `threads`
-
-- Type: `Boolean | Number`
-- Default: `false`
-
-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.
-
-### Errors and Warning
-
-**By default the plugin will auto adjust error reporting depending on stylelint errors/warnings counts.**
-You can still force this behavior by using `emitError` **or** `emitWarning` options:
-
-#### `emitError`
-
-- Type: `Boolean`
-- Default: `false`
-
-The errors found will always be emitted, to disable set to `false`.
-
-#### `emitWarning`
-
-- Type: `Boolean`
-- Default: `false`
-
-The warnings found will always be emitted, to disable set to `false`.
-
-#### `failOnError`
-
-- Type: `Boolean`
-- Default: `false`
-
-Will cause the module build to fail if there are any errors, to disable set to `false`.
-
-#### `failOnWarning`
-
-- Type: `Boolean`
-- Default: `false`
-
-Will cause the module build to fail if there are any warnings, if set to `true`.
-
-#### `quiet`
-
-- Type: `Boolean`
-- Default: `false`
-
-Will process and report errors only and ignore warnings, if set to `true`.
-
-#### `outputReport`
-
-- Type: `Boolean|Object`
-- Default: `false`
-
-Write the output of the errors to a file, for example a `json` file for use for reporting.
-The `filePath` is relative to the webpack config: `output.path`.
-You can pass in a different formatter for the output file, if none is passed in the default/configured formatter will be used.
-
-```js
-{
-  filePath: 'path/to/file';
-  formatter: 'json';
-}
-```
-
-## Changelog
-
-[Changelog](CHANGELOG.md)
-
-## License
-
-[MIT](./LICENSE)
-
-[npm]: https://img.shields.io/npm/v/stylelint-webpack-plugin.svg
-[npm-url]: https://npmjs.com/package/stylelint-webpack-plugin
-[node]: https://img.shields.io/node/v/stylelint-webpack-plugin.svg
-[node-url]: https://nodejs.org
-[deps]: https://david-dm.org/webpack-contrib/stylelint-webpack-plugin.svg
-[deps-url]: https://david-dm.org/webpack-contrib/stylelint-webpack-plugin
-[tests]: https://github.com/webpack-contrib/stylelint-webpack-plugin/workflows/stylelint-webpack-plugin/badge.svg
-[tests-url]: https://github.com/webpack-contrib/stylelint-webpack-plugin/actions
-[cover]: https://codecov.io/gh/webpack-contrib/stylelint-webpack-plugin/branch/master/graph/badge.svg
-[cover-url]: https://codecov.io/gh/webpack-contrib/stylelint-webpack-plugin
-[chat]: https://badges.gitter.im/webpack/webpack.svg
-[chat-url]: https://gitter.im/webpack/webpack
-[size]: https://packagephobia.now.sh/badge?p=stylelint-webpack-plugin
-[size-url]: https://packagephobia.now.sh/result?p=stylelint-webpack-plugin
+<div align="center">
+  <a href="https://github.com/stylelint/stylelint"><img width="200" height="200" src="https://cdn.worldvectorlogo.com/logos/stylelint.svg"></a>
+  <a href="https://github.com/webpack/webpack"><img width="200" height="200" src="https://webpack.js.org/assets/icon-square-big.svg"></a>
+</div>
+
+[![npm][npm]][npm-url]
+[![node][node]][node-url]
+[![deps][deps]][deps-url]
+[![tests][tests]][tests-url]
+[![coverage][cover]][cover-url]
+[![chat][chat]][chat-url]
+[![size][size]][size-url]
+
+# stylelint-webpack-plugin
+
+> A Stylelint plugin for webpack
+
+## Install
+
+```bash
+npm install stylelint-webpack-plugin@2 --save-dev
+```
+
+**Note**: You also need to install `stylelint` from npm, if you haven't already:
+
+```bash
+npm install stylelint --save-dev
+```
+
+**Note**: If you are using Stylelint 13 rather than 14+, you might also need to install `@types/stylelint` as a dev dependency if getting stylelint related type errors.
+
+## Usage
+
+In your webpack configuration:
+
+```js
+const StylelintPlugin = require('stylelint-webpack-plugin');
+
+module.exports = {
+  // ...
+  plugins: [new StylelintPlugin(options)],
+  // ...
+};
+```
+
+## Options
+
+See [stylelint's options](http://stylelint.io/user-guide/node-api/#options) for the complete list of options available. These options are passed through to the `stylelint` directly.
+
+### `configFile`
+
+- Type: `String`
+- Default: `undefined`
+
+Specify the config file location to be used by `stylelint`.
+
+**Note:** By default this is [handled by `stylelint`](http://stylelint.io/user-guide/configuration/).
+
+### `context`
+
+- Type: `String`
+- Default: `compiler.context`
+
+A string indicating the root of your files.
+
+### `exclude`
+
+- Type: `String|Array[String]`
+- Default: `['node_modules', compiler.options.output.path]`
+
+Specify the files and/or directories to exclude. Must be relative to `options.context`.
+
+### `extensions`
+
+- Type: `String|Array[String]`
+- Default: `['css', 'scss', 'sass']`
+
+Specify extensions that should be checked.
+
+### `files`
+
+- Type: `String|Array[String]`
+- Default: `null`
+
+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`.
+
+### `fix`
+
+- Type: `Boolean`
+- Default: `false`
+
+If `true`, `stylelint` will fix as many errors as possible. The fixes are made to the actual source files. All unfixed errors will be reported. See [Autofixing errors](https://stylelint.io/user-guide/cli#autofixing-errors) docs.
+
+### `formatter`
+
+- Type: `String|Function`
+- Default: `'string'`
+
+Specify the formatter that you would like to use to format your results. See [formatter option](https://stylelint.io/user-guide/node-api#formatter).
+
+### `lintDirtyModulesOnly`
+
+- Type: `Boolean`
+- Default: `false`
+
+Lint only changed files, skip lint on start.
+
+### `stylelintPath`
+
+- Type: `String`
+- Default: `stylelint`
+
+Path to `stylelint` instance that will be used for linting.
+
+### `threads`
+
+- Type: `Boolean | Number`
+- Default: `false`
+
+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.
+
+### Errors and Warning
+
+**By default the plugin will auto adjust error reporting depending on stylelint errors/warnings counts.**
+You can still force this behavior by using `emitError` **or** `emitWarning` options:
+
+#### `emitError`
+
+- Type: `Boolean`
+- Default: `false`
+
+The errors found will always be emitted, to disable set to `false`.
+
+#### `emitWarning`
+
+- Type: `Boolean`
+- Default: `false`
+
+The warnings found will always be emitted, to disable set to `false`.
+
+#### `failOnError`
+
+- Type: `Boolean`
+- Default: `false`
+
+Will cause the module build to fail if there are any errors, to disable set to `false`.
+
+#### `failOnWarning`
+
+- Type: `Boolean`
+- Default: `false`
+
+Will cause the module build to fail if there are any warnings, if set to `true`.
+
+#### `quiet`
+
+- Type: `Boolean`
+- Default: `false`
+
+Will process and report errors only and ignore warnings, if set to `true`.
+
+#### `outputReport`
+
+- Type: `Boolean|Object`
+- Default: `false`
+
+Write the output of the errors to a file, for example a `json` file for use for reporting.
+The `filePath` is relative to the webpack config: `output.path`.
+You can pass in a different formatter for the output file, if none is passed in the default/configured formatter will be used.
+
+```js
+{
+  filePath: 'path/to/file';
+  formatter: 'json';
+}
+```
+
+## Changelog
+
+[Changelog](CHANGELOG.md)
+
+## License
+
+[MIT](./LICENSE)
+
+[npm]: https://img.shields.io/npm/v/stylelint-webpack-plugin/2x.svg
+[npm-url]: https://npmjs.com/package/stylelint-webpack-plugin/v/2x
+[node]: https://img.shields.io/node/v/stylelint-webpack-plugin/2x.svg
+[node-url]: https://nodejs.org
+[deps]: https://david-dm.org/webpack-contrib/stylelint-webpack-plugin.svg
+[deps-url]: https://david-dm.org/webpack-contrib/stylelint-webpack-plugin
+[tests]: https://github.com/webpack-contrib/stylelint-webpack-plugin/workflows/stylelint-webpack-plugin/badge.svg?branch=2.x
+[tests-url]: https://github.com/webpack-contrib/stylelint-webpack-plugin/actions
+[cover]: https://codecov.io/gh/webpack-contrib/stylelint-webpack-plugin/branch/2.x/graph/badge.svg
+[cover-url]: https://codecov.io/gh/webpack-contrib/stylelint-webpack-plugin/branch/2.x
+[chat]: https://badges.gitter.im/webpack/webpack.svg
+[chat-url]: https://gitter.im/webpack/webpack
+[size]: https://packagephobia.now.sh/badge?p=stylelint-webpack-plugin
+[size-url]: https://packagephobia.now.sh/result?p=stylelint-webpack-plugin

package/declarations/getStylelint.d.ts

@@ -1,3 +1,4 @@
+/// <reference types="stylelint" />
 /**
  * @param {string|undefined} key
  * @param {Options} options
@@ -7,7 +8,52 @@ export default function getStylelint(
   key: string | undefined,
   { threads, ...options }: Options
 ): Linter;
-export type Stylelint = typeof import('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 LintResult = import('stylelint').LintResult;
 export type Options = import('./options').Options;
 export type AsyncTask = () => Promise<void>;

package/declarations/index.d.ts

@@ -20,7 +20,11 @@ declare class StylelintWebpackPlugin {
    */
   run(compiler: Compiler): Promise<void>;
   startTime: number;
-  prevTimestamps: Map<any, any>;
+  /** @type {ReadonlyMap<string, null | FileSystemInfoEntry | "ignore" | undefined>} */
+  prevTimestamps: ReadonlyMap<
+    string,
+    'ignore' | FileSystemInfoEntry | null | undefined
+  >;
   /**
    * @param {Compiler} compiler
    * @returns {void}
@@ -40,10 +44,13 @@ declare class StylelintWebpackPlugin {
    */
   getFiles(compiler: Compiler, wanted: string[], exclude: string[]): string[];
   /**
-   * @param {Map<string, null | FileSystemInfoEntry | "ignore">} fileTimestamps
+   * @param {ReadonlyMap<string, null | FileSystemInfoEntry | "ignore" | undefined>} fileTimestamps
    * @returns {string[]}
    */
   getChangedFiles(
-    fileTimestamps: Map<string, 'ignore' | FileSystemInfoEntry | null>
+    fileTimestamps: ReadonlyMap<
+      string,
+      'ignore' | FileSystemInfoEntry | null | undefined
+    >
   ): string[];
 }

package/declarations/linter.d.ts

@@ -1,3 +1,4 @@
+/// <reference types="stylelint" />
 /**
  * @param {string|undefined} key
  * @param {Options} options
@@ -13,7 +14,52 @@ export default function linter(
   report: Reporter;
   threads: number;
 };
-export type Stylelint = typeof import('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 LintResult = import('stylelint').LintResult;
 export type Compiler = import('webpack').Compiler;
 export type Compilation = import('webpack').Compilation;

package/declarations/options.d.ts

@@ -1,3 +1,4 @@
+/// <reference types="stylelint" />
 /** @typedef {import("stylelint")} stylelint */
 /** @typedef {import("stylelint").LinterOptions} StylelintOptions */
 /** @typedef {import("stylelint").FormatterType} FormatterType */
@@ -36,7 +37,52 @@ export function getOptions(pluginOptions: Options): Partial<PluginOptions>;
 export function getStylelintOptions(
   pluginOptions: Options
 ): Partial<StylelintOptions>;
-export type stylelint = typeof import('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 FormatterType = import('stylelint').FormatterType;
 export type OutputReport = {