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

Validate invalid params through tsdoc eslint plugin #353

Open
tvvignesh opened this issue May 24, 2023 · 1 comment
Open

Validate invalid params through tsdoc eslint plugin #353

tvvignesh opened this issue May 24, 2023 · 1 comment

Comments

@tvvignesh
Copy link

Hi. I installed the tsdoc plugin and while it works well, its unable to detect invalid params like the one you see below. Kindly let me know how to validate such param. Thanks

image

As you see 2 params doesn't exist but the linter doesn't pick it up

@nbouvrette
Copy link

nbouvrette commented Aug 31, 2023

If this can be useful to anyone.. I thought I could create a quick ESLint rule to fix this and got down the rabbit hole: https://gist.github.com/nbouvrette/f2c90316533e5a6c1f7702e35e4a586a

There are a lot of details to check but I think this covers most of the @param validity.

You can use it locally with the correct setup (more info here: typescript-eslint/typescript-eslint#7284 (comment))

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

No branches or pull requests

2 participants