-
Notifications
You must be signed in to change notification settings - Fork 4.2k
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
Eslint Plugin: Change plugin dependencies to peer dependencies #42656
base: trunk
Are you sure you want to change the base?
Conversation
…ch recommendations of shareable configs in Eslint. For reference https://eslint.org/docs/latest/developer-guide/shareable-configs#publishing-a-shareable-config
Size Change: 0 B Total Size: 1.26 MB ℹ️ View Unchanged
|
…ies of main project.
What's missing here? Using Node 18 becomes problematic now. This is trying to use a version of
But it'd be great if there was a less hacky way of dealing with this. |
@BE-Webdesign Are you able to update this branch and resolve the merge conflicts that are listed? |
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.
This approach as it stands currently won't work unfortunately and will break @wordpress/scripts
package:
This is because the ESLint dependencies are deliberately included in the package so that wp-scripts lint-js
will work straight out-of-the-box with the included WordPress JavaScript Coding Standards ESLint configuration included
There's potentially some additional work that might make switching to peerDependencies
work as part of the @wordpress/scripts
package
This would also be a major breaking change for the @wordpress/eslint-plugin
& @wordpress/scripts
packages and would need further changes to facilitate this
Following up from my above code review notes, I don't think this PR is what will resolve the 10Up issue you're facing either I think what is actually required to solve the linked issue is to update gajus/eslint-plugin-jsdoc@v39.2.4...v39.2.5 Instructions on how to update packages in this repo are here if you're interested in updating https://github.com/WordPress/gutenberg/tree/trunk/packages#managing-packages |
@fabiankaegy unfortunately, I have not been able to keep up with GitHub lately. I believe as @ntwb has pointed out although this may solve some issues, it creates others and a different approach will be needed so resolving the merge conflicts will likely not be satisfactory to solve the issues. I currently do not have the bandwidth to properly work on the issue. |
Fixes #39810
What?
Change dependencies to match recommendations of shareable configs in Eslint. For reference https://eslint.org/docs/latest/developer-guide/shareable-configs#publishing-a-shareable-config
Why?
Avoid potential versioning conflicts when package is used in other projects, or if Gutenberg introduces new packages related to eslint.
How?
Moves the eslint plugin dependencies into peer dependencies using the >= range operator.
Testing Instructions
node_modules
folder.npm i
to install deps.npm run lint-js
to ensure that all plugins for eslint are still loading correctly, you should see warnings still.Screenshots or screencast
Not applicable