Skip to content

Replace eslint-plugin-jsdoc by extending local jsdoc-format rule, saving ~20% of our linting time - #51438

Merged
Jake Bailey (jakebailey) merged 4 commits into
microsoft:mainfrom
jakebailey:remove-eslint-jsdoc
Nov 8, 2022
Merged

Jake Bailey (jakebailey) merged 4 commits into
microsoft:mainfrom
jakebailey:remove-eslint-jsdoc

Conversation

@jakebailey

@jakebailey Jake Bailey (jakebailey) commented Nov 8, 2022 •

Copy link
Copy Markdown
Member

I had to write an ESLint rule for our JSDoc comments in the module conversion anyway. Extend it to do some basic checking of the alignment of the comments, which is all we use the jsdoc plugin for. (To be clear, I wrote this logic from scratch; the jsdoc plugin probably does a lot more.)

Before:

npx eslint .  54.13s user 2.26s system 148% cpu 37.867 total

After:

npx eslint .  47.32s user 2.15s system 155% cpu 31.846 total

Probably deserves a test or two; I neglected writing any for my original rule.

Comment thread scripts/eslint/rules/jsdoc-format.cjs Outdated
@sheetalkamat

Copy link
Copy Markdown
Member

Perf is always great

@jakebailey
Jake Bailey (jakebailey) marked this pull request as ready for review November 8, 2022 05:44
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.

Labels

Author: Team For Uncommitted Bug PR for untriaged, rejected, closed or missing bug

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants