stylelint-webpack-plugin 2.3.2 → 2.5.0

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,199 +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@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
+
+> 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/dist/StylelintError.js

@@ -1,21 +1,13 @@
 "use strict";
 
-Object.defineProperty(exports, "__esModule", {
-  value: true
-});
-exports.default = void 0;
-
 class StylelintError extends Error {
-  /**
-   * @param {string=} messages
+  /**
+   * @param {string=} messages
    */
   constructor(messages) {
-    super(messages);
+    super(`[stylelint] ${messages}`);
     this.name = 'StylelintError';
     this.stack = '';
   }
-
 }
-
-var _default = StylelintError;
-exports.default = _default;
+module.exports = StylelintError;

package/dist/getStylelint.js

@@ -1,91 +1,96 @@
 "use strict";
 
-Object.defineProperty(exports, "__esModule", {
-  value: true
-});
-exports.default = getStylelint;
-
-var _os = require("os");
-
-var _jestWorker = require("jest-worker");
-
-var _worker = require("./worker");
-
-var _utils = require("./utils");
-
-var _options = require("./options");
+const {
+  cpus
+} = require('os');
+const {
+  Worker: JestWorker
+} = require('jest-worker');
 
 // @ts-ignore
+const {
+  setup,
+  lintFiles
+} = require('./worker');
+const {
+  jsonStringifyReplacerSortKeys
+} = require('./utils');
+const {
+  getStylelintOptions
+} = require('./options');
 
 /** @type {{[key: string]: any}} */
 const cache = {};
-/** @typedef {import('stylelint')} Stylelint */
 
+/** @typedef {{lint: (options: LinterOptions) => Promise<LinterResult>, formatters: { [k: string]: Formatter }}} Stylelint */
 /** @typedef {import('stylelint').LintResult} LintResult */
-
+/** @typedef {import('stylelint').LinterOptions} LinterOptions */
+/** @typedef {import('stylelint').LinterResult} LinterResult */
+/** @typedef {import('stylelint').Formatter} Formatter */
+/** @typedef {import('stylelint').FormatterType} FormatterType */
 /** @typedef {import('./options').Options} Options */
-
+/** @typedef {(stylelint: Stylelint, filePath: string) => Promise<boolean>} isPathIgnored */
 /** @typedef {() => Promise<void>} AsyncTask */
-
 /** @typedef {(files: string|string[]) => Promise<LintResult[]>} LintTask */
-
+/** @typedef {{stylelint: Stylelint, isPathIgnored: isPathIgnored, lintFiles: LintTask, cleanup: AsyncTask, threads: number }} Linter */
 /** @typedef {JestWorker & {lintFiles: LintTask}} Worker */
 
-/** @typedef {{stylelint: Stylelint, lintFiles: LintTask, cleanup: AsyncTask, threads: number, }} Linter */
-
-/**
- * @param {Options} options
- * @returns {Linter}
+/**
+ * @param {Options} options
+ * @returns {Linter}
  */
-
 function loadStylelint(options) {
-  const stylelint = (0, _worker.setup)(options, (0, _options.getStylelintOptions)(options));
+  const stylelintOptions = getStylelintOptions(options);
+  const stylelint = setup(options, stylelintOptions);
+
+  /** @type {isPathIgnored} */
+  let isPathIgnored;
+  try {
+    isPathIgnored = require(`${options.stylelintPath}/lib/isPathIgnored`);
+  } catch (e) {
+    try {
+      // @ts-ignore
+      isPathIgnored = require('stylelint/lib/isPathIgnored');
+    } catch (_) {
+      isPathIgnored = () => Promise.resolve(false);
+    }
+  }
   return {
     stylelint,
-    lintFiles: _worker.lintFiles,
+    isPathIgnored,
+    lintFiles,
     cleanup: async () => {},
     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}
+ */
 function loadStylelintThreaded(key, poolSize, options) {
   const cacheKey = getCacheKey(key, options);
-
   const source = require.resolve('./worker');
-
   const workerOptions = {
     enableWorkerThreads: true,
     numWorkers: poolSize,
-    setupArgs: [options, (0, _options.getStylelintOptions)(options)]
+    setupArgs: [options, getStylelintOptions(options)]
   };
   const local = loadStylelint(options);
-  /** @type {Worker?} */
-  // prettier-ignore
+  let worker = /** @type {Worker?} */new JestWorker(source, workerOptions);
 
-  let worker =
-  /** @type {Worker} */
-  new _jestWorker.Worker(source, workerOptions);
   /** @type {Linter} */
-
-  const context = { ...local,
+  const context = {
+    ...local,
     threads: poolSize,
-    lintFiles: async files =>
-    /* istanbul ignore next */
+    lintFiles: async files => /* istanbul ignore next */
     worker ? worker.lintFiles(files) : local.lintFiles(files),
     cleanup: async () => {
       cache[cacheKey] = local;
-
       context.lintFiles = files => local.lintFiles(files);
       /* istanbul ignore next */
-
-
       if (worker) {
         worker.end();
         worker = null;
@@ -94,39 +99,36 @@ 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}
+ */
 function getStylelint(key, {
   threads,
   ...options
 }) {
-  const max = typeof threads !== 'number' ? threads ? (0, _os.cpus)().length - 1 : 1 : threads;
+  const max = typeof threads !== 'number' ? threads ? cpus().length - 1 : 1 : threads;
   const cacheKey = getCacheKey(key, {
     threads,
     ...options
   });
-
   if (!cache[cacheKey]) {
     cache[cacheKey] = max > 1 ? loadStylelintThreaded(key, max, options) : loadStylelint(options);
   }
-
   return cache[cacheKey];
 }
-/**
- * @param {string|undefined} key
- * @param {Options} options
- * @returns {string}
- */
-
 
+/**
+ * @param {string|undefined} key
+ * @param {Options} options
+ * @returns {string}
+ */
 function getCacheKey(key, options) {
   return JSON.stringify({
     key,
     options
-  }, _utils.jsonStringifyReplacerSortKeys);
-}
+  }, jsonStringifyReplacerSortKeys);
+}
+module.exports = getStylelint;