stylelint-webpack-plugin 2.3.2 → 3.1.1

package/README.md

@@ -1,199 +1,201 @@
-<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
+<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
+
+> This is stylelint-webpack-plugin 3.0 which works only with webpack 5. For the webpack 4, see the [2.x branch](https://github.com/webpack-contrib/stylelint-webpack-plugin/tree/2.x).
+
+This plugin uses [`stylelint`](https://stylelint.io/) that helps you avoid errors and enforce conventions in your styles.
+
+## Getting Started
+
+To begin, you'll need to install `stylelint-webpack-plugin`:
+
+```bash
+npm install stylelint-webpack-plugin --save-dev
+```
+
+**Note**: You also need to install `stylelint >= 13` 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.
+
+Then add the plugin to your webpack config. For example:
+
+```js
+const StylelintPlugin = require('stylelint-webpack-plugin');
+
+module.exports = {
+  // ...
+  plugins: [new StylelintPlugin(options)],
+  // ...
+};
+```
+
+## Options
+
+See [stylelint's options](https://stylelint.io/user-guide/usage/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`](https://stylelint.io/user-guide/configure).
+
+### `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/usage/options#fix) 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/usage/options#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: `true`
+
+The errors found will always be emitted, to disable set to `false`.
+
+#### `emitWarning`
+
+- Type: `Boolean`
+- Default: `true`
+
+The warnings found will always be emitted, to disable set to `false`.
+
+#### `failOnError`
+
+- Type: `Boolean`
+- Default: `true`
+
+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

package/declarations/getStylelint.d.ts

@@ -58,13 +58,12 @@ export type LintResult = import('stylelint').LintResult;
 export type Options = import('./options').Options;
 export type AsyncTask = () => Promise<void>;
 export type LintTask = (files: string | string[]) => Promise<LintResult[]>;
-export type Worker = JestWorker & {
-  lintFiles: LintTask;
-};
 export type Linter = {
   stylelint: Stylelint;
   lintFiles: LintTask;
   cleanup: AsyncTask;
   threads: number;
 };
-import { Worker as JestWorker } from 'jest-worker';
+export type Worker = import('jest-worker').Worker & {
+  lintFiles: LintTask;
+};

package/declarations/index.d.ts

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

package/declarations/utils.d.ts

@@ -1,12 +1,35 @@
 /**
- * @param {string|(string|undefined)[]} files
+ * @template T
+ * @param {T} value
+ * @return {
+   T extends (null | undefined)
+     ? []
+     : T extends string
+       ? [string]
+       : T extends readonly unknown[]
+         ? T
+         : T extends Iterable<infer T>
+           ? T[]
+           : [T]
+ }
+ */
+export function arrify<T>(
+  value: T
+): T extends null | undefined
+  ? []
+  : T extends string
+  ? [string]
+  : T extends readonly unknown[]
+  ? T
+  : T extends Iterable<infer T_1>
+  ? T_1[]
+  : [T];
+/**
+ * @param {string|string[]} files
  * @param {string} context
  * @returns {string[]}
  */
-export function parseFiles(
-  files: string | (string | undefined)[],
-  context: string
-): string[];
+export function parseFiles(files: string | string[], context: string): string[];
 /**
  * @param {string|string[]} patterns
  * @param {string|string[]} extensions

package/dist/StylelintError.js

@@ -6,8 +6,8 @@ Object.defineProperty(exports, "__esModule", {
 exports.default = void 0;
 
 class StylelintError extends Error {
-  /**
-   * @param {string=} messages
+  /**
+   * @param {string=} messages
    */
   constructor(messages) {
     super(messages);

package/dist/getStylelint.js

@@ -29,13 +29,13 @@ const cache = {};
 
 /** @typedef {(files: string|string[]) => Promise<LintResult[]>} LintTask */
 
-/** @typedef {JestWorker & {lintFiles: LintTask}} Worker */
-
 /** @typedef {{stylelint: Stylelint, lintFiles: LintTask, cleanup: AsyncTask, threads: number, }} Linter */
 
-/**
- * @param {Options} options
- * @returns {Linter}
+/** @typedef {import('jest-worker').Worker & {lintFiles: LintTask}} Worker */
+
+/**
+ * @param {Options} options
+ * @returns {Linter}
  */
 
 function loadStylelint(options) {
@@ -47,11 +47,11 @@ function loadStylelint(options) {
     threads: 1
   };
 }
-/**
- * @param {string|undefined} key
- * @param {number} poolSize
- * @param {Options} options
- * @returns {Linter}
+/**
+ * @param {string|undefined} key
+ * @param {number} poolSize
+ * @param {Options} options
+ * @returns {Linter}
  */
 
 
@@ -66,11 +66,8 @@ function loadStylelintThreaded(key, poolSize, options) {
     setupArgs: [options, (0, _options.getStylelintOptions)(options)]
   };
   const local = loadStylelint(options);
-  /** @type {Worker?} */
-  // prettier-ignore
-
   let worker =
-  /** @type {Worker} */
+  /** @type {Worker?} */
   new _jestWorker.Worker(source, workerOptions);
   /** @type {Linter} */
 
@@ -94,10 +91,10 @@ function loadStylelintThreaded(key, poolSize, options) {
   };
   return context;
 }
-/**
- * @param {string|undefined} key
- * @param {Options} options
- * @returns {Linter}
+/**
+ * @param {string|undefined} key
+ * @param {Options} options
+ * @returns {Linter}
  */
 
 
@@ -117,10 +114,10 @@ function getStylelint(key, {
 
   return cache[cacheKey];
 }
-/**
- * @param {string|undefined} key
- * @param {Options} options
- * @returns {string}
+/**
+ * @param {string|undefined} key
+ * @param {Options} options
+ * @returns {string}
  */