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.
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
Chore: Upgrade eslint-plugin-jsdoc to v25 and remove --legacy-peer-deps #14244
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This is a Chore instead of an Upgrade because it's in `devDependencies`. v25 is the first release of `eslint-plugin-jsdoc` to bump the `eslint` peer dependency to allow `eslint@7`. Once it's upgraded, we won't have to use `--legacy-peer-deps` to install dependencies with npm v7. The newer version was unsatisfied with the `cliOptions` param to `translateOptions` typed as just `Object`, so I turned our Optionator config into a JSDoc typedef.
`eslint-plugin-jsdoc` was the last upgrade needed to be compatible with the new peer dependency resolution in npm v7.
btmills
added
chore
This change is not user-facing
upgrade
This change is related to a dependency upgrade
labels
Mar 23, 2021
aladdin-add
approved these changes
Mar 23, 2021
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
LGTM! 💯
nzakas
approved these changes
Mar 24, 2021
Co-authored-by: Milos Djermanovic <milos.djermanovic@gmail.com>
Co-authored-by: Milos Djermanovic <milos.djermanovic@gmail.com>
mdjermanovic
added
the
accepted
There is consensus among the team that this change meets the criteria for inclusion
label
Mar 24, 2021
Co-authored-by: Milos Djermanovic <milos.djermanovic@gmail.com>
mdjermanovic
approved these changes
Mar 25, 2021
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
LGTM, thanks!
eslint-github-bot
bot
added
the
archived due to age
This issue has been archived; please open a new issue for any further discussion
label
Sep 22, 2021
Sign up for free
to subscribe to this conversation on GitHub.
Already have an account?
Sign in.
Labels
accepted
There is consensus among the team that this change meets the criteria for inclusion
archived due to age
This issue has been archived; please open a new issue for any further discussion
chore
This change is not user-facing
upgrade
This change is related to a dependency upgrade
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Prerequisites checklist
What is the purpose of this pull request? (put an "X" next to an item)
[ ] Documentation update
[ ] Bug fix (template)
[ ] New rule (template)
[ ] Changes an existing rule (template)
[ ] Add autofixing to a rule
[ ] Add a CLI option
[ ] Add something to the core
[x] Other, please explain: Since #13844 added Node 15 and with it npm v7 to the build matrix, we've had to use
--legacy-peer-deps
when runningnpm install
with npm v7. This upgrades the last incompatible dependency so we can justnpm install
in any supported Node/npm version.What changes did you make? (Give an overview)
Chore: Upgrade eslint-plugin-jsdoc to v25
This is a Chore instead of an Upgrade because it's in
devDependencies
. v25 is the first release ofeslint-plugin-jsdoc
to bump theeslint
peer dependency to alloweslint@7
. Once it's upgraded, we won't have to use--legacy-peer-deps
to install dependencies with npm v7. The newer version was unsatisfied with thecliOptions
param totranslateOptions
typed as justObject
, so I turned our Optionator config into a JSDoc typedef.Chore: npm v7 no longer needs --legacy-peer-deps (refs Chore: Test on Node.js 15 #13844)
eslint-plugin-jsdoc
was the last upgrade needed to be compatible with the new peer dependency resolution in npm v7.Is there anything you'd like reviewers to focus on?
Thanks to npm/cli#2896 (comment) for deciphering the error log and pointing out where the incompatibility was.