stylelint-webpack-plugin 5.0.0 → 5.1.0

package/types/options.d.ts

@@ -1,59 +1,107 @@
-export type StylelintOptions = import('./getStylelint').LinterOptions;
-export type FormatterType = import('./getStylelint').FormatterType;
+export type StylelintOptions = import("./getStylelint").LinterOptions;
+export type FormatterType = import("./getStylelint").FormatterType;
 export type OutputReport = {
+  /**
+   * file path
+   */
   filePath?: string | undefined;
+  /**
+   * formatter
+   */
   formatter?: FormatterType | undefined;
 };
 export type PluginOptions = {
+  /**
+   * a string indicating the root of your files
+   */
   context: string;
+  /**
+   * the errors found will always be emitted
+   */
   emitError: boolean;
+  /**
+   * the warnings found will always be emitted
+   */
   emitWarning: boolean;
+  /**
+   * specify the files and/or directories to exclude
+   */
   exclude?: (string | string[]) | undefined;
+  /**
+   * specify the extensions that should be checked
+   */
   extensions: string | string[];
+  /**
+   * will cause the module build to fail if there are any errors
+   */
   failOnError: boolean;
+  /**
+   * will cause the module build to fail if there are any warning
+   */
   failOnWarning: boolean;
+  /**
+   * specify directories, files, or globs
+   */
   files: string | string[];
+  /**
+   * specify the formatter you would like to use to format your results
+   */
   formatter: FormatterType;
+  /**
+   * lint only changed files, skip linting on start
+   */
   lintDirtyModulesOnly: boolean;
+  /**
+   * will process and report errors only and ignore warnings
+   */
   quiet: boolean;
+  /**
+   * path to `stylelint` instance that will be used for linting
+   */
   stylelintPath: string;
+  /**
+   * writes the output of the errors to a file - for example, a `json` file for use for reporting
+   */
   outputReport: OutputReport;
+  /**
+   * number of worker threads
+   */
   threads?: (number | boolean) | undefined;
 };
 export type Options = Partial<PluginOptions & StylelintOptions>;
 /** @typedef {import('./getStylelint').LinterOptions} StylelintOptions */
 /** @typedef {import('./getStylelint').FormatterType} FormatterType */
 /**
- * @typedef {Object} OutputReport
- * @property {string=} filePath
- * @property {FormatterType=} formatter
+ * @typedef {object} OutputReport
+ * @property {string=} filePath file path
+ * @property {FormatterType=} formatter formatter
  */
 /**
- * @typedef {Object} PluginOptions
- * @property {string} context
- * @property {boolean} emitError
- * @property {boolean} emitWarning
- * @property {string|string[]=} exclude
- * @property {string|string[]} extensions
- * @property {boolean} failOnError
- * @property {boolean} failOnWarning
- * @property {string|string[]} files
- * @property {FormatterType} formatter
- * @property {boolean} lintDirtyModulesOnly
- * @property {boolean} quiet
- * @property {string} stylelintPath
- * @property {OutputReport} outputReport
- * @property {number|boolean=} threads
+ * @typedef {object} PluginOptions
+ * @property {string} context a string indicating the root of your files
+ * @property {boolean} emitError the errors found will always be emitted
+ * @property {boolean} emitWarning the warnings found will always be emitted
+ * @property {string | string[]=} exclude specify the files and/or directories to exclude
+ * @property {string | string[]} extensions specify the extensions that should be checked
+ * @property {boolean} failOnError will cause the module build to fail if there are any errors
+ * @property {boolean} failOnWarning will cause the module build to fail if there are any warning
+ * @property {string | string[]} files specify directories, files, or globs
+ * @property {FormatterType} formatter specify the formatter you would like to use to format your results
+ * @property {boolean} lintDirtyModulesOnly lint only changed files, skip linting on start
+ * @property {boolean} quiet will process and report errors only and ignore warnings
+ * @property {string} stylelintPath path to `stylelint` instance that will be used for linting
+ * @property {OutputReport} outputReport writes the output of the errors to a file - for example, a `json` file for use for reporting
+ * @property {number | boolean=} threads number of worker threads
  */
 /** @typedef {Partial<PluginOptions & StylelintOptions>} Options */
 /**
- * @param {Options} pluginOptions
- * @returns {Partial<PluginOptions>}
+ * @param {Options} pluginOptions plugin options
+ * @returns {Partial<PluginOptions>} partial plugin options
  */
 export function getOptions(pluginOptions: Options): Partial<PluginOptions>;
 /**
- * @param {Options} pluginOptions
- * @returns {Partial<StylelintOptions>}
+ * @param {Options} pluginOptions plugin options
+ * @returns {Partial<StylelintOptions>} stylelint options
  */
 export function getStylelintOptions(
   pluginOptions: Options,

package/types/utils.d.ts

@@ -1,21 +1,4 @@
-/**
- * @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
+export type ArrifyResult<T> = T extends null | undefined
   ? []
   : T extends string
     ? [string]
@@ -24,24 +7,48 @@ export function arrify<T>(
       : T extends Iterable<infer T_1>
         ? T_1[]
         : [T];
+export type EXPECTED_ANY = any;
+/**
+ * @template T
+ * @typedef {T extends (null | undefined)
+ * ? []
+ * : T extends string
+ * ? [string]
+ * : T extends readonly unknown[]
+ * ? T
+ * : T extends Iterable<infer T>
+ * ? T[]
+ * : [T]} ArrifyResult
+ */
 /**
- * @param {string|string[]} files
- * @param {string} context
- * @returns {string[]}
+ * @template T
+ * @param {T} value value
+ * @returns {ArrifyResult<T>} array of values
+ */
+export function arrify<T>(value: T): ArrifyResult<T>;
+/**
+ * @param {string} _ key, but unused
+ * @param {EXPECTED_ANY} value value
+ * @returns {{ [x: string]: EXPECTED_ANY }} result
+ */
+export function jsonStringifyReplacerSortKeys(
+  _: string,
+  value: EXPECTED_ANY,
+): {
+  [x: string]: EXPECTED_ANY;
+};
+/**
+ * @param {string | string[]} files files
+ * @param {string} context context
+ * @returns {string[]} normalized paths
  */
 export function parseFiles(files: string | string[], context: string): string[];
 /**
- * @param {string|string[]} patterns
- * @param {string|string[]} extensions
- * @returns {string[]}
+ * @param {string | string[]} patterns patterns
+ * @param {string | string[]} extensions extensions
+ * @returns {string[]} globs
  */
 export function parseFoldersToGlobs(
   patterns: string | string[],
   extensions?: string | string[],
 ): string[];
-/**
- *
- * @param {string} _ key, but unused
- * @param {any} value
- */
-export function jsonStringifyReplacerSortKeys(_: string, value: any): any;

package/types/worker.d.ts

@@ -1,3 +1,22 @@
-export type Stylelint = import('./getStylelint').Stylelint;
-export type StylelintOptions = import('./getStylelint').LinterOptions;
-export type Options = import('./options').Options;
+export type Stylelint = import("./getStylelint").Stylelint;
+export type StylelintOptions = import("./getStylelint").LinterOptions;
+export type LintResult = import("./getStylelint").LintResult;
+export type Options = import("./options").Options;
+/**
+ * Lazily load stylelint on first use
+ * @returns {Promise<Stylelint>} stylelint instance
+ */
+export function getStylelint(): Promise<Stylelint>;
+/**
+ * @param {string | string[]} files files
+ * @returns {Promise<LintResult[]>} results
+ */
+export function lintFiles(files: string | string[]): Promise<LintResult[]>;
+/**
+ * @param {Options} options the worker options
+ * @param {Partial<StylelintOptions>} stylelintOptions the stylelint options
+ */
+export function setup(
+  options: Options,
+  stylelintOptions: Partial<StylelintOptions>,
+): void;