Commit 78265e0
tools: use jsdoc recommended rules
Enable all recommended JSDoc linting rules and disable the ones we don't
(yet?) meet. They can be enabled one by one by removing the lines that
turn them off.
This requires adding --max-warnings to the ESLint invocations in
Makefile and vcbuild.bat because the preset enables the recommended
rules as warnings and not errors.
PR-URL: #41057
Reviewed-By: Michaël Zasso <targos@protonmail.com>
Reviewed-By: James M Snell <jasnell@gmail.com>
Reviewed-By: Ruben Bridgewater <ruben@bridgewater.de>1 parent 94d0911 commit 78265e0
3 files changed
Lines changed: 20 additions & 4 deletions
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
@@ -35,6 +35,7 @@ Module._findPath = (request, paths, isMain) => { | |||
| 35 | 35 | ||
| 36 | 36 | module.exports = { | |
| 37 | 37 | root: true, | |
| 38 | + extends: ['plugin:jsdoc/recommended'], | ||
| 38 | 39 | plugins: ['jsdoc', 'markdown', 'node-core'], | |
| 39 | 40 | parser: '@babel/eslint-parser', | |
| 40 | 41 | parserOptions: { | |
@@ -338,7 +339,22 @@ module.exports = { | |||
| 338 | 339 | 'valid-typeof': ['error', { requireStringLiterals: true }], | |
| 339 | 340 | ||
| 340 | 341 | // JSDoc rules | |
| 341 | - 'jsdoc/check-types': 'error', | ||
| 342 | + 'jsdoc/require-jsdoc': 'off', | ||
| 343 | + 'jsdoc/require-param-description': 'off', | ||
| 344 | + 'jsdoc/newline-after-description': 'off', | ||
| 345 | + 'jsdoc/require-returns-description': 'off', | ||
| 346 | + 'jsdoc/valid-types': 'off', | ||
| 347 | + 'jsdoc/no-undefined-types': 'off', | ||
| 348 | + 'jsdoc/require-param': 'off', | ||
| 349 | + 'jsdoc/check-tag-names': 'off', | ||
| 350 | + 'jsdoc/require-returns': 'off', | ||
| 351 | + 'jsdoc/require-property-description': 'off', | ||
| 352 | + 'jsdoc/check-param-names': 'off', | ||
| 353 | + 'jsdoc/tag-lines': 'off', | ||
| 354 | + 'jsdoc/require-returns-type': 'off', | ||
| 355 | + 'jsdoc/check-alignment': 'off', | ||
| 356 | + 'jsdoc/require-returns-check': 'off', | ||
| 357 | + 'jsdoc/require-param-name': 'off', | ||
| 342 | 358 | ||
| 343 | 359 | // Custom rules from eslint-plugin-node-core | |
| 344 | 360 | 'node-core/no-unescaped-regexp-dot': 'error', | |
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
@@ -1268,7 +1268,7 @@ format-md: | |||
| 1268 | 1268 | LINT_JS_TARGETS = .eslintrc.js benchmark doc lib test tools | |
| 1269 | 1269 | ||
| 1270 | 1270 | run-lint-js = tools/node_modules/eslint/bin/eslint.js --cache \ | |
| 1271 | - --report-unused-disable-directives $(LINT_JS_TARGETS) | ||
| 1271 | + --max-warnings=0 --report-unused-disable-directives $(LINT_JS_TARGETS) | ||
| 1272 | 1272 | run-lint-js-fix = $(run-lint-js) --fix | |
| 1273 | 1273 | ||
| 1274 | 1274 | .PHONY: lint-js-fix | |
@@ -1292,7 +1292,7 @@ jslint: lint-js | |||
| 1292 | 1292 | $(warning Please use lint-js instead of jslint) | |
| 1293 | 1293 | ||
| 1294 | 1294 | run-lint-js-ci = tools/node_modules/eslint/bin/eslint.js \ | |
| 1295 | - --report-unused-disable-directives -f tap \ | ||
| 1295 | + --max-warnings=0 --report-unused-disable-directives -f tap \ | ||
| 1296 | 1296 | -o test-eslint.tap $(LINT_JS_TARGETS) | |
| 1297 | 1297 | ||
| 1298 | 1298 | .PHONY: lint-js-ci | |
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
@@ -699,7 +699,7 @@ goto lint-js | |||
| 699 | 699 | if not defined lint_js goto lint-md-build | |
| 700 | 700 | if not exist tools\node_modules\eslint goto no-lint | |
| 701 | 701 | echo running lint-js | |
| 702 | - %node_exe% tools\node_modules\eslint\bin\eslint.js --cache --report-unused-disable-directives --rule "linebreak-style: 0" .eslintrc.js benchmark doc lib test tools | ||
| 702 | + %node_exe% tools\node_modules\eslint\bin\eslint.js --cache --max-warnings=0 --report-unused-disable-directives --rule "linebreak-style: 0" .eslintrc.js benchmark doc lib test tools | ||
| 703 | 703 | goto lint-md-build | |
| 704 | 704 | ||
| 705 | 705 | :no-lint | |
0 commit comments