Require JsDoc on validators #44893

Activity

1. anonrig

   added

   feature requestIssues requesting new Node.js features.Issues requesting new Node.js features.

   on Oct 4, 2022
2. Trott commented on Oct 5, 2022

   

   Trott

   on Oct 5, 2022

   Member

   More actions

   We already use eslint-plugin-jsdoc for JSDoc linting. We turn on the recommended rules for it:

   node/.eslintrc.js

   Lines 41 to 42 in e84e2e6

   	extends: ['eslint:recommended', 'plugin:jsdoc/recommended'],
   	plugins: ['jsdoc', 'markdown', 'node-core'],

   But then we turn a bunch of them off:

   node/.eslintrc.js

   Lines 304 to 314 in e84e2e6

   	// JSDoc recommended rules that we disable
   	'jsdoc/require-jsdoc': 'off',
   	'jsdoc/require-param-description': 'off',
   	'jsdoc/newline-after-description': 'off',
   	'jsdoc/require-returns-description': 'off',
   	'jsdoc/valid-types': 'off',
   	'jsdoc/no-undefined-types': 'off',
   	'jsdoc/require-param': 'off',
   	'jsdoc/check-tag-names': 'off',
   	'jsdoc/require-returns': 'off',
   	'jsdoc/require-property-description': 'off',

   So maybe enabling one of those disabled rules will accomplish what you are looking for?
3. Trott commented on Oct 5, 2022

   

   Trott

   on Oct 5, 2022

   Member

   More actions

   Does #44896 do what you are looking for? Or are there validators in other files that you are looking to apply JSDoc comments to?

   🎉React with 🎉1Reacted by tianc43

   🚀React with 🚀1Reacted by Yagiz Nizipli
4. anonrig commented on Oct 5, 2022

   

   anonrig

   on Oct 5, 2022

   MemberAuthor

   More actions

   Yes this was what I was looking for. Thanks @Trott
5. Trott

   closed this as completedin c50987eon Oct 7, 2022
6. danielleadams

   added a commit that references this issue on Oct 11, 2022

   lib: require JSDoc in internal validators code

   ...

   ada7d82