feat: all rules: #214: Warn the user/Throw an error when a group entered in config does not exist #232
Conversation
This file contains hidden or 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
hugop95
force-pushed
the
feat/all-rules/#214
branch
from
eeb9c95 to
6c7b5c2
Compare
hugop95
force-pushed
the
feat/all-rules/#214
branch
from
6c7b5c2 to
1f8c50a
Compare
azat-io
reviewed
Sep 1, 2024
| { | ||
| ...options, | ||
| customGroups: { top: ['c', 'b'] }, | ||
| groups: ['top', 'unknown'], |
Contributor
Author
There was a problem hiding this comment.
Fixed. Mistake on my part.
| import { validateGroupsConfiguration } from '../utils/validate-groups-configuration' | ||
|
|
||
| /** | ||
| * It is currently not possible to test rules that throw errors (https://github.com/eslint/eslint/issues/13434), |
Owner
There was a problem hiding this comment.
Let's try to stick to the 80 character line length limit rule as stated in the prettier config?
I suggest breaking the comment down into a few lines.
hugop95
force-pushed
the
feat/all-rules/#214
branch
from
1f8c50a to
8aad99e
Compare
hugop95
force-pushed
the
feat/all-rules/#214
branch
from
8aad99e to
2009810
Compare
Owner
|
Great. Thank you! |
Merged
3 tasks
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
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.
Description
Resolves (partially) #214. The
sort-classesrule is not part of this PR as checking if a group entered by the user is part of predefined groups requires a more complex strategy which I believe deserves its own PR.Checks and validates group configuration for rules using
groups. Configurations referencing groups that arecustomGroupsare very likely user mistakes or typos. These groups are considered invalid and will throw an error, stopping ESLint.
Affected rules:
sort-astro-attributessort-importssort-interfacessort-intersection-typessort-jsx-propssort-object-typessort-objectsort-svelte-attributessort-union-typessort-vue-attributesRemaining to do:
Additional context
Some tests have been slightly changed as they were referencing invalid groups. In those cases, invalid groups were removed from the test configuration.
Ideally, we should be testing that invalid group configurations throw an error for each rule. Unfortunately, it is currently not possible to test rules that throw errors (Add ability to test rule schemas eslint/eslint#13434 | feat: ability to test rule errors and invalid schemas eslint/eslint#16823). Furthermore, getting 100% code coverage in
validateGroupsConfiguration.tsis not possible only through ESLint's RuleTester as there is no way to catchthe error thrown. We get 100% coverage temporarily in that file with a simple unit test in
validateGroupsConfiguration.test.tsuntil that feature is implemented in ESLint.What is the purpose of this pull request?