Skip to content

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

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
ouvreboite wants to merge 4 commits into
base: master
Choose a base branch
from
Open

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

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
9111e4c
⬆️ Upgrade to vscode server 9.0.1
Jul 26, 2024
42c8022
✨ Provide the rule's documentation url has codeDescription
Jul 26, 2024
ab67552
✅ Update E2E for rule's documentation URL
ouvreboite Nov 25, 2024
a12d039
⬆️ Update to latest VSCode dependencies
ouvreboite Nov 26, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 2 additions & 2 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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

Expand Down
6 changes: 3 additions & 3 deletions client/package.json
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,12 +1,12 @@
{
"author": "Stoplight <support@stoplight.io>",
"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",
Expand All @@ -17,4 +17,4 @@
"url": "https://github.com/stoplightio/vscode-spectral"
},
"version": "0.0.1"
}
}
50 changes: 40 additions & 10 deletions client/src/__tests__/e2e/contexts/no_workspace_no_ruleset/run.e2e.test.ts.snap
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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 {
Expand All @@ -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 {
Expand All @@ -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 {
Expand All @@ -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 {
Expand All @@ -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 {
Expand All @@ -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 {
Expand All @@ -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 {
Expand All @@ -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 {
Expand All @@ -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 {
Expand All @@ -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 {
Expand Down
40 changes: 32 additions & 8 deletions client/src/__tests__/e2e/contexts/workspace_basic_ruleset/run.e2e.test.ts.snap
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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 {
Expand All @@ -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 {
Expand All @@ -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 {
Expand All @@ -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 {
Expand All @@ -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 {
Expand All @@ -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 {
Expand All @@ -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 {
Expand All @@ -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 {
Expand Down
20 changes: 16 additions & 4 deletions ...nt/src/__tests__/e2e/contexts/workspace_basic_ruleset_negative_globs/run.e2e.test.ts.snap
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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 {
Expand All @@ -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 {
Expand All @@ -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 {
Expand All @@ -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 {
Expand Down
40 changes: 32 additions & 8 deletions client/src/__tests__/e2e/contexts/workspace_remote_ruleset_js/run.e2e.test.ts.snap
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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 {
Expand All @@ -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 {
Expand All @@ -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 {
Expand All @@ -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 {
Expand All @@ -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 {
Expand All @@ -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 {
Expand All @@ -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 {
Expand All @@ -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 {
Expand Down
Loading