generated from gridsuite/gridapp-template
-
Notifications
You must be signed in to change notification settings - Fork 2
Migrate to ESlint 9 #141
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Open
Tristan-WorkGH
wants to merge
2
commits into
main
Choose a base branch
from
update/eslint
base: main
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
Open
Migrate to ESlint 9 #141
Changes from all commits
Commits
Show all changes
2 commits
Select commit
Hold shift + click to select a range
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file was deleted.
Oops, something went wrong.
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
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -13,6 +13,9 @@ | |
# vite | ||
/vite.config.ts-timestamp-* | ||
|
||
# ESLint | ||
/.eslintcache | ||
|
||
# misc | ||
.env.local | ||
.env.development.local | ||
|
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
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,205 @@ | ||
/* | ||
* Copyright © 2025, RTE (http://www.rte-france.com) | ||
* This Source Code Form is subject to the terms of the Mozilla Public | ||
* License, v. 2.0. If a copy of the MPL was not distributed with this | ||
* file, You can obtain one at http://mozilla.org/MPL/2.0/. | ||
*/ | ||
|
||
import { braceExpand } from 'minimatch'; | ||
import { defineConfig, globalIgnores } from 'eslint/config'; | ||
import { FlatCompat } from '@eslint/eslintrc'; | ||
import js from '@eslint/js'; | ||
import globals from 'globals'; | ||
import eslintPluginPrettierRecommended from 'eslint-plugin-prettier/recommended'; | ||
import tsEslint from 'typescript-eslint'; | ||
import pluginReact from 'eslint-plugin-react'; | ||
import pluginReactHooks from 'eslint-plugin-react-hooks'; | ||
import pluginReactRefresh from 'eslint-plugin-react-refresh'; | ||
import pluginImport from 'eslint-plugin-import'; | ||
import pluginJest from 'eslint-plugin-jest'; | ||
import pluginTestingLibrary from 'eslint-plugin-testing-library'; | ||
import { getSupportInfo, resolveConfig, resolveConfigFile } from 'prettier'; | ||
|
||
/** | ||
* @typedef {import('eslint').Linter.ParserOptions} EsParserOptions | ||
* @typedef {import('@typescript-eslint/parser').ParserOptions} TsParserOptions | ||
* @typedef {import('type-fest').MergeDeep<EsParserOptions, TsParserOptions>} AllParserOptions | ||
*/ | ||
|
||
// Helper to translate old ESLintRC-style to new flat-style config | ||
const compat = new FlatCompat({ | ||
baseDirectory: import.meta.dirname, | ||
recommendedConfig: js.configs.recommended, | ||
allConfig: js.configs.all, | ||
}); | ||
|
||
const JsFiles = [`**/*.{${braceExpand('{,c,m}js{,x}').join(',')}}`]; | ||
const TsFiles = [`**/*.{${braceExpand('{,m}ts{,x}').join(',')}}`]; | ||
// const JsTsFiles = [`**/*.{${['cjs', 'cjsx', ...braceExpand('{,m}{j,t}s{,x}')].join(',')}}`]; | ||
const JsTsFiles = [...JsFiles, ...TsFiles]; | ||
const TestFiles = ['**/__tests__/**/*.[jt]s?(x)', '**/?(*.)+(spec|test).[jt]s?(x)']; | ||
|
||
function setRuleLevel(rules, rule, level) { | ||
if (Array.isArray(rules[rule])) { | ||
rules[rule][0] = level; | ||
} else { | ||
rules[rule] = level; | ||
} | ||
return rules; // just a helper for functional chaining | ||
} | ||
|
||
/** | ||
* Files checked by Prettier | ||
*/ | ||
async function getPrettierCheckedExt() { | ||
const configPath = await resolveConfigFile(import.meta.filename); | ||
const config = await resolveConfig(configPath, { useCache: false }); | ||
const supportInfo = await getSupportInfo({ plugins: config.plugins }); | ||
return supportInfo.languages | ||
.flatMap((lng) => lng.extensions ?? []) // extract extensions checked by plugins | ||
.concat('.env') // also checked by prettier in override section | ||
.map((dotExt) => dotExt.substring(1)); // remove dot from ext string | ||
} | ||
|
||
export default defineConfig([ | ||
globalIgnores([ | ||
// .git & node_modules is implicitly always ignored | ||
'build/**', | ||
'coverage/**', | ||
]), | ||
{ | ||
// We set "default files" checked when another config object don't define "files" field | ||
name: 'ProjectCheckedFiles', | ||
files: [ | ||
`**/*.{${[getPrettierCheckedExt(), JsTsFiles] | ||
.flat() | ||
.filter((ext, index, self) => self.indexOf(ext) === index) // dedupe | ||
.join(',')}}`, | ||
], | ||
}, | ||
{ name: 'eslint base declare', files: JsTsFiles, plugins: { js }, extends: ['js/recommended'] }, | ||
{ files: TsFiles, ...tsEslint.configs.base }, | ||
{ name: 'eslint-plugin-react declare', files: JsTsFiles, plugins: { react: pluginReact } }, | ||
{ name: 'eslint-plugin-react-hooks declare', files: JsTsFiles, plugins: { 'react-hooks': pluginReactHooks } }, | ||
{ files: JsTsFiles, ...pluginReactRefresh.configs.vite }, | ||
{ | ||
name: 'eslint-plugin-testing-library/react', | ||
files: TestFiles, | ||
...pluginTestingLibrary.configs['flat/react'], | ||
rules: {}, // rules are set by cra-config | ||
}, | ||
{ | ||
name: 'eslint-plugin-jest/recommended', | ||
files: TestFiles, | ||
...pluginJest.configs['flat/recommended'], | ||
rules: {}, // rules are set by cra-config | ||
}, | ||
{ | ||
name: 'eslint-plugin-import/typescript rules', | ||
files: TsFiles, | ||
rules: pluginImport.flatConfigs.typescript.rules, | ||
}, | ||
// eslint-plugin-jsx-a11y is re-declared in airbnb config and eslint don't let redeclaration of plugins | ||
// requires eslint, eslint-plugin-import, eslint-plugin-react, eslint-plugin-react-hooks, and eslint-plugin-jsx-a11y | ||
// TODO migrate when eslint v9 & flat-config supported: https://github.com/airbnb/javascript/issues/2961 | ||
{ | ||
files: JsTsFiles, | ||
name: 'CRA', | ||
// extends: compat.extends('react-app'), | ||
// eslint-config-react-app use internally eslint-patch that not work with eslint9 | ||
extends: compat.extends('./eslint.config.react-app.cjs'), | ||
}, | ||
{ | ||
name: 'CRA tests', | ||
files: TestFiles, | ||
extends: compat.extends('./eslint.config.react-app-test.cjs'), | ||
}, | ||
{ | ||
// merge react & ts config, configure eslint-import-resolver-typescript, and finally keep airbnb-typescript override | ||
name: 'eslint-plugin-import config with TS support compliant with AirBnB configs', | ||
files: JsTsFiles, | ||
plugins: { import: pluginImport }, | ||
...pluginImport.flatConfigs.react, // do languageOptions jsx | ||
settings: { | ||
...pluginImport.flatConfigs.typescript.settings, | ||
'import/parsers': { | ||
'@typescript-eslint/parser': [ | ||
...pluginImport.flatConfigs.typescript.settings['import/parsers']['@typescript-eslint/parser'], | ||
'.d.ts', | ||
], | ||
}, | ||
'import/resolver': { | ||
node: { | ||
extensions: [ | ||
...pluginImport.flatConfigs.typescript.settings['import/resolver'].node.extensions, | ||
'.json', | ||
'.d.ts', | ||
], | ||
}, | ||
// See also https://github.com/import-js/eslint-import-resolver-typescript#configuration | ||
typescript: | ||
/** @type {import('eslint-import-resolver-typescript').TypeScriptResolverOptions} */ | ||
({ | ||
alwaysTryTypes: true, // always try to resolve types under `<root>@types` directory even it doesn't contain any source code, like `@types/unist` | ||
project: `${import.meta.dirname}/tsconfig.json`, | ||
}), | ||
}, | ||
'import/extensions': [...pluginImport.flatConfigs.typescript.settings['import/extensions'], '.d.ts'], | ||
}, | ||
// need all these for parsing dependencies (even if _your_ code doesn't need all of them) | ||
languageOptions: { parser: tsEslint.parser, ecmaVersion: 'latest', sourceType: 'module' }, | ||
rules: { 'import/no-unresolved': 'error' }, // not all files are in typescript yet | ||
}, | ||
|
||
{ | ||
name: 'General configuration', | ||
files: JsTsFiles, | ||
settings: { | ||
babel: true, | ||
// compat: true, | ||
}, | ||
languageOptions: { | ||
globals: { | ||
...globals.es2020, // https://vite.dev/guide/build.html#browser-compatibility & https://vite.dev/config/build-options.html#build-target | ||
...globals.browser, | ||
}, | ||
ecmaVersion: 2020, | ||
sourceType: 'script', | ||
}, | ||
rules: { | ||
curly: 'error', | ||
'no-console': 'off', | ||
'react/jsx-props-no-spreading': 'off', | ||
'react/require-default-props': 'off', | ||
'no-plusplus': ['error', { allowForLoopAfterthoughts: true }], | ||
'import/prefer-default-export': 'off', | ||
}, | ||
}, | ||
{ | ||
name: 'General configuration for tests', | ||
files: ['**/jest.setup.ts', '**/*.{test,spec}.{js,jsx,ts,tsx}'], | ||
languageOptions: { | ||
globals: { | ||
...globals.browser, | ||
...globals.jest, // globals.vitest | ||
}, | ||
}, | ||
}, | ||
{ | ||
name: 'React: jsx-runtime', | ||
files: JsTsFiles, | ||
// concretely disable react/react-in-jsx-scope & react/jsx-uses-react | ||
...pluginReact.configs.flat['jsx-runtime'], // using React 17+ | ||
}, | ||
{ | ||
name: 'ProjectToolsConfigs', | ||
files: ['**/*.config.{js,ts}'], | ||
languageOptions: { globals: globals.node, ecmaVersion: 'latest', sourceType: 'module' }, | ||
}, | ||
// keep last in case we have reactivated a rule that conflict with Prettier (turn off the rules of some core & eslint plugins rules) | ||
{ | ||
...eslintPluginPrettierRecommended, // include eslint-config-prettier | ||
// format isn't mandatory during dev session, so we pass it to warn level instead of error | ||
rules: setRuleLevel({ ...eslintPluginPrettierRecommended.rules }, 'prettier/prettier', 'warn'), | ||
}, | ||
]); |
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
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,61 @@ | ||
/** | ||
* Copyright (c) 2015-present, Facebook, Inc. | ||
* | ||
* This source code is licensed under the MIT license found in the | ||
* LICENSE file in the root directory of this source tree. | ||
*/ | ||
|
||
// 'use strict'; | ||
|
||
// We use eslint-loader so even warnings are very visible. | ||
// This is why we prefer to use "WARNING" level for potential errors, | ||
// and we try not to use "ERROR" level at all. | ||
|
||
module.exports = { | ||
plugins: ['jest', 'testing-library'], | ||
overrides: [ | ||
{ | ||
files: ['**/__tests__/**/*', '**/*.{spec,test}.*'], | ||
env: { | ||
'jest/globals': true, | ||
}, | ||
// A subset of the recommended rules: | ||
rules: { | ||
// https://github.com/jest-community/eslint-plugin-jest | ||
'jest/no-conditional-expect': 'error', | ||
'jest/no-identical-title': 'error', | ||
'jest/no-interpolation-in-snapshots': 'error', | ||
'jest/no-jasmine-globals': 'error', | ||
//'jest/no-jest-import': 'error', | ||
'jest/no-mocks-import': 'error', | ||
'jest/valid-describe-callback': 'error', | ||
'jest/valid-expect': 'error', | ||
'jest/valid-expect-in-promise': 'error', | ||
'jest/valid-title': 'warn', | ||
// https://github.com/testing-library/eslint-plugin-testing-library | ||
//'testing-library/await-async-query': 'error', | ||
'testing-library/await-async-queries': 'error', | ||
'testing-library/await-async-utils': 'error', | ||
//'testing-library/no-await-sync-query': 'error', | ||
'testing-library/no-await-sync-queries': 'error', | ||
'testing-library/no-container': 'error', | ||
'testing-library/no-debugging-utils': 'error', | ||
'testing-library/no-dom-import': ['error', 'react'], | ||
'testing-library/no-node-access': 'error', | ||
'testing-library/no-promise-in-fire-event': 'error', | ||
//'testing-library/no-render-in-setup': 'error', | ||
'testing-library/no-render-in-lifecycle': 'error', | ||
'testing-library/no-unnecessary-act': 'error', | ||
//'testing-library/no-wait-for-empty-callback': 'error', | ||
'testing-library/no-wait-for-multiple-assertions': 'error', | ||
'testing-library/no-wait-for-side-effects': 'error', | ||
'testing-library/no-wait-for-snapshot': 'error', | ||
'testing-library/prefer-find-by': 'error', | ||
'testing-library/prefer-presence-queries': 'error', | ||
'testing-library/prefer-query-by-disappearance': 'error', | ||
'testing-library/prefer-screen-queries': 'error', | ||
'testing-library/render-result-naming-convention': 'error', | ||
}, | ||
}, | ||
], | ||
}; |
Oops, something went wrong.
Oops, something went wrong.
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.