fix: fix rule doc URL

Since Stylelint 14.3.0, `meta.url` has been added: <https://github.com/stylelint/stylelint/blob/14.3.0/CHANGELOG.md#1430> Also, this change updates the `stylelint` package via `npm i stylelint`.
stylelint · Feb 9, 2022 · 630dd96 · 630dd96
1 parent 59be6cc
commit 630dd96
Show file tree

Hide file tree

Showing 14 changed files with 228 additions and 150 deletions.
diff --git a/package-lock.json b/package-lock.json
diff --git a/package.json b/package.json
@@ -232,7 +232,7 @@
     "postcss-sass": "^0.5.0",
     "postcss-scss": "^4.0.2",
     "prettier": "^2.5.0",
-    "stylelint": "^14.1.0",
+    "stylelint": "^14.4.0",
     "stylelint-processor-glamorous": "^0.3.0",
     "stylelint-processor-styled-components": "^1.10.0",
     "ts-jest": "^27.0.7",

diff --git a/src/utils/stylelint/__tests__/__snapshots__/process-linter-result.ts.snap b/src/utils/stylelint/__tests__/__snapshots__/process-linter-result.ts.snap
@@ -5,9 +5,6 @@ Object {
   "diagnostics": Array [
     Object {
       "code": "unit-no-unknown",
-      "codeDescription": Object {
-        "href": "https://stylelint.io/user-guide/rules/unit-no-unknown",
-      },
       "message": "unit-no-unknown",
       "range": Object {
         "end": Object {
@@ -24,9 +21,6 @@ Object {
     },
     Object {
       "code": "at-rule-no-unknown",
-      "codeDescription": Object {
-        "href": "https://stylelint.io/user-guide/rules/at-rule-no-unknown",
-      },
       "message": "at-rule-no-unknown",
       "range": Object {
         "end": Object {
@@ -66,9 +60,6 @@ Object {
   "diagnostics": Array [
     Object {
       "code": "unit-no-unknown",
-      "codeDescription": Object {
-        "href": "https://stylelint.io/user-guide/rules/unit-no-unknown",
-      },
       "message": "unit-no-unknown",
       "range": Object {
         "end": Object {

diff --git a/src/utils/stylelint/__tests__/__snapshots__/stylelint-runner.ts.snap b/src/utils/stylelint/__tests__/__snapshots__/stylelint-runner.ts.snap
@@ -25,7 +25,7 @@ Object {
     Object {
       "code": "block-no-empty",
       "codeDescription": Object {
-        "href": "https://stylelint.io/user-guide/rules/block-no-empty",
+        "href": "https://stylelint.io/user-guide/rules/list/block-no-empty",
       },
       "message": "Unexpected empty block (block-no-empty)",
       "range": Object {

diff --git a/src/utils/stylelint/__tests__/__snapshots__/warning-to-diagnostic.ts.snap b/src/utils/stylelint/__tests__/__snapshots__/warning-to-diagnostic.ts.snap
@@ -4,7 +4,7 @@ exports[`warningToDiagnostic should add a rule documentation URL if a matching r
 Object {
   "code": "color-hex-case",
   "codeDescription": Object {
-    "href": "https://stylelint.io/user-guide/rules/color-hex-case",
+    "href": "https://stylelint.io/rules/color-hex-case",
   },
   "message": "Expected \\"#AAA\\" to be \\"#aaa\\" (color-hex-case)",
   "range": Object {

diff --git a/src/utils/stylelint/__tests__/warning-to-diagnostic.ts b/src/utils/stylelint/__tests__/warning-to-diagnostic.ts
@@ -40,7 +40,9 @@ describe('warningToDiagnostic', () => {
 			},
 		});
 
-		const rules = { 'color-hex-case': {} } as unknown as {
+		const rules = {
+			'color-hex-case': { meta: { url: 'https://stylelint.io/rules/color-hex-case' } },
+		} as unknown as {
 			[name: string]: stylelint.Rule<unknown, unknown>;
 		};
 

diff --git a/src/utils/stylelint/warning-to-diagnostic.ts b/src/utils/stylelint/warning-to-diagnostic.ts
@@ -48,8 +48,7 @@ export function warningToDiagnostic(
 	const start = Position.create(warning.line - 1, warning.column - 1);
 	const end = Position.create(warning.line - 1, warning.column);
 
-	const ruleDocUrl =
-		rules?.[warning.rule] && `https://stylelint.io/user-guide/rules/${warning.rule}`;
+	const ruleDocUrl = rules?.[warning.rule]?.meta?.url;
 
 	const diagnostic = Diagnostic.create(
 		Range.create(start, end),

diff --git a/test/e2e/__tests__/__snapshots__/code-actions.ts.snap b/test/e2e/__tests__/__snapshots__/code-actions.ts.snap
@@ -107,7 +107,7 @@ Array [
     "command": Object {
       "arguments": Array [
         Object {
-          "uri": "https://stylelint.io/user-guide/rules/indentation",
+          "uri": "https://stylelint.io/user-guide/rules/list/indentation",
         },
       ],
       "command": "stylelint.openRuleDoc",

diff --git a/test/e2e/__tests__/__snapshots__/config-basedir.ts.snap b/test/e2e/__tests__/__snapshots__/config-basedir.ts.snap
@@ -5,7 +5,7 @@ Array [
   Object {
     "code": "color-hex-case",
     "codeDescription": Object {
-      "href": "https://stylelint.io/user-guide/rules/color-hex-case",
+      "href": "https://stylelint.io/user-guide/rules/list/color-hex-case",
     },
     "message": "Expected \\"#fff\\" to be \\"#FFF\\" (color-hex-case)",
     "range": Object {
@@ -24,7 +24,7 @@ Array [
   Object {
     "code": "indentation",
     "codeDescription": Object {
-      "href": "https://stylelint.io/user-guide/rules/indentation",
+      "href": "https://stylelint.io/user-guide/rules/list/indentation",
     },
     "message": "Expected indentation of 8 spaces (indentation)",
     "range": Object {

diff --git a/test/e2e/__tests__/__snapshots__/config-file.ts.snap b/test/e2e/__tests__/__snapshots__/config-file.ts.snap
@@ -5,7 +5,7 @@ Array [
   Object {
     "code": "block-no-empty",
     "codeDescription": Object {
-      "href": "https://stylelint.io/user-guide/rules/block-no-empty",
+      "href": "https://stylelint.io/user-guide/rules/list/block-no-empty",
     },
     "message": "Unexpected empty block (block-no-empty)",
     "range": Object {

diff --git a/test/e2e/__tests__/__snapshots__/ignore-disables.ts.snap b/test/e2e/__tests__/__snapshots__/ignore-disables.ts.snap
@@ -5,7 +5,7 @@ Array [
   Object {
     "code": "color-hex-case",
     "codeDescription": Object {
-      "href": "https://stylelint.io/user-guide/rules/color-hex-case",
+      "href": "https://stylelint.io/user-guide/rules/list/color-hex-case",
     },
     "message": "Expected \\"#fff\\" to be \\"#FFF\\" (color-hex-case)",
     "range": Object {
@@ -24,7 +24,7 @@ Array [
   Object {
     "code": "indentation",
     "codeDescription": Object {
-      "href": "https://stylelint.io/user-guide/rules/indentation",
+      "href": "https://stylelint.io/user-guide/rules/list/indentation",
     },
     "message": "Expected indentation of 4 spaces (indentation)",
     "range": Object {

diff --git a/test/e2e/__tests__/__snapshots__/lint.ts.snap b/test/e2e/__tests__/__snapshots__/lint.ts.snap
@@ -21,7 +21,7 @@ Array [
   Object {
     "code": "color-no-invalid-hex",
     "codeDescription": Object {
-      "href": "https://stylelint.io/user-guide/rules/color-no-invalid-hex",
+      "href": "https://stylelint.io/user-guide/rules/list/color-no-invalid-hex",
     },
     "message": "Unexpected invalid hex color \\"#y3\\" (color-no-invalid-hex)",
     "range": Object {
@@ -40,7 +40,7 @@ Array [
   Object {
     "code": "indentation",
     "codeDescription": Object {
-      "href": "https://stylelint.io/user-guide/rules/indentation",
+      "href": "https://stylelint.io/user-guide/rules/list/indentation",
     },
     "message": "Expected indentation of 4 spaces (indentation)",
     "range": Object {
@@ -64,7 +64,7 @@ Array [
   Object {
     "code": "indentation",
     "codeDescription": Object {
-      "href": "https://stylelint.io/user-guide/rules/indentation",
+      "href": "https://stylelint.io/user-guide/rules/list/indentation",
     },
     "message": "Expected indentation of 4 spaces (indentation)",
     "range": Object {

diff --git a/test/e2e/__tests__/__snapshots__/validate.ts.snap b/test/e2e/__tests__/__snapshots__/validate.ts.snap
@@ -5,7 +5,7 @@ Array [
   Object {
     "code": "indentation",
     "codeDescription": Object {
-      "href": "https://stylelint.io/user-guide/rules/indentation",
+      "href": "https://stylelint.io/user-guide/rules/list/indentation",
     },
     "message": "Expected indentation of 4 spaces (indentation)",
     "range": Object {

diff --git a/test/integration/stylelint-vscode/__snapshots__/test.ts.snap b/test/integration/stylelint-vscode/__snapshots__/test.ts.snap
@@ -5,7 +5,7 @@ Array [
   Object {
     "code": "string-quotes",
     "codeDescription": Object {
-      "href": "https://stylelint.io/user-guide/rules/string-quotes",
+      "href": "https://stylelint.io/user-guide/rules/list/string-quotes",
     },
     "message": "Expected single quotes (string-quotes)",
     "range": Object {
@@ -24,7 +24,7 @@ Array [
   Object {
     "code": "indentation",
     "codeDescription": Object {
-      "href": "https://stylelint.io/user-guide/rules/indentation",
+      "href": "https://stylelint.io/user-guide/rules/list/indentation",
     },
     "message": "Expected indentation of 0 tabs (indentation)",
     "range": Object {
@@ -174,7 +174,7 @@ Array [
   Object {
     "code": "font-weight-notation",
     "codeDescription": Object {
-      "href": "https://stylelint.io/user-guide/rules/font-weight-notation",
+      "href": "https://stylelint.io/user-guide/rules/list/font-weight-notation",
     },
     "message": "Expected numeric font-weight notation (font-weight-notation)",
     "range": Object {
@@ -193,7 +193,7 @@ Array [
   Object {
     "code": "font-weight-notation",
     "codeDescription": Object {
-      "href": "https://stylelint.io/user-guide/rules/font-weight-notation",
+      "href": "https://stylelint.io/user-guide/rules/list/font-weight-notation",
     },
     "message": "Expected numeric font-weight notation (font-weight-notation)",
     "range": Object {
@@ -217,7 +217,7 @@ Array [
   Object {
     "code": "length-zero-no-unit",
     "codeDescription": Object {
-      "href": "https://stylelint.io/user-guide/rules/length-zero-no-unit",
+      "href": "https://stylelint.io/user-guide/rules/list/length-zero-no-unit",
     },
     "message": "Unexpected unit (length-zero-no-unit)",
     "range": Object {
@@ -242,7 +242,7 @@ Object {
     Object {
       "code": "selector-type-no-unknown",
       "codeDescription": Object {
-        "href": "https://stylelint.io/user-guide/rules/selector-type-no-unknown",
+        "href": "https://stylelint.io/user-guide/rules/list/selector-type-no-unknown",
       },
       "message": "Unexpected unknown type selector \\"unknown\\" (selector-type-no-unknown)",
       "range": Object {
@@ -298,7 +298,7 @@ Object {
     Object {
       "code": "indentation",
       "codeDescription": Object {
-        "href": "https://stylelint.io/user-guide/rules/indentation",
+        "href": "https://stylelint.io/user-guide/rules/list/indentation",
       },
       "message": "Expected indentation of 2 spaces (indentation)",
       "range": Object {
@@ -379,7 +379,7 @@ Object {
     Object {
       "code": "indentation",
       "codeDescription": Object {
-        "href": "https://stylelint.io/user-guide/rules/indentation",
+        "href": "https://stylelint.io/user-guide/rules/list/indentation",
       },
       "message": "Expected indentation of 4 spaces (indentation)",
       "range": Object {
@@ -492,7 +492,7 @@ Object {
     Object {
       "code": "indentation",
       "codeDescription": Object {
-        "href": "https://stylelint.io/user-guide/rules/indentation",
+        "href": "https://stylelint.io/user-guide/rules/list/indentation",
       },
       "message": "Expected indentation of 2 spaces (indentation)",
       "range": Object {