chore: add eslint-plugin-jsdoc #205
Conversation
✅ Deploy Preview for valibot canceled.
|
library/src/methods/merge/merge.ts
Outdated
| @@ -16,36 +16,27 @@ type ObjectSchemas = [ | |||
| ...ObjectSchema<any>[] | |||
| ]; | |||
|
|
|||
| /** | |||
There was a problem hiding this comment.
In these cases, I prefer to keep the commented overflow signatures and leave the implementation uncommented. Can we configure that?
There was a problem hiding this comment.
Could you find a solution for this?
There was a problem hiding this comment.
I prefer to keep the commented overflow signatures and leave the implementation uncommented.
Yes!
By configuring like this, this can be implemented 😄
For overloaded functions, we only have to write one JSDoc at the top.
And I also deleted the JSDocs of implementation part.
There was a problem hiding this comment.
Thank you! I will have a look at the changes in the evening or tomorrow.
|
Otherwise this PR looks good and is ready to be merged. Thank you! |
|
Can you try to sync the repo and merge the current main branch into your feature branch? I made a few structural changes. |
…re/inplement-eslint-jsdoc
|
Thank you again for your work! I will check the changes and try to merge this PR on the weekend! |
|
@kazizi55 thank you so much for all you did and do for Valibot! I plan to make contributors like you more visible in the long run, and am generally interested in building a team around Valibot and my other projects. |
|
@fabian-hiller
Sounds great!! |
Yes, I would be delighted. But at the moment these are just initial ideas. Let's discuss this in more detail in January when I have more time again. 🚀 |
|
@fabian-hiller |
Implements #185.
I chose not
plugin:jsdoc/recommended-typescript, butplugin:jsdoc/recommended-typescript-error, so that the review time and effort can be reduced. 😄FYI
https://github.com/gajus/eslint-plugin-jsdoc#readme:~:text=typescript%22%5D%0A%7D-,...or%20to%20report%20with%20failing%20errors%20instead%20of%20mere%20warnings%3A,-%7B%0A%20%20%22extends%22