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

ESLint JSDoc is not as strict as it could be #1751

Open
michaelfig opened this issue Sep 14, 2020 · 0 comments
Open

ESLint JSDoc is not as strict as it could be #1751

michaelfig opened this issue Sep 14, 2020 · 0 comments
Assignees
Labels
hygiene Tidying up around the house

Comments

@michaelfig
Copy link
Member

Our use of the ESLint JSDoc plugin should support all JSDoc types known by Typescript.

However, gajus/eslint-plugin-jsdoc#637 indicates that some JSDocs will be flagged with jsdoc/valid-types, so I had to add:

/* eslint-disable jsdoc/valid-types */
...
/* eslint-enable jsdoc/valid-types */

to make some Typescript syntax pass (asserts ..., x is Foo, and others).

When that bug is resolved, we should remove the eslint disable/enables.

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

No branches or pull requests

2 participants