Add `requireParamTypes` option to the `valid-jsdoc` rule
See original GitHub issueWhile using babel-plugin-typecheck, I realized that specifying parameter types is redundant, as they can be retrieved from the Flow syntax.
See TypeDoc’s DocComments for further reference about the accepted documentation format with requireParamTypes
set to false
. The default value of requireParamTypes
should be true
.
Issue Analytics
- State:
- Created 7 years ago
- Reactions:2
- Comments:9 (5 by maintainers)
Top Results From Across the Web
valid-jsdoc - ESLint - Pluggable JavaScript Linter
A pluggable and configurable linter tool for identifying and reporting on patterns in JavaScript. Maintain your code quality with ease.
Read more >eslint-plugin-jsdoc - npm
Start using eslint-plugin-jsdoc in your project by running `npm i ... eslintrcForExamples - Defaults to true in adding rules based on an ...
Read more >jsDoc rule - JSCS
requireParamTypes. Checks params in jsdoc contains type. Type: Boolean. Values: true. Context: functions. Tags: ...
Read more >Unsupported jsdoc rule fix - javascript - Stack Overflow
Using the .jsrc file, I'm getting the following error for my server/front-end files. It's throwing an error at the top of my files....
Read more >Use JSDoc: @param
The following examples show how to include names, types, and descriptions in a @param tag. ... You can add a hyphen before the...
Read more >Top Related Medium Post
No results found
Top Related StackOverflow Question
No results found
Troubleshoot Live Code
Lightrun enables developers to add logs, metrics and snapshots to live code - no restarts or redeploys required.
Start FreeTop Related Reddit Thread
No results found
Top Related Hackernoon Post
No results found
Top Related Tweet
No results found
Top Related Dev.to Post
No results found
Top Related Hashnode Post
No results found
Top GitHub Comments
@kripod I’m not sure if you are explaining ideal situation or what is happening right now. Are there any tools out there that would generate documentation by combining jsDoc and Flow? And in general, ESLint doesn’t naively support Flow. It’s only supported through
babel-eslint
. So we would need much more generic scenario to consider adding an option to disable typing for jsDoc in the core. Otherwise, this might be a good request to add toeslint-plugin-flowtype
Hi @kripod, thanks for your submission. Please take a moment to read over our guide on proposing rule changes: http://eslint.org/docs/developer-guide/contributing/new-rules
Specifically, we do require proposers to implement their suggestions if accepted, so your willingness to implement it is a key decision point.
Currently, the team is very focused on improving compatibility between JSCS and ESLint, so if you are not willing to work on a PR for this, I’m afraid there is a low chance this will end up getting accepted.