-
-
Notifications
You must be signed in to change notification settings - Fork 224
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 eslint-plugin-jsdoc #185
Comments
Thank you for creating this issue! Good idea to improve that!
Does this require writing the type information twice? Once in TypeScript and once in JSDoc? |
@fabian-hiller
Yeah, That's true 🙏 So can I make a PR to add eslint-plugin-jsdoc without the rule to force to write type infomation in JSDoc? |
I would prefer to avoid writing the type information twice. 🤔 What is the advantage of having this information in JSDoc as well? |
Yes, now I totally agree with you 😄
So I also think there is no advantage of having type information in JSDoc as well. I'd like to add eslint-plugin-jsdoc with the recommended rules of With the rules, this eslint plugin DOES NOT check whether there is type information in JSDoc. example with the recommended rules of `jsdoc/recommended-typescript`
|
Sounds good. Feel free to create a PR. |
Hello 👋 |
Thank you for the hint! We should look at it for PR #205. |
Now, JSDoc is written in almost every module in valibot. This is full of warm hospitality, I think! 😄
But, sometimes JSDoc information is wrong.
For example, the actual param names are different from JSDoc defined param names.
valibot/library/src/utils/getSchemaIssues/getSchemaIssues.ts
Lines 9 to 28 in f367906
https://github.com/kazizi55/valibot/blob/f3679064037eae9bd31c97d32aa78517d12b76d9/library/src/utils/getPipeIssues/getPipeIssues.ts#L5-L17
And I think developer experience will be greater if JSDoc has also type information.
So I believe eslint-plugin-jsdoc will be good option to solve this problem.
And if adopted, I think it's enough to just add
plugin:jsdoc/recommended
.What do you think about this plugin?
example with eslint-plugin-jsdoc recommend rules
The text was updated successfully, but these errors were encountered: