stylelint-webpack-plugin 2.3.2 → 2.5.0

package/types/options.d.ts

@@ -0,0 +1,60 @@
+export type StylelintOptions = import('./getStylelint').LinterOptions;
+export type FormatterType = import('./getStylelint').FormatterType;
+export type OutputReport = {
+  filePath?: string | undefined;
+  formatter?: FormatterType | undefined;
+};
+export type PluginOptions = {
+  context: string;
+  emitError: boolean;
+  emitWarning: boolean;
+  exclude?: (string | string[]) | undefined;
+  extensions: string | string[];
+  failOnError: boolean;
+  failOnWarning: boolean;
+  files: string | string[];
+  formatter: FormatterType;
+  lintDirtyModulesOnly: boolean;
+  quiet: boolean;
+  stylelintPath: string;
+  outputReport: OutputReport;
+  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} 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 {Partial<PluginOptions & StylelintOptions>} Options */
+/**
+ * @param {Options} pluginOptions
+ * @returns {Partial<PluginOptions>}
+ */
+export function getOptions(pluginOptions: Options): Partial<PluginOptions>;
+/**
+ * @param {Options} pluginOptions
+ * @returns {Partial<StylelintOptions>}
+ */
+export function getStylelintOptions(
+  pluginOptions: Options
+): Partial<StylelintOptions>;

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

@@ -16,4 +16,9 @@ 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

@@ -0,0 +1,3 @@
+export type Stylelint = import('./getStylelint').Stylelint;
+export type StylelintOptions = import('./getStylelint').LinterOptions;
+export type Options = import('./options').Options;

package/declarations/StylelintError.d.ts

@@ -1,2 +0,0 @@
-export default StylelintError;
-declare class StylelintError extends Error {}

package/declarations/cjs.d.ts

@@ -1,3 +0,0 @@
-declare const _exports: typeof plugin.default;
-export = _exports;
-import plugin = require('./index');

package/declarations/getStylelint.d.ts

@@ -1,70 +0,0 @@
-/// <reference types="stylelint" />
-/**
- * @param {string|undefined} key
- * @param {Options} options
- * @returns {Linter}
- */
-export default function getStylelint(
-  key: string | undefined,
-  { threads, ...options }: Options
-): Linter;
-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>;
-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';

package/declarations/linter.d.ts

@@ -1,80 +0,0 @@
-/// <reference types="stylelint" />
-/**
- * @param {string|undefined} key
- * @param {Options} options
- * @param {Compilation} compilation
- * @returns {{lint: Linter, report: Reporter, threads: number}}
- */
-export default function linter(
-  key: string | undefined,
-  options: Options,
-  compilation: Compilation
-): {
-  lint: Linter;
-  report: Reporter;
-  threads: number;
-};
-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;
-export type Options = import('./options').Options;
-export type FormatterType = import('./options').FormatterType;
-export type FormatterFunction = (results: LintResult[]) => string;
-export type GenerateReport = (compilation: Compilation) => Promise<void>;
-export type Report = {
-  errors?: StylelintError;
-  warnings?: StylelintError;
-  generateReportAsset?: GenerateReport;
-};
-export type Reporter = () => Promise<Report>;
-export type Linter = (files: string | string[]) => void;
-export type LintResultMap = {
-  [files: string]: import('stylelint').LintResult;
-};
-import StylelintError from './StylelintError';

package/declarations/options.d.ts

@@ -1,108 +0,0 @@
-/// <reference types="stylelint" />
-/** @typedef {import("stylelint")} stylelint */
-/** @typedef {import("stylelint").LinterOptions} StylelintOptions */
-/** @typedef {import("stylelint").FormatterType} FormatterType */
-/**
- * @typedef {Object} OutputReport
- * @property {string=} filePath
- * @property {FormatterType=} 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 {Partial<PluginOptions & StylelintOptions>} Options */
-/**
- * @param {Options} pluginOptions
- * @returns {Partial<PluginOptions>}
- */
-export function getOptions(pluginOptions: Options): Partial<PluginOptions>;
-/**
- * @param {Options} pluginOptions
- * @returns {Partial<StylelintOptions>}
- */
-export function getStylelintOptions(
-  pluginOptions: Options
-): Partial<StylelintOptions>;
-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 = {
-  filePath?: string | undefined;
-  formatter?: FormatterType | undefined;
-};
-export type PluginOptions = {
-  context: string;
-  emitError: boolean;
-  emitWarning: boolean;
-  exclude?: (string | string[]) | undefined;
-  extensions: string | string[];
-  failOnError: boolean;
-  failOnWarning: boolean;
-  files: string | string[];
-  formatter: FormatterType;
-  lintDirtyModulesOnly: boolean;
-  quiet: boolean;
-  stylelintPath: string;
-  outputReport: OutputReport;
-  threads?: (number | boolean) | undefined;
-};
-export type Options = Partial<PluginOptions & StylelintOptions>;

package/declarations/worker.d.ts

@@ -1,49 +0,0 @@
-/// <reference types="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 Options = import('./options').Options;

package/dist/cjs.js

@@ -1,5 +0,0 @@
-"use strict";
-
-const plugin = require('./index');
-
-module.exports = plugin.default;