Add link to ESLint rules via url attribute of the Diagnostic API #562
Conversation
|
|
| * Licensed under the MIT License. See License.txt in the project root for license information. | ||
| * ------------------------------------------------------------------------------------------ */ | ||
| declare module "eslint-rule-documentation" { | ||
| export default function ruleURI(ruleId: string): { found: boolean, url: string }; |
There was a problem hiding this comment.
This isn't the correct type signature – the function is a CommonJS module.exports. I couldn't figure out how to type those correctly.
There was a problem hiding this comment.
A good doc on how to create these declaration files can be found here: https://www.typescriptlang.org/docs/handbook/declaration-files/introduction.html
There was a problem hiding this comment.
Arr thank you, I had looked at these docs but totally missed the relevant template (https://www.typescriptlang.org/docs/handbook/declaration-files/templates/module-function-d-ts.html). Will update this later.
| ruleURLs.set(problem.ruleId, url); | ||
| } | ||
| // @ts-ignore TODO Ignoring "property URL does not exist" for now. It will exist in the newest version of vscode. | ||
| diagnostic.url = url; |
There was a problem hiding this comment.
This type error will go away when relying on a version of VS Code that has a URL attribute for diagnostics. For local devs, I was using an npm linked version, but that didn't seem to be enough.
| @@ -819,6 +834,26 @@ function validate(document: TextDocument, settings: TextDocumentSettings, publis | |||
| } | |||
|
|
|||
| let cli = new settings.library.CLIEngine(newOptions); | |||
|
|
|||
| // cache documentation urls for all rules | |||
| if (cli.getRules) { | |||
There was a problem hiding this comment.
As far as I can tell, the implementation in master would fail for ESLint versions below v4.15.0 (jan 2018).
| if (!url) { | ||
| // @ts-ignore TODO: Should type-check the 3rd-party module. | ||
| url = ruleURI(problem.ruleId).url; | ||
| ruleURLs.set(problem.ruleId, url); |
There was a problem hiding this comment.
If the URL isn't in the cache, it's not from the rule's metadata. So we use eslint-rule-documentation directly, and then set its result in the cache.
|
Closing because of microsoft/vscode#61436 (comment). |
Fixes #151. Relies on microsoft/vscode#61436 to implement diagnostic URLs in VS Code (fixing microsoft/vscode#11847), as well as microsoft/vscode-languageserver-node#432.
This PR does three things:
eslint-rule-documentationto retrieve URLs as a fallback to the rules metadata, so older versions of ESLint / older versions of plugin rules can also benefit from URLs.CLIEngine#getRules().urlattribute of diagnostics to forward the ESLint rule's URL to VS Code, for display wherever.Changes 1. and 2. could be useful now without further changes in VS Code or anywhere else. I can make separate PRs for these if they seem desirable enough.
Here is what the end result looks like at the moment (WIP):
The instructions to try this out locally are at the end of microsoft/vscode#61436.