refactor: make config rules static rather than based off rule metadata #1506
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
SimenB
reviewed
Feb 16, 2024
Comment on lines
+67
to
+94
| const recommendedRules = { | ||
| 'jest/expect-expect': 'warn', | ||
| 'jest/no-alias-methods': 'error', | ||
| 'jest/no-commented-out-tests': 'warn', | ||
| 'jest/no-conditional-expect': 'error', | ||
| 'jest/no-deprecated-functions': 'error', | ||
| 'jest/no-disabled-tests': 'warn', | ||
| 'jest/no-done-callback': 'error', | ||
| 'jest/no-export': 'error', | ||
| 'jest/no-focused-tests': 'error', | ||
| 'jest/no-identical-title': 'error', | ||
| 'jest/no-interpolation-in-snapshots': 'error', | ||
| 'jest/no-jasmine-globals': 'error', | ||
| 'jest/no-mocks-import': 'error', | ||
| 'jest/no-standalone-expect': 'error', | ||
| 'jest/no-test-prefixes': 'error', | ||
| 'jest/valid-describe-callback': 'error', | ||
| 'jest/valid-expect': 'error', | ||
| 'jest/valid-expect-in-promise': 'error', | ||
| 'jest/valid-title': 'error', | ||
| } satisfies Record<string, TSESLint.Linter.RuleLevel>; | ||
|
|
||
| const styleRules = { | ||
| 'jest/no-alias-methods': 'warn', | ||
| 'jest/prefer-to-be': 'error', | ||
| 'jest/prefer-to-contain': 'error', | ||
| 'jest/prefer-to-have-length': 'error', | ||
| } satisfies Record<string, TSESLint.Linter.RuleLevel>; |
There was a problem hiding this comment.
how can we ensure this is kept in sync with docs and the meta prop?
There was a problem hiding this comment.
The docs are generated based on this (specifically, it builds the plugin and looks at the resulting configs object), and the meta props are going away - I've not removed them yet because the types currently still require them and that it might technically be breaking, though I could axe category in this PR if you like
G-Rath
force-pushed
the
static-configs2
branch
from
e62a64f
to
6b73dec
Compare
|
🎉 This PR is included in version 28.0.0-next.1 🎉 The release is available on: Your semantic-release bot 📦🚀 |
|
🎉 This PR is included in version 28.0.0 🎉 The release is available on: Your semantic-release bot 📦🚀 |
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.
Rule metadata is really typed for how
@typescript-eslintuse it and their recent majors have changed exports so we can't actually argument their interfaces anymore so this switches us to just using a static object.I've not done anything fancy like having dedicated files in
configs/because I don't think there's a big advantage at this point and frankly I just want to push through to the ESLint v9 /@typescript-eslintv (I think 7..?) so will revisit restructuring later once the dust has settled.I've also not removed the actual properties from the rules as I think that technically could be a breaking change? but I have at least tested without them locally to ensure all the scripts and workflow still work.