ESLint: use the --rulesdir option for internal rules.
#3849
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
Motivation: We need to have a way to have internal ESLint rules. ESLint allows you to import rules in two ways: 1. As an npm package, it is problematic for internal rules since we don't want to publish it on NPM. So in the past, we used NPM-specific workarounds to treat a directory as a package. 2. `--rulesdir` CLI option, the problem with it is deprecated. ESLint team is planning to deprecate the current config format and switch to: https://eslint.org/docs/latest/use/configure/configuration-files-new This format forces you to import plugins manually, and it entirely resolves our problem with internal rules. But it requires that all plugins that we use to support this format. I propose to temporarily switch to `--rulesdir` and start working on changing to the new format since the entire config format will be deprecated anyway. This switch will unblock support for node@19 in CI and local development and unblock graphql#3848.
✅ Deploy Preview for compassionate-pike-271cb3 ready!
To edit notification comments on pull requests, go to your Netlify site settings. |
|
Hi @IvanGoncharov, I'm @github-actions bot happy to help you with this PR 👋 Supported commandsPlease post this commands in separate comments and only one per comment:
|
|
@IvanGoncharov that sounds great to me. We can also update the package.json and README files within resources/eslint-internal-rules We still need the package.json to mark the file as CJS, but we don't really need much in there, we can even take out the package name. The README should be updated to reflect that the need for the package.json is just to mark the files as cjs (which won't be necessary with the new config format!) and updated as well in that you no longer need to run |
saihaj
approved these changes
Feb 17, 2023
yaacovCR
approved these changes
Feb 17, 2023
|
Thanks, @yaacovCR. |
IvanGoncharov
added a commit
to IvanGoncharov/graphql-js
that referenced
this pull request
Feb 17, 2023
Context: As disscussed in graphql#3849 ESLint team is planning to deprecate the current config format and switch to: https://eslint.org/docs/latest/use/configure/configuration-files-new But it requires that all plugins that we use to support this format. In my PoC attempt to use this new format biggest change is comming from converting YAML file into JS, so I decided to extract it into separate commit. Note: beyound JS convertion I did a purely stylistic cleanup of `TODO` comments, beyound that this commit is pure convertion of YAML into JS.
IvanGoncharov
added a commit
to IvanGoncharov/graphql-js
that referenced
this pull request
Feb 17, 2023
Context: As disscussed in graphql#3849 ESLint team is planning to deprecate the current config format and switch to: https://eslint.org/docs/latest/use/configure/configuration-files-new But it requires that all plugins that we use to support this format. In my PoC attempt to use this new format biggest change is comming from converting YAML file into JS, so I decided to extract it into separate commit. Note: beyound JS convertion I did a purely stylistic cleanup of `TODO` comments, beyound that this commit is pure convertion of YAML into JS.
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
Motivation: We need to have a way to have internal ESLint rules. ESLint allows you to import rules in two ways:
--rulesdirCLI option, the problem with it is deprecated.ESLint team is planning to deprecate the current config format and switch to: https://eslint.org/docs/latest/use/configure/configuration-files-new
This format forces you to import plugins manually, and it entirely resolves our problem with internal rules. But it requires that all plugins that we use to support this format.
I propose to temporarily switch to
--rulesdirand start working on changing to the new format since the entire config format will be deprecated anyway. This switch will unblock support for node@19 in CI and local development and unblock #3848.