feat: add stylelint v15 (#323)

webpack-contrib · Feb 18, 2023 · 8dc5881 · 8dc5881
1 parent d9a850e
commit 8dc5881
Show file tree

Hide file tree

Showing 13 changed files with 1,079 additions and 1,272 deletions.
diff --git a/.github/workflows/nodejs.yml b/.github/workflows/nodejs.yml
@@ -61,7 +61,7 @@ jobs:
       matrix:
         os: [ubuntu-latest, windows-latest, macos-latest]
         node-version: [14.x, 16.x, 18.x, 19.x]
-        stylelint-version: [13.x, 14.x]
+        stylelint-version: [13.x, 14.x, 15.x]
         webpack-version: [latest]
 
     runs-on: ${{ matrix.os }}

diff --git a/package-lock.json b/package-lock.json
diff --git a/package.json b/package.json
@@ -43,12 +43,12 @@
     "types"
   ],
   "peerDependencies": {
-    "stylelint": "^13.0.0 || ^14.0.0",
+    "stylelint": "^13.0.0 || ^14.0.0 || ^15.0.0",
     "webpack": "^5.0.0"
   },
   "dependencies": {
     "globby": "^11.1.0",
-    "jest-worker": "^29.4.1",
+    "jest-worker": "^29.4.2",
     "micromatch": "^4.0.5",
     "normalize-path": "^3.0.0",
     "schema-utils": "^4.0.0"
@@ -62,30 +62,30 @@
     "@types/file-entry-cache": "^5.0.2",
     "@types/fs-extra": "^9.0.13",
     "@types/micromatch": "^4.0.2",
-    "@types/node": "^18.11.18",
+    "@types/node": "^18.13.0",
     "@types/normalize-path": "^3.0.0",
     "@types/webpack": "^5.28.0",
     "@webpack-contrib/eslint-config-webpack": "^3.0.0",
     "babel-eslint": "^10.1.0",
-    "babel-jest": "^29.4.1",
+    "babel-jest": "^29.4.2",
     "chokidar": "^3.5.3",
     "cross-env": "^7.0.3",
-    "cspell": "^6.20.1",
+    "cspell": "^6.22.0",
     "del": "^6.1.1",
     "del-cli": "^4.0.1",
-    "eslint": "^8.33.0",
+    "eslint": "^8.34.0",
     "eslint-config-prettier": "^8.6.0",
     "eslint-plugin-import": "^2.27.5",
     "file-loader": "^6.2.0",
     "fs-extra": "^10.1.0",
     "husky": "^8.0.3",
-    "jest": "^29.4.1",
-    "lint-staged": "^13.1.0",
+    "jest": "^29.4.2",
+    "lint-staged": "^13.1.1",
     "npm-run-all": "^4.1.5",
     "postcss-scss": "^4.0.6",
-    "prettier": "^2.8.3",
+    "prettier": "^2.8.4",
     "standard-version": "^9.5.0",
-    "stylelint": "^14.16.1",
+    "stylelint": "^15.0.0",
     "typescript": "^4.9.5",
     "webpack": "^5.75.0"
   },

diff --git a/src/getStylelint.js b/src/getStylelint.js
@@ -10,8 +10,12 @@ 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 */

diff --git a/src/index.js b/src/index.js
@@ -90,7 +90,7 @@ class StylelintWebpackPlugin {
     }
 
     compiler.hooks.thisCompilation.tap(this.key, (compilation) => {
-      /** @type {import('stylelint')} */
+      /** @type {import('./getStylelint').Stylelint} */
       let stylelint;
 
       /** @type {import('./linter').Linter} */

diff --git a/src/linter.js b/src/linter.js
@@ -4,15 +4,15 @@ const StylelintError = require('./StylelintError');
 const getStylelint = require('./getStylelint');
 const { arrify } = require('./utils');
 
-/** @typedef {import('stylelint')} Stylelint */
-/** @typedef {import('stylelint').LintResult} LintResult */
-/** @typedef {import('stylelint').LinterResult} LinterResult */
-/** @typedef {import('stylelint').Formatter} Formatter */
-/** @typedef {import('stylelint').FormatterType} FormatterType */
 /** @typedef {import('webpack').Compiler} Compiler */
 /** @typedef {import('webpack').Compilation} Compilation */
-/** @typedef {import('./options').Options} Options */
+/** @typedef {import('./getStylelint').Stylelint} Stylelint */
+/** @typedef {import('./getStylelint').LintResult} LintResult */
+/** @typedef {import('./getStylelint').LinterResult} LinterResult */
+/** @typedef {import('./getStylelint').Formatter} Formatter */
+/** @typedef {import('./getStylelint').FormatterType} FormatterType */
 /** @typedef {import('./getStylelint').isPathIgnored} isPathIgnored */
+/** @typedef {import('./options').Options} Options */
 /** @typedef {(compilation: Compilation) => Promise<void>} GenerateReport */
 /** @typedef {{errors?: StylelintError, warnings?: StylelintError, generateReportAsset?: GenerateReport}} Report */
 /** @typedef {() => Promise<Report>} Reporter */

diff --git a/src/options.js b/src/options.js
@@ -2,9 +2,8 @@ const { validate } = require('schema-utils');
 
 const schema = require('./options.json');
 
-/** @typedef {import("stylelint")} stylelint */
-/** @typedef {import("stylelint").LinterOptions} StylelintOptions */
-/** @typedef {import("stylelint").FormatterType} FormatterType */
+/** @typedef {import('./getStylelint').LinterOptions} StylelintOptions */
+/** @typedef {import('./getStylelint').FormatterType} FormatterType */
 
 /**
  * @typedef {Object} OutputReport

diff --git a/src/worker.js b/src/worker.js
@@ -1,5 +1,5 @@
-/** @typedef {import('stylelint')} Stylelint */
-/** @typedef {import("stylelint").LinterOptions} StylelintOptions */
+/** @typedef {import('./getStylelint').Stylelint} Stylelint */
+/** @typedef {import('./getStylelint').LinterOptions} StylelintOptions */
 /** @typedef {import('./options').Options} Options */
 
 Object.assign(module.exports, {

diff --git a/test/fail-on-config.test.js b/test/fail-on-config.test.js
@@ -12,7 +12,6 @@ describe('fail on config', () => {
       expect(stats.hasWarnings()).toBe(false);
       expect(stats.hasErrors()).toBe(true);
       expect(errors).toHaveLength(1);
-      expect(errors[0].message).toMatch(/Map keys must be unique/);
       done();
     });
   });

diff --git a/types/getStylelint.d.ts b/types/getStylelint.d.ts
@@ -13,6 +13,10 @@ declare namespace getStylelint {
   export {
     Stylelint,
     LintResult,
+    LinterOptions,
+    LinterResult,
+    Formatter,
+    FormatterType,
     Options,
     isPathIgnored,
     AsyncTask,
@@ -29,67 +33,17 @@ type Linter = {
   cleanup: AsyncTask;
   threads: number;
 };
-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>;
-  };
+type Stylelint = {
+  lint: (options: LinterOptions) => Promise<LinterResult>;
   formatters: {
     [k: string]: import('stylelint').Formatter;
   };
-  createPlugin: (
-    ruleName: string,
-    rule: import('stylelint').Rule<any, any>
-  ) => {
-    ruleName: string;
-    rule: import('stylelint').Rule<any, any>;
-  };
-  createLinter: (
-    options: import('stylelint').LinterOptions
-  ) => import('stylelint').InternalApi;
-  resolveConfig: (
-    filePath: string,
-    options?:
-      | Pick<
-          import('stylelint').LinterOptions,
-          'cwd' | 'config' | 'configFile' | 'configBasedir'
-        >
-      | undefined
-  ) => Promise<import('stylelint').Config | undefined>;
-  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;
-        result?: import('stylelint').PostcssResult | undefined;
-        context?: import('stylelint').RuleContext | undefined;
-      },
-      callback: (warning: import('postcss').Warning) => void
-    ) => void;
-  };
-  reference: {
-    longhandSubPropertiesOfShorthandProperties: import('stylelint').LonghandSubPropertiesOfShorthandProperties;
-  };
 };
 type LintResult = import('stylelint').LintResult;
+type LinterOptions = import('stylelint').LinterOptions;
+type LinterResult = import('stylelint').LinterResult;
+type Formatter = import('stylelint').Formatter;
+type FormatterType = import('stylelint').FormatterType;
 type isPathIgnored = (
   stylelint: Stylelint,
   filePath: string

diff --git a/types/linter.d.ts b/types/linter.d.ts
@@ -19,15 +19,15 @@ declare function linter(
 };
 declare namespace linter {
   export {
+    Compiler,
+    Compilation,
     Stylelint,
     LintResult,
     LinterResult,
     Formatter,
     FormatterType,
-    Compiler,
-    Compilation,
-    Options,
     isPathIgnored,
+    Options,
     GenerateReport,
     Report,
     Reporter,
@@ -37,74 +37,15 @@ declare namespace linter {
 }
 type Options = import('./options').Options;
 type Compilation = import('webpack').Compilation;
-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,
-    rule: import('stylelint').Rule<any, any>
-  ) => {
-    ruleName: string;
-    rule: import('stylelint').Rule<any, any>;
-  };
-  createLinter: (
-    options: import('stylelint').LinterOptions
-  ) => import('stylelint').InternalApi;
-  resolveConfig: (
-    filePath: string,
-    options?:
-      | Pick<
-          import('stylelint').LinterOptions,
-          'cwd' | 'config' | 'configFile' | 'configBasedir'
-        >
-      | undefined
-  ) => Promise<import('stylelint').Config | undefined>;
-  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;
-        result?: import('stylelint').PostcssResult | undefined;
-        context?: import('stylelint').RuleContext | undefined;
-      },
-      callback: (warning: import('postcss').Warning) => void
-    ) => void;
-  };
-  reference: {
-    longhandSubPropertiesOfShorthandProperties: import('stylelint').LonghandSubPropertiesOfShorthandProperties;
-  };
-};
+type Stylelint = import('./getStylelint').Stylelint;
 type Linter = (files: string | string[]) => void;
 type Reporter = () => Promise<Report>;
 import getStylelint = require('./getStylelint');
-type LintResult = import('stylelint').LintResult;
-type LinterResult = import('stylelint').LinterResult;
-type Formatter = import('stylelint').Formatter;
-type FormatterType = import('stylelint').FormatterType;
 type Compiler = import('webpack').Compiler;
+type LintResult = import('./getStylelint').LintResult;
+type LinterResult = import('./getStylelint').LinterResult;
+type Formatter = import('./getStylelint').Formatter;
+type FormatterType = import('./getStylelint').FormatterType;
 type isPathIgnored = import('./getStylelint').isPathIgnored;
 type GenerateReport = (compilation: Compilation) => Promise<void>;
 type Report = {