feat(linter): use overrides in root eslint config #3949
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
Nx Cloud ReportCI ran the following commands for commit bea0cfe. Click to see the status, the terminal output, and the build insights.
Sent with 💌 from NxCloud. |
JamesHenry
force-pushed
the
eslint-overrides
branch
from
7ac7ec3 to
cfea9ea
Compare
JamesHenry
changed the title
|
The unit test failure was simply a memory issue on the CircleCI agent... |
FrozenPandaz
approved these changes
Oct 23, 2020
| * breaking changes - we should also look to replace all the @typescript-eslint | ||
| * related plugins and rules below. | ||
| */ | ||
| export default { |
There was a problem hiding this comment.
Not relevant for this PR but, should the typescript configuration extend off of this javascript one?
Doginal
pushed a commit
to Doginal/nx
that referenced
this pull request
Nov 25, 2020
* feat(linter): use overrides in root eslint config * feat(linter): update-root-eslint-config-to-use-overrides migration
|
This pull request has already been merged/closed. If you experience issues related to these changes, please open a new issue referencing this pull request. |
Sign up for free
to subscribe to this conversation on GitHub.
Already have an account?
Sign in.
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.
Current Behavior
The root level ESLint config in an Nx workspace currently applies all configuration (parser, plugins, rules etc) to all files within the workspace.
This is ok for TypeScript and JavaScript (where the same custom parser can be used for both file types), but for Nx to truly support linting any and all frameworks, libraries and tools, it needs to become more precise in how config is applied.
Expected Behavior
We leverage ESLint's "overrides" capability so that we can set up a root config which will support all permutations of Nx workspaces across all frameworks, libraries and tools.
The key point is that we need entirely different ESLint config to apply to different types of files, but we still want to share common config where possible.
I did not need to change any other existing project level configs, they all still work as before.
This is the final step to unlocking proper Angular linting via ESLint in Nx workspaces, because now HTML files (and inline HTML templates within Components) can be linted alongside other source code.
I have personally verified this locally by using a build of this PR and creating a custom Nx workspace which mixes React and Angular apps together.
Related Issue(s)
Fixes #