Update: Add type jsdoc to rule template #113
Conversation
|
|
bmish
changed the title
|
Neat! Can you explain a bit more about how this works and the benefits it provides in the PR description? It looks like this allows code editors to see the type/structure of ESLint rule objects and thus provide information/autocomplete about the various rule fields. I like it.
If this turns out to be the recommended way to annotate non-TypeScript rules with type information, then we could also add it to the Working with Rules rule example: eslint/eslint#15085 |
bmish
changed the title
|
This is the feature of vscode, and it seems also to be supported by webstorm. |
| @@ -8,6 +8,9 @@ | |||
| // Rule Definition | |||
| //------------------------------------------------------------------------------ | |||
|
|
|||
| /** | |||
| * @type {import('eslint').Rule.RuleModule} | |||
There was a problem hiding this comment.
Do we need to include @types/eslint to make this work?
There was a problem hiding this comment.
My understanding is no. VSCode has Automatic Type Acquistion where it automatically retrieves the corresponding @types/ package for your dependencies.
There was a problem hiding this comment.
Huh, that’s cool. I wonder if that has any negative effect when running tsc? I don’t want to please VS Code only to anger TypeScript. Can you double check that?
There was a problem hiding this comment.
These rules are JS files so I don't think anyone will be running tsc with them?
However, I checked what happens when using @type in a TS file, and TS shows a non-blocking hint:
JSDoc types may be moved to TypeScript types. ts(80004)
There was a problem hiding this comment.
Fair enough. I run TSC on JavaScript files frequently to generate .d.ts files from JSDoc comments. :)
No description provided.