Simplify ESLint Config #261
There are no files selected for viewing
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,22 +1,135 @@ | ||
| /** | ||
| * This is intended to be a basic starting point for linting in the Indie Stack. | ||
| * It relies on recommended configs out of the box for simplicity, but you can | ||
| * and should modify this configuration to best suit your team's needs. | ||
| */ | ||
|
|
||
| /** @type {import('eslint').Linter.Config} */ | ||
| module.exports = { | ||
| root: true, | ||
| parserOptions: { | ||
| ecmaVersion: "latest", | ||
| sourceType: "module", | ||
| ecmaFeatures: { | ||
| jsx: true, | ||
| }, | ||
| }, | ||
| env: { | ||
| browser: true, | ||
| commonjs: true, | ||
| es6: true, | ||
| }, | ||
|
|
||
| // Base config | ||
| extends: ["eslint:recommended"], | ||
|
|
||
| overrides: [ | ||
| // React | ||
| { | ||
| files: ["**/*.{js,jsx,ts,tsx}"], | ||
| plugins: ["react", "jsx-a11y"], | ||
| extends: [ | ||
| "plugin:react/recommended", | ||
| "plugin:react/jsx-runtime", | ||
| "plugin:jsx-a11y/recommended", | ||
| "prettier", | ||
| ], | ||
| settings: { | ||
| react: { | ||
| version: "detect", | ||
| }, | ||
| formComponents: ["Form"], | ||
| linkComponents: [ | ||
| { name: "Link", linkAttribute: "to" }, | ||
| { name: "NavLink", linkAttribute: "to" }, | ||
| ], | ||
| }, | ||
| rules: { | ||
| "react/jsx-no-leaked-render": [ | ||
| "warn", | ||
| { validStrategies: ["ternary"] }, | ||
| ], | ||
| }, | ||
| }, | ||
|
|
||
| // Typescript | ||
| { | ||
| files: ["**/*.{ts,tsx}"], | ||
| plugins: ["@typescript-eslint", "import"], | ||
| parser: "@typescript-eslint/parser", | ||
| settings: { | ||
| "import/internal-regex": "^~/", | ||
| "import/resolver": { | ||
| node: { | ||
| extensions: [".ts", ".tsx"], | ||
| }, | ||
| typescript: { | ||
| alwaysTryTypes: true, | ||
| }, | ||
| }, | ||
| }, | ||
| extends: [ | ||
| "plugin:@typescript-eslint/recommended", | ||
| "plugin:@typescript-eslint/stylistic", | ||
| "plugin:import/recommended", | ||
| "plugin:import/typescript", | ||
| "prettier", | ||
| ], | ||
| rules: { | ||
| "import/order": [ | ||
| "error", | ||
| { | ||
| alphabetize: { caseInsensitive: true, order: "asc" }, | ||
| groups: ["builtin", "external", "internal", "parent", "sibling"], | ||
| "newlines-between": "always", | ||
| }, | ||
| ], | ||
| }, | ||
|
Comment on lines
+78
to
+87
There was a problem hiding this comment. Same comment as above. I personally hate lack of consistency when it comes to imports - but again this is veering into "opinion" territory. |
||
| }, | ||
|
|
||
| // Markdown | ||
| { | ||
| files: ["**/*.md"], | ||
| plugins: ["markdown"], | ||
| extends: ["plugin:markdown/recommended", "prettier"], | ||
| }, | ||
|
|
||
| // Jest/Vitest | ||
| { | ||
| files: ["**/*.test.{js,jsx,ts,tsx}"], | ||
| plugins: ["jest", "jest-dom", "testing-library"], | ||
| extends: [ | ||
| "plugin:jest/recommended", | ||
| "plugin:jest-dom/recommended", | ||
| "plugin:testing-library/react", | ||
| "prettier", | ||
| ], | ||
| env: { | ||
| "jest/globals": true, | ||
| }, | ||
| settings: { | ||
| jest: { | ||
| // we're using vitest which has a very similar API to jest | ||
| // (so the linting plugins work nicely), but it means we have to explicitly | ||
| // set the jest version. | ||
| version: 28, | ||
| }, | ||
| }, | ||
| }, | ||
|
|
||
| // Cypress | ||
| { | ||
| files: ["cypress/**/*.ts"], | ||
| plugins: ["cypress"], | ||
| extends: ["plugin:cypress/recommended", "prettier"], | ||
| }, | ||
|
|
||
| // Node | ||
| { | ||
| files: [".eslintrc.js", "mocks/**/*.js"], | ||
| env: { | ||
| node: true, | ||
| }, | ||
| }, | ||
| ], | ||
| }; | ||
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -30,4 +30,4 @@ jobs: | |
| run: npm install | ||
|
|
||
| - name: 🔬 Lint | ||
| run: npm run lint | ||
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
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
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
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
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
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
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
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
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.
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.
I could go either way on this one-off rule. On one hand, if we truly want to stay out of the opinion game, then we technically should have zero
rulesor our own. But this one seems like it solves a common footgun, and TBH I was surprised it wasn't enable din the recommended plugin...so I added it. (It was also one we turned on viaeslintrc.repo.jsbefore.