refactor: check more types, conform to lsp spec

- Check types for JS files in test and scripts directories - Update diagnostic code and tests to use codeDescription instead of code object type per microsoft/vscode-languageserver-node#601 and LSP 3.16
stylelint · Oct 6, 2021 · 82a8a90 · 82a8a90
1 parent 8c43e28
commit 82a8a90
Show file tree

Hide file tree

Showing 25 changed files with 309 additions and 284 deletions.
diff --git a/.eslintrc.js b/.eslintrc.js
@@ -13,6 +13,7 @@ const config = {
 	},
 	rules: {
 		'node/no-missing-require': ['error', { allowModules: ['vscode'] }],
+		'require-jsdoc': 'error',
 	},
 };
 

diff --git a/package-lock.json b/package-lock.json
diff --git a/package.json b/package.json
@@ -209,6 +209,7 @@
   },
   "devDependencies": {
     "@stylelint/prettier-config": "^2.0.0",
+    "@types/fs-extra": "^9.0.13",
     "@types/jest": "^27.0.1",
     "@types/lodash": "^4.14.151",
     "@types/path-is-inside": "^1.0.0",

diff --git a/scripts/bundle.js b/scripts/bundle.js
@@ -9,6 +9,7 @@ const rootDir = path.resolve(__dirname, '..');
 
 const args = new Set(process.argv.slice(2));
 
+/** @returns {Promise<void>} */
 async function bundle() {
 	const entryPoints = ['src/index.js', 'src/server.js'];
 

diff --git a/scripts/stylelint-types.js b/scripts/stylelint-types.js
@@ -20,7 +20,10 @@ if (!version) {
 
 const args = new Set(process.argv.slice(2));
 
-/** Checks if the Stylelint types file is up to date. */
+/**
+ * Checks if the Stylelint types file is up to date.
+ * @returns {Promise<void>}
+ */
 const checkTypesVersion = async () => {
 	try {
 		const downloadedVersion = (await fs.readFile(typesVersionPath, 'utf8'))?.trim();
@@ -44,7 +47,10 @@ const checkTypesVersion = async () => {
 	}
 };
 
-/** Downloads the stylelint types file for the currently installed version of Stylelint. */
+/**
+ * Downloads the stylelint types file for the currently installed version of Stylelint.
+ * @returns {Promise<void>}
+ */
 const downloadTypes = async () => {
 	const typesURL = `https://raw.githubusercontent.com/stylelint/stylelint/${version}/types/stylelint/index.d.ts`;
 

diff --git a/src/warnings-to-diagnostics.js b/src/warnings-to-diagnostics.js
@@ -28,17 +28,17 @@ module.exports = function stylelintWarningToVscodeDiagnostic(
 	 */
 	const ruleDocUrl = ruleDocUrlProvider(warning.rule);
 
-	return Diagnostic.create(
+	const diagnostic = Diagnostic.create(
 		Range.create(position, position),
 		warning.text,
 		DiagnosticSeverity[warning.severity === 'warning' ? 'Warning' : 'Error'],
-		// @ts-expect-error -- It is a types bug. DiagnosticCode exists but is not accepted in create argument.
-		ruleDocUrl
-			? {
-					value: warning.rule,
-					target: ruleDocUrl,
-			  }
-			: warning.rule,
+		warning.rule,
 		'stylelint',
 	);
+
+	if (ruleDocUrl) {
+		diagnostic.codeDescription = { href: ruleDocUrl };
+	}
+
+	return diagnostic;
 };
diff --git a/test/lib/stylelint-vscode/__snapshots__/test.js.snap b/test/lib/stylelint-vscode/__snapshots__/test.js.snap
@@ -3,9 +3,9 @@
 exports[`stylelintVSCode() should be resolved with diagnostics when it lints CSS successfully 1`] = `
 Array [
   Object {
-    "code": Object {
-      "target": "https://stylelint.io/user-guide/rules/string-quotes",
-      "value": "string-quotes",
+    "code": "string-quotes",
+    "codeDescription": Object {
+      "href": "https://stylelint.io/user-guide/rules/string-quotes",
     },
     "message": "Expected single quotes (string-quotes)",
     "range": Object {
@@ -22,9 +22,9 @@ Array [
     "source": "stylelint",
   },
   Object {
-    "code": Object {
-      "target": "https://stylelint.io/user-guide/rules/indentation",
-      "value": "indentation",
+    "code": "indentation",
+    "codeDescription": Object {
+      "href": "https://stylelint.io/user-guide/rules/indentation",
     },
     "message": "Expected indentation of 0 tabs (indentation)",
     "range": Object {
@@ -172,9 +172,9 @@ Array [
 exports[`stylelintVSCode() should support CSS-in-JS 1`] = `
 Array [
   Object {
-    "code": Object {
-      "target": "https://stylelint.io/user-guide/rules/font-weight-notation",
-      "value": "font-weight-notation",
+    "code": "font-weight-notation",
+    "codeDescription": Object {
+      "href": "https://stylelint.io/user-guide/rules/font-weight-notation",
     },
     "message": "Expected numeric font-weight notation (font-weight-notation)",
     "range": Object {
@@ -191,9 +191,9 @@ Array [
     "source": "stylelint",
   },
   Object {
-    "code": Object {
-      "target": "https://stylelint.io/user-guide/rules/font-weight-notation",
-      "value": "font-weight-notation",
+    "code": "font-weight-notation",
+    "codeDescription": Object {
+      "href": "https://stylelint.io/user-guide/rules/font-weight-notation",
     },
     "message": "Expected numeric font-weight notation (font-weight-notation)",
     "range": Object {
@@ -215,9 +215,9 @@ Array [
 exports[`stylelintVSCode() with a configuration file should adhere to configuration file settings 1`] = `
 Array [
   Object {
-    "code": Object {
-      "target": "https://stylelint.io/user-guide/rules/length-zero-no-unit",
-      "value": "length-zero-no-unit",
+    "code": "length-zero-no-unit",
+    "codeDescription": Object {
+      "href": "https://stylelint.io/user-guide/rules/length-zero-no-unit",
     },
     "message": "Unexpected unit (length-zero-no-unit)",
     "range": Object {
@@ -240,9 +240,9 @@ exports[`stylelintVSCode() with autofix autofix should work if there are errors
 Object {
   "diagnostics": Array [
     Object {
-      "code": Object {
-        "target": "https://stylelint.io/user-guide/rules/selector-type-no-unknown",
-        "value": "selector-type-no-unknown",
+      "code": "selector-type-no-unknown",
+      "codeDescription": Object {
+        "href": "https://stylelint.io/user-guide/rules/selector-type-no-unknown",
       },
       "message": "Unexpected unknown type selector \\"unknown\\" (selector-type-no-unknown)",
       "range": Object {
@@ -296,9 +296,9 @@ exports[`stylelintVSCode() with customSyntax should work properly if customSynta
 Object {
   "diagnostics": Array [
     Object {
-      "code": Object {
-        "target": "https://stylelint.io/user-guide/rules/indentation",
-        "value": "indentation",
+      "code": "indentation",
+      "codeDescription": Object {
+        "href": "https://stylelint.io/user-guide/rules/indentation",
       },
       "message": "Expected indentation of 2 spaces (indentation)",
       "range": Object {
@@ -377,9 +377,9 @@ exports[`stylelintVSCode() with reportNeedlessDisables should work properly if r
 Object {
   "diagnostics": Array [
     Object {
-      "code": Object {
-        "target": "https://stylelint.io/user-guide/rules/indentation",
-        "value": "indentation",
+      "code": "indentation",
+      "codeDescription": Object {
+        "href": "https://stylelint.io/user-guide/rules/indentation",
       },
       "message": "Expected indentation of 4 spaces (indentation)",
       "range": Object {
@@ -490,9 +490,9 @@ exports[`stylelintVSCode() with stylelintPath should work properly if stylelintP
 Object {
   "diagnostics": Array [
     Object {
-      "code": Object {
-        "target": "https://stylelint.io/user-guide/rules/indentation",
-        "value": "indentation",
+      "code": "indentation",
+      "codeDescription": Object {
+        "href": "https://stylelint.io/user-guide/rules/indentation",
       },
       "message": "Expected indentation of 2 spaces (indentation)",
       "range": Object {