✨ Clicking on a rule's code in the tooltip open the rule's documentationUrl in the browser

README.md

@@ -16,8 +16,8 @@ Spectral is a flexible object linter with out of the box support for [OpenAPI](h
 
 ## Requirements
 
-- Node.js ^12.21 or >=14.13
-- Visual Studio Code version 1.48 or higher.
+- Node.js >= 20
+- Visual Studio Code version 1.95 or higher.
 
 ## Installation
 

client/package.json

@@ -1,12 +1,12 @@
 {
   "author": "Stoplight <[email protected]>",
   "dependencies": {
-    "vscode-languageclient": "^6.1.3"
+    "vscode-languageclient": "^9.0.1"
   },
   "description": "JSON/YAML linter with OpenAPI and custom ruleset support.",
   "displayName": "Spectral",
   "engines": {
-    "vscode": "^1.48.0",
+    "vscode": "^1.95.0",
     "node": "^12.20 || >=14.13"
   },
   "license": "Apache-2.0",
@@ -17,4 +17,4 @@
     "url": "https://github.com/stoplightio/vscode-spectral"
   },
   "version": "0.0.1"
-}
+}

client/src/__tests__/e2e/contexts/no_workspace_no_ruleset/run.e2e.test.ts.snap

@@ -3,7 +3,10 @@
 exports[`No workspace, no ruleset Invalid files trigger generation of diagnostics simple.json 1`] = `
 Array [
   Object {
-    "code": "oas3-api-servers",
+    "code": Object {
+      "target": "https://meta.stoplight.io/docs/spectral/docs/reference/openapi-rules.md#oas3-api-servers",
+      "value": "oas3-api-servers",
+    },
     "message": "OpenAPI \\"servers\\" must be present and non-empty array.",
     "range": Array [
       Object {
@@ -19,7 +22,10 @@ Array [
     "source": "spectral",
   },
   Object {
-    "code": "oas3-schema",
+    "code": Object {
+      "target": "https://meta.stoplight.io/docs/spectral/docs/reference/openapi-rules.md#oas3-schema",
+      "value": "oas3-schema",
+    },
     "message": "must have required property \\"paths\\".",
     "range": Array [
       Object {
@@ -35,7 +41,10 @@ Array [
     "source": "spectral",
   },
   Object {
-    "code": "info-contact",
+    "code": Object {
+      "target": "https://meta.stoplight.io/docs/spectral/docs/reference/openapi-rules.md#info-contact",
+      "value": "info-contact",
+    },
     "message": "Info object must have \\"contact\\" object.",
     "range": Array [
       Object {
@@ -51,7 +60,10 @@ Array [
     "source": "spectral",
   },
   Object {
-    "code": "info-description",
+    "code": Object {
+      "target": "https://meta.stoplight.io/docs/spectral/docs/reference/openapi-rules.md#info-description",
+      "value": "info-description",
+    },
     "message": "Info \\"description\\" must be present and non-empty string.",
     "range": Array [
       Object {
@@ -67,7 +79,10 @@ Array [
     "source": "spectral",
   },
   Object {
-    "code": "oas3-schema",
+    "code": Object {
+      "target": "https://meta.stoplight.io/docs/spectral/docs/reference/openapi-rules.md#oas3-schema",
+      "value": "oas3-schema",
+    },
     "message": "\\"info\\" property must be object.",
     "range": Array [
       Object {
@@ -88,7 +103,10 @@ Array [
 exports[`No workspace, no ruleset Invalid files trigger generation of diagnostics simple.yaml 1`] = `
 Array [
   Object {
-    "code": "oas3-api-servers",
+    "code": Object {
+      "target": "https://meta.stoplight.io/docs/spectral/docs/reference/openapi-rules.md#oas3-api-servers",
+      "value": "oas3-api-servers",
+    },
     "message": "OpenAPI \\"servers\\" must be present and non-empty array.",
     "range": Array [
       Object {
@@ -104,7 +122,10 @@ Array [
     "source": "spectral",
   },
   Object {
-    "code": "oas3-schema",
+    "code": Object {
+      "target": "https://meta.stoplight.io/docs/spectral/docs/reference/openapi-rules.md#oas3-schema",
+      "value": "oas3-schema",
+    },
     "message": "must have required property \\"paths\\".",
     "range": Array [
       Object {
@@ -120,7 +141,10 @@ Array [
     "source": "spectral",
   },
   Object {
-    "code": "info-contact",
+    "code": Object {
+      "target": "https://meta.stoplight.io/docs/spectral/docs/reference/openapi-rules.md#info-contact",
+      "value": "info-contact",
+    },
     "message": "Info object must have \\"contact\\" object.",
     "range": Array [
       Object {
@@ -136,7 +160,10 @@ Array [
     "source": "spectral",
   },
   Object {
-    "code": "info-description",
+    "code": Object {
+      "target": "https://meta.stoplight.io/docs/spectral/docs/reference/openapi-rules.md#info-description",
+      "value": "info-description",
+    },
     "message": "Info \\"description\\" must be present and non-empty string.",
     "range": Array [
       Object {
@@ -152,7 +179,10 @@ Array [
     "source": "spectral",
   },
   Object {
-    "code": "oas3-schema",
+    "code": Object {
+      "target": "https://meta.stoplight.io/docs/spectral/docs/reference/openapi-rules.md#oas3-schema",
+      "value": "oas3-schema",
+    },
     "message": "\\"info\\" property must be object.",
     "range": Array [
       Object {

client/src/__tests__/e2e/contexts/workspace_basic_ruleset/run.e2e.test.ts.snap

@@ -3,7 +3,10 @@
 exports[`Workspace, basic ruleset Invalid files trigger generation of diagnostics simple.json 1`] = `
 Array [
   Object {
-    "code": "oas3-api-servers",
+    "code": Object {
+      "target": "https://meta.stoplight.io/docs/spectral/docs/reference/openapi-rules.md#oas3-api-servers",
+      "value": "oas3-api-servers",
+    },
     "message": "OpenAPI \\"servers\\" must be present and non-empty array.",
     "range": Array [
       Object {
@@ -19,7 +22,10 @@ Array [
     "source": "spectral",
   },
   Object {
-    "code": "oas3-schema",
+    "code": Object {
+      "target": "https://meta.stoplight.io/docs/spectral/docs/reference/openapi-rules.md#oas3-schema",
+      "value": "oas3-schema",
+    },
     "message": "must have required property \\"paths\\".",
     "range": Array [
       Object {
@@ -35,7 +41,10 @@ Array [
     "source": "spectral",
   },
   Object {
-    "code": "info-description",
+    "code": Object {
+      "target": "https://meta.stoplight.io/docs/spectral/docs/reference/openapi-rules.md#info-description",
+      "value": "info-description",
+    },
     "message": "Info \\"description\\" must be present and non-empty string.",
     "range": Array [
       Object {
@@ -51,7 +60,10 @@ Array [
     "source": "spectral",
   },
   Object {
-    "code": "oas3-schema",
+    "code": Object {
+      "target": "https://meta.stoplight.io/docs/spectral/docs/reference/openapi-rules.md#oas3-schema",
+      "value": "oas3-schema",
+    },
     "message": "\\"info\\" property must be object.",
     "range": Array [
       Object {
@@ -72,7 +84,10 @@ Array [
 exports[`Workspace, basic ruleset Invalid files trigger generation of diagnostics simple.yaml 1`] = `
 Array [
   Object {
-    "code": "oas3-api-servers",
+    "code": Object {
+      "target": "https://meta.stoplight.io/docs/spectral/docs/reference/openapi-rules.md#oas3-api-servers",
+      "value": "oas3-api-servers",
+    },
     "message": "OpenAPI \\"servers\\" must be present and non-empty array.",
     "range": Array [
       Object {
@@ -88,7 +103,10 @@ Array [
     "source": "spectral",
   },
   Object {
-    "code": "oas3-schema",
+    "code": Object {
+      "target": "https://meta.stoplight.io/docs/spectral/docs/reference/openapi-rules.md#oas3-schema",
+      "value": "oas3-schema",
+    },
     "message": "must have required property \\"paths\\".",
     "range": Array [
       Object {
@@ -104,7 +122,10 @@ Array [
     "source": "spectral",
   },
   Object {
-    "code": "info-description",
+    "code": Object {
+      "target": "https://meta.stoplight.io/docs/spectral/docs/reference/openapi-rules.md#info-description",
+      "value": "info-description",
+    },
     "message": "Info \\"description\\" must be present and non-empty string.",
     "range": Array [
       Object {
@@ -120,7 +141,10 @@ Array [
     "source": "spectral",
   },
   Object {
-    "code": "oas3-schema",
+    "code": Object {
+      "target": "https://meta.stoplight.io/docs/spectral/docs/reference/openapi-rules.md#oas3-schema",
+      "value": "oas3-schema",
+    },
     "message": "\\"info\\" property must be object.",
     "range": Array [
       Object {

client/src/__tests__/e2e/contexts/workspace_basic_ruleset_negative_globs/run.e2e.test.ts.snap

@@ -7,7 +7,10 @@ exports[`Workspace, basic ruleset negative globs Invalid files trigger generatio
 exports[`Workspace, basic ruleset negative globs Invalid files trigger generation of diagnostics but only if not ignored simple.yaml 1`] = `
 Array [
   Object {
-    "code": "oas3-api-servers",
+    "code": Object {
+      "target": "https://meta.stoplight.io/docs/spectral/docs/reference/openapi-rules.md#oas3-api-servers",
+      "value": "oas3-api-servers",
+    },
     "message": "OpenAPI \\"servers\\" must be present and non-empty array.",
     "range": Array [
       Object {
@@ -23,7 +26,10 @@ Array [
     "source": "spectral",
   },
   Object {
-    "code": "oas3-schema",
+    "code": Object {
+      "target": "https://meta.stoplight.io/docs/spectral/docs/reference/openapi-rules.md#oas3-schema",
+      "value": "oas3-schema",
+    },
     "message": "must have required property \\"paths\\".",
     "range": Array [
       Object {
@@ -39,7 +45,10 @@ Array [
     "source": "spectral",
   },
   Object {
-    "code": "info-description",
+    "code": Object {
+      "target": "https://meta.stoplight.io/docs/spectral/docs/reference/openapi-rules.md#info-description",
+      "value": "info-description",
+    },
     "message": "Info \\"description\\" must be present and non-empty string.",
     "range": Array [
       Object {
@@ -55,7 +64,10 @@ Array [
     "source": "spectral",
   },
   Object {
-    "code": "oas3-schema",
+    "code": Object {
+      "target": "https://meta.stoplight.io/docs/spectral/docs/reference/openapi-rules.md#oas3-schema",
+      "value": "oas3-schema",
+    },
     "message": "\\"info\\" property must be object.",
     "range": Array [
       Object {

client/src/__tests__/e2e/contexts/workspace_remote_ruleset_js/run.e2e.test.ts.snap

@@ -3,7 +3,10 @@
 exports[`Workspace, remote ruleset js Invalid files trigger generation of diagnostics simple.json 1`] = `
 Array [
   Object {
-    "code": "oas3-api-servers",
+    "code": Object {
+      "target": "https://meta.stoplight.io/docs/spectral/docs/reference/openapi-rules.md#oas3-api-servers",
+      "value": "oas3-api-servers",
+    },
     "message": "OpenAPI \\"servers\\" must be present and non-empty array.",
     "range": Array [
       Object {
@@ -19,7 +22,10 @@ Array [
     "source": "spectral",
   },
   Object {
-    "code": "oas3-schema",
+    "code": Object {
+      "target": "https://meta.stoplight.io/docs/spectral/docs/reference/openapi-rules.md#oas3-schema",
+      "value": "oas3-schema",
+    },
     "message": "must have required property \\"paths\\".",
     "range": Array [
       Object {
@@ -35,7 +41,10 @@ Array [
     "source": "spectral",
   },
   Object {
-    "code": "info-description",
+    "code": Object {
+      "target": "https://meta.stoplight.io/docs/spectral/docs/reference/openapi-rules.md#info-description",
+      "value": "info-description",
+    },
     "message": "Info \\"description\\" must be present and non-empty string.",
     "range": Array [
       Object {
@@ -51,7 +60,10 @@ Array [
     "source": "spectral",
   },
   Object {
-    "code": "oas3-schema",
+    "code": Object {
+      "target": "https://meta.stoplight.io/docs/spectral/docs/reference/openapi-rules.md#oas3-schema",
+      "value": "oas3-schema",
+    },
     "message": "\\"info\\" property must be object.",
     "range": Array [
       Object {
@@ -72,7 +84,10 @@ Array [
 exports[`Workspace, remote ruleset js Invalid files trigger generation of diagnostics simple.yaml 1`] = `
 Array [
   Object {
-    "code": "oas3-api-servers",
+    "code": Object {
+      "target": "https://meta.stoplight.io/docs/spectral/docs/reference/openapi-rules.md#oas3-api-servers",
+      "value": "oas3-api-servers",
+    },
     "message": "OpenAPI \\"servers\\" must be present and non-empty array.",
     "range": Array [
       Object {
@@ -88,7 +103,10 @@ Array [
     "source": "spectral",
   },
   Object {
-    "code": "oas3-schema",
+    "code": Object {
+      "target": "https://meta.stoplight.io/docs/spectral/docs/reference/openapi-rules.md#oas3-schema",
+      "value": "oas3-schema",
+    },
     "message": "must have required property \\"paths\\".",
     "range": Array [
       Object {
@@ -104,7 +122,10 @@ Array [
     "source": "spectral",
   },
   Object {
-    "code": "info-description",
+    "code": Object {
+      "target": "https://meta.stoplight.io/docs/spectral/docs/reference/openapi-rules.md#info-description",
+      "value": "info-description",
+    },
     "message": "Info \\"description\\" must be present and non-empty string.",
     "range": Array [
       Object {
@@ -120,7 +141,10 @@ Array [
     "source": "spectral",
   },
   Object {
-    "code": "oas3-schema",
+    "code": Object {
+      "target": "https://meta.stoplight.io/docs/spectral/docs/reference/openapi-rules.md#oas3-schema",
+      "value": "oas3-schema",
+    },
     "message": "\\"info\\" property must be object.",
     "range": Array [
       Object {