Skip to content
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.

Sign up for GitHub

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

Jump to bottom

tools: enable jsdoc recommended rules #41057

Closed
wants to merge 3 commits into from
Closed

tools: enable jsdoc recommended rules #41057

wants to merge 3 commits into from

Commits on Dec 5, 2021

  1. 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: nodejs#41057
Reviewed-By: Michaël Zasso <targos@protonmail.com>
Reviewed-By: James M Snell <jasnell@gmail.com>
Reviewed-By: Ruben Bridgewater <ruben@bridgewater.de>
    @Trott
    Trott committed Dec 5, 2021
    Configuration menu
    Copy the full SHA
    6dae965 View commit details
    Browse the repository at this point in the history

  2. test: add missing JSDoc parameter name 

    PR-URL: nodejs#41057
Reviewed-By: Michaël Zasso <targos@protonmail.com>
Reviewed-By: James M Snell <jasnell@gmail.com>
Reviewed-By: Ruben Bridgewater <ruben@bridgewater.de>
    @Trott
    Trott committed Dec 5, 2021
    Configuration menu
    Copy the full SHA
    87f1311 View commit details
    Browse the repository at this point in the history

  3. tools: enable jsdoc/require-param-name lint rule 

    PR-URL: nodejs#41057
Reviewed-By: Michaël Zasso <targos@protonmail.com>
Reviewed-By: James M Snell <jasnell@gmail.com>
Reviewed-By: Ruben Bridgewater <ruben@bridgewater.de>
    @Trott
    Trott committed Dec 5, 2021
    Configuration menu
    Copy the full SHA
    147d23b View commit details
    Browse the repository at this point in the history