Skip to content
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.

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

Add jsdoc type annotation to rules #219

Merged
merged 2 commits into from Nov 14, 2021

Conversation

bmish
Copy link
Collaborator

@bmish bmish commented Nov 11, 2021

Supported by VSCode/Webstorm/other code editors. Uses TypeScript declaration to give JavaScript hints so code editors can provide information/autocomplete about various rule fields.

https://www.typescriptlang.org/docs/handbook/jsdoc-supported-types.html#type

Idea from: eslint/generator-eslint#113

133895350-a19d0daf-593e-44b9-835f-bebf8b6a3d30

@coveralls
Copy link

coveralls commented Nov 11, 2021

Coverage Status

Coverage remained the same at 100.0% when pulling a9352fb on bmish:jsdoc-type-rules into f1b6258 on platinumazure:master.

@platinumazure
Copy link
Owner

Thanks @bmish for putting this together! Need to review and merge when time allows but I wanted to say I appreciate the contribution.

Copy link
Owner

@platinumazure platinumazure left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This looks good, but I'm wondering if there's a way to test for this. I would hate to forget the type annotation in new rules... If that's too difficult, we can merge this as is, but I wanted to ask. Thanks!

@bmish
Copy link
Collaborator Author

bmish commented Nov 14, 2021

@platinumazure sure, I added a test.

@platinumazure platinumazure merged commit 5da4256 into platinumazure:master Nov 14, 2021
@platinumazure
Copy link
Owner

Thanks for contributing!

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

3 participants