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

[ouvreboite]

Fixes #235

Allow to "click to know more" on a problem's rule code, using the rule/ruleset documentationUrl.

This allow the user to access a richer documentation and to not be restricted to just the error message/error code.

Checklist

• Tests added / updated
• Docs added / updated (I'm not sure there are docs that need to be updated)

Does this PR introduce a breaking change?

• Yes
• No

The error-code becomes clickable (in the Problems view but also in the tooltip).

The link is constructed following the rules defined here:

• if the rule has it's own documentationUrl, we use it
• otherwise we use the ruleset's documentationUrl (if it exists), with #the-rule-code appended
• the implementation also work for extended rulesets has we access each rule's "owner" (i.e. owning ruleset)

Additional context

🚨This feature requires Diagnostic.codeDescription, with is available in https://www.npmjs.com/package/vscode-languageserver-types > 3.16, which required upgrading some other vscode-languageserver and client dependencies.

I'm using a basic ruleset to test it locally, but I've not pushed it:

formats: ["oas3"]
documentationUrl: https://example.com
extends: spectral:oas
rules:
  with-direct-documentation: #should have the doc https://example.com/direct
    documentationUrl: https://example.com/direct
    severity: error
    given: $.tags[*]
    then:
      field: description
      function: falsy
  without-direct-documentation: #should have the doc https://example.com#without-direct-documentation
    severity: error
    given: $.tags[*]
    then:
      field: description
      function: truthy

[mnaumanali94]

@ouvreboite Would you mind fixing the conflicts? I'd love to get this merged 🙏🏼

[ouvreboite]

@mnaumanali94 this should be good now :)

[mnaumanali94]

@ouvreboite Thanks for the quick turnaround and your contribution. I'll work on getting this out.

[mnaumanali94]

@ouvreboite e2e tests are failing. Do you want to take a look? Otherwise i'll give it a go later 🙏🏼

[ouvreboite]

I'll have a quick look.

⏳

• Also failing locally, when running node make.js allDev, with a similar console output.
• I'm able to make the E2E tests runs by upgrading the vscode dependencies
• Need to update the snapshots
• Somehow the documentationUrl does not show in the snapshot of the E2E test for the .yaml file
  • Seems to be an artefact of how the vscode.Uri is serialized in the snapshots

[ouvreboite]

@mnaumanali94

• I've pushed updated snapshots for the E2E tests
• On my machine, I also had to upgrade the VSCode dependencies (targeting the latest VSCode version). I don't understand why this would be needed, so I've not pushed yet. Do you want me to push it?
• I've noted that the generated documentation url for the base rule set look like this (as expected): https://meta.stoplight.io/docs/spectral/docs/reference/openapi-rules.md#oas3-api-servers
  • But, if you follow the link, there is a redirection to https://meta.stoplight.io/docs/spectral/4dec24461f3af-open-api-rules (I suppose there is some kind of URL versioning happening). So, this get you to the ruleset's doc, but the #oas3-api-servers is lost during the redirection 😞.

[mnaumanali94]

I've pushed updated snapshots for the E2E tests
On my machine, I also had to upgrade the VSCode dependencies (targeting the latest VSCode version). I don't understand why this would be needed, so I've not pushed yet. Do you want me to push it?

Yes push away. I can take a look

I've noted that the generated documentation url for the base rule set look like this (as expected): https://meta.stoplight.io/docs/spectral/docs/reference/openapi-rules.md#oas3-api-servers
But, if you follow the link, there is a redirection to https://meta.stoplight.io/docs/spectral/4dec24461f3af-open-api-rules (I suppose there is some kind of URL versioning happening). So, this get you to the ruleset's doc, but the #oas3-api-servers is lost during the redirection 😞.

We can fix the links in the ruleset separate from this feature.

[ouvreboite]

@mnaumanali94 I've pushed a new commit with the VSCode upgrade