Thanks to visit codestin.com
Credit goes to github.com

Skip to content

chore: clean up ESLint config post vitest migration #11135

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.

Sign up for GitHub

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

Merged
merged 5 commits into from
May 16, 2025
Merged

chore: clean up ESLint config post vitest migration #11135

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
89e0650
chore: cleanup ESLint config file
aryaemami59 Apr 27, 2025
5938d9b
remove `jiti`
aryaemami59 May 5, 2025
20b2c16
Merge branch 'main' of https://github.com/typescript-eslint/typescrip…
aryaemami59 May 7, 2025
9c57e2d
Merge branch 'main' of https://github.com/typescript-eslint/typescrip…
aryaemami59 May 9, 2025
1551966
Merge branch 'main' of https://github.com/typescript-eslint/typescrip…
aryaemami59 May 15, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
109 changes: 61 additions & 48 deletions eslint.config.mjs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -31,6 +31,7 @@ const restrictNamedDeclarations = {
export default tseslint.config(
// register all of the plugins up-front
{
name: 'register-all-plugins',
// note - intentionally uses computed syntax to make it easy to sort the keys
/* eslint-disable no-useless-computed-key */
plugins: {
Expand Down Expand Up @@ -85,11 +86,12 @@ export default tseslint.config(
// see the file header in eslint-base.test.js for more info
'packages/rule-tester/tests/eslint-base/',
],
name: 'global-ignores',
},

// extends ...
eslintCommentsPlugin.recommended,
eslint.configs.recommended,
{ name: `${eslint.meta.name}/recommended`, ...eslint.configs.recommended },
tseslint.configs.strictTypeChecked,
tseslint.configs.stylisticTypeChecked,
jsdocPlugin.configs['flat/recommended-typescript-error'],
Expand All @@ -108,6 +110,7 @@ export default tseslint.config(
},
},
linterOptions: { reportUnusedDisableDirectives: 'error' },
name: 'base-config',
rules: {
//
// our plugin :D
Expand Down Expand Up @@ -345,6 +348,7 @@ export default tseslint.config(
{
extends: [tseslint.configs.disableTypeChecked],
files: ['**/*.js'],
name: 'js-files-only',
rules: {
// turn off other type-aware rules
'@typescript-eslint/internal/no-poorly-typed-ts-props': 'off',
Expand All @@ -361,7 +365,7 @@ export default tseslint.config(
// test file specific configuration
{
files: [
'packages/*/tests/**/*.{ts,tsx,cts,mts}',
'packages/*/tests/**/*.?(m|c)ts?(x)',
'packages/integration-tests/tools/**/*.ts',
],
...vitestPlugin.configs.env,
Expand Down Expand Up @@ -406,11 +410,11 @@ export default tseslint.config(
// plugin rule tests
{
files: [
'packages/eslint-plugin-internal/tests/rules/**/*.test.{ts,tsx,cts,mts}',
'packages/eslint-plugin-tslint/tests/rules/**/*.test.{ts,tsx,cts,mts}',
'packages/eslint-plugin/tests/rules/**/*.test.{ts,tsx,cts,mts}',
'packages/eslint-plugin/tests/eslint-rules/**/*.test.{ts,tsx,cts,mts}',
'packages/eslint-plugin-internal/tests/rules/**/*.test.?(m|c)ts?(x)',
'packages/eslint-plugin/tests/rules/**/*.test.?(m|c)ts?(x)',
'packages/eslint-plugin/tests/eslint-rules/**/*.test.?(m|c)ts?(x)',
],
name: 'eslint-plugin-and-eslint-plugin-internal/test-files/rules',
rules: {
'@typescript-eslint/internal/plugin-test-formatting': 'error',
},
Expand All @@ -421,23 +425,25 @@ export default tseslint.config(
//
{
files: [
'**/tools/**/*.{ts,tsx,cts,mts}',
'**/tests/**/*.{ts,tsx,cts,mts}',
'packages/integration-tests/**/*.{ts,tsx,cts,mts}',
'**/tools/**/*.?(m|c)ts?(x)',
'**/tests/**/*.?(m|c)ts?(x)',
'packages/integration-tests/**/*.?(m|c)ts?(x)',
],
name: 'tools-and-test-files',
rules: {
// allow console logs in tools and tests
'no-console': 'off',
},
},
{
files: [
'eslint.config.{js,cjs,mjs}',
'eslint.config.mjs',
'knip.ts',
'packages/*/src/index.ts',
'vitest.config.mts',
'packages/*/vitest.config.mts',
],
name: 'no-default-export',
rules: {
// requirement
'import/no-default-export': 'off',
Expand All @@ -451,24 +457,23 @@ export default tseslint.config(
{
extends: [eslintPluginPlugin.configs['flat/recommended']],
files: [
'packages/eslint-plugin-internal/**/*.{ts,tsx,cts,mts}',
'packages/eslint-plugin-tslint/**/*.{ts,tsx,cts,mts}',
'packages/eslint-plugin/**/*.{ts,tsx,cts,mts}',
'packages/eslint-plugin-internal/**/*.?(m|c)ts?(x)',
'packages/eslint-plugin/**/*.?(m|c)ts?(x)',
],
name: 'eslint-plugin-and-eslint-plugin-internal',

rules: {
'@typescript-eslint/internal/no-typescript-estree-import': 'error',
},
},
{
files: [
'packages/eslint-plugin-internal/src/rules/**/*.{ts,tsx,cts,mts}',
'packages/eslint-plugin-tslint/src/rules/**/*.{ts,tsx,cts,mts}',
'packages/eslint-plugin/src/configs/**/*.{ts,tsx,cts,mts}',
'packages/typescript-eslint/src/configs/**/*.{ts,tsx,cts,mts}',
'packages/core/src/configs/**/*.{ts,tsx,cts,mts}',
'packages/eslint-plugin/src/rules/**/*.{ts,tsx,cts,mts}',
'packages/eslint-plugin-internal/src/rules/**/*.?(m|c)ts?(x)',
'packages/eslint-plugin/src/configs/**/*.?(m|c)ts?(x)',
'packages/typescript-eslint/src/configs/**/*.?(m|c)ts?(x)',
'packages/eslint-plugin/src/rules/**/*.?(m|c)ts?(x)',
],
name: 'configs-and-rules',
rules: {
'eslint-plugin/no-property-in-node': [
'error',
Expand Down Expand Up @@ -500,6 +505,7 @@ export default tseslint.config(
},
{
files: ['packages/eslint-plugin/src/rules/index.ts'],
name: 'eslint-plugin/source-files/rules-index-file',
rules: {
// enforce alphabetical ordering
'import/order': ['error', { alphabetize: { order: 'asc' } }],
Expand All @@ -513,10 +519,10 @@ export default tseslint.config(

{
files: [
'packages/scope-manager/src/lib/*.{ts,tsx,cts,mts}',
'packages/eslint-plugin/src/configs/*.{ts,tsx,cts,mts}',
'packages/core/src/configs/*.{ts,tsx,cts,mts}',
'packages/scope-manager/src/lib/*.?(m|c)ts?(x)',
'packages/eslint-plugin/src/configs/*.?(m|c)ts?(x)',
],
name: 'generated-files',
rules: {
'@typescript-eslint/internal/no-poorly-typed-ts-props': 'off',
'@typescript-eslint/internal/no-typescript-default-import': 'off',
Expand All @@ -529,15 +535,27 @@ export default tseslint.config(
//

{
files: ['packages/ast-spec/src/**/*.{ts,tsx,cts,mts}'],
files: ['packages/ast-spec/src/**/*.?(m|c)ts?(x)'],
name: 'ast-spec/source-files',
rules: {
// disallow ALL unused vars
'@typescript-eslint/no-unused-vars': ['error', { caughtErrors: 'all' }],
'@typescript-eslint/sort-type-constituents': 'error',

'perfectionist/sort-interfaces': [
'error',
{
customGroups: {
first: ['type'],
},
groups: ['first', 'unknown'],
},
],
},
},
{
files: ['packages/ast-spec/**/*.{ts,tsx,cts,mts}'],
files: ['packages/ast-spec/**/*.?(m|c)ts?(x)'],
name: 'ast-spec',
rules: {
'no-restricted-imports': [
'error',
Expand All @@ -559,12 +577,18 @@ export default tseslint.config(
jsxA11yPlugin.flatConfigs.recommended,
// https://github.com/facebook/react/pull/30774
// @ts-expect-error -- Temporary types incompatibility pending flat config support
reactPlugin.configs.flat.recommended,
// https://github.com/facebook/react/pull/30774
// @ts-expect-error -- Temporary types incompatibility pending flat config support
fixupConfigRules(compat.config(reactHooksPlugin.configs.recommended)),
{ name: 'react/recommended', ...reactPlugin.configs.flat.recommended },
fixupConfigRules([
{
name: 'react-hooks/recommended',
// https://github.com/facebook/react/pull/30774
// @ts-expect-error -- Temporary types incompatibility pending flat config support
...compat.config(reactHooksPlugin.configs.recommended)[0],
},
]),
],
files: ['packages/website/**/*.{ts,tsx,mts,cts,js,jsx}'],
files: ['packages/website/**/*.?(c|m)[tj]s?(x)'],
name: 'website',
rules: {
'@typescript-eslint/internal/prefer-ast-types-enum': 'off',
'import/no-default-export': 'off',
Expand All @@ -580,18 +604,17 @@ export default tseslint.config(
},
},
{
files: ['packages/website/src/**/*.{ts,tsx,cts,mts}'],
files: ['packages/website/src/**/*.?(m|c)ts?(x)'],
name: 'website/source-files',
rules: {
'import/no-default-export': 'off',
// allow console logs in the website to help with debugging things in production
'no-console': 'off',
},
},
{
files: [
'packages/website-eslint/src/mock/**/*.js',
'**/*.d.{ts,tsx,cts,mts}',
],
files: ['packages/website-eslint/src/mock/**/*.js', '**/*.d.?(m|c)ts?(x)'],
name: 'website/source-files/mocks-and-declaration-files',
rules: {
// mocks and declaration files have to mirror their original package
'import/no-default-export': 'off',
Expand All @@ -604,6 +627,7 @@ export default tseslint.config(
'packages/eslint-plugin/src/configs/flat/*',
'packages/scope-manager/src/configs/*',
],
name: 'all-files',
rules: {
'@typescript-eslint/sort-type-constituents': 'off',
'perfectionist/sort-classes': 'error',
Expand All @@ -618,25 +642,12 @@ export default tseslint.config(
],
},
},
{
files: ['packages/ast-spec/src/**/*.ts'],
rules: {
'perfectionist/sort-interfaces': [
'error',
{
customGroups: {
first: ['type'],
},
groups: ['first', 'unknown'],
},
],
},
},
{
files: [
'packages/eslint-plugin/src/rules/*.ts',
'packages/eslint-plugin-internal/src/rules/*.ts',
],
name: 'eslint-plugin-and-eslint-plugin-internal/source-files/rules',
rules: {
'perfectionist/sort-objects': [
'error',
Expand All @@ -654,6 +665,7 @@ export default tseslint.config(
},
{
files: ['packages/eslint-plugin/tests/rules/*.test.ts'],
name: 'eslint-plugin-rules-test-files',
rules: {
'perfectionist/sort-objects': [
'error',
Expand All @@ -666,6 +678,7 @@ export default tseslint.config(
},
{
files: ['packages/typescript-estree/src/**/*.ts'],
name: 'typescript-estree/source-files',
rules: {
'perfectionist/sort-objects': [
'error',
Expand Down
25 changes: 18 additions & 7 deletions nx.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -29,6 +29,13 @@
"buildDepsTargetName": "vite:build-deps",
"watchDepsTargetName": "vite:watch-deps"
}
},
{
"plugin": "@nx/eslint/plugin",
"include": ["packages/*"],
"options": {
"targetName": "lint"
}
Comment on lines +32 to +38
Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Reference

}
],
"release": {
Expand Down Expand Up @@ -82,16 +89,20 @@
"watch": false
}
},
"@nx/eslint:lint": {
"dependsOn": ["eslint-plugin-internal:build", "typescript-eslint:build"],
"options": {
"noEslintrc": true,
"cache": true,
"eslintConfig": "{workspaceRoot}/eslint.config.mjs"
},
"outputs": ["{options.outputFile}"],
"cache": true
},
Comment on lines +92 to +101
Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Without this repo:lint would not be cached unless We explicitly pass this configuration to the root project.json file.

"lint": {
"executor": "@nx/eslint:lint",
"dependsOn": [
"eslint-plugin:build",
"eslint-plugin-internal:build",
"typescript-eslint:build"
],
"dependsOn": ["eslint-plugin-internal:build", "typescript-eslint:build"],
Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

We are only using typescript-eslint and eslint-plugin-internal inside the eslint.config.mjs file, therefore eslint-plugin:build is not needed here.

"inputs": [
"default",
"{workspaceRoot}/eslint.config.js",
"{workspaceRoot}/eslint.config.mjs",
{
"dependentTasksOutputFiles": "**/*.js",
Expand Down
1 change: 0 additions & 1 deletion package.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -92,7 +92,6 @@
"execa": "7.2.0",
"globals": "^16.0.0",
"husky": "^9.1.4",
"jiti": "2.4.2",
"knip": "^5.41.1",
"lint-staged": "^15.2.2",
"make-dir": "^4.0.0",
Expand Down
5 changes: 4 additions & 1 deletion project.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,10 @@
"outputs": ["{workspaceRoot}/dist"]
},
"lint": {
"command": "eslint . --ignore-pattern=packages --cache"
"executor": "@nx/eslint:lint",
"options": {
"lintFilePatterns": ["{workspaceRoot}/!packages"]
}
},
"generate-configs": {
"command": "tsx tools/scripts/generate-configs.mts"
Expand Down
19 changes: 9 additions & 10 deletions yarn.lock
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5733,7 +5733,6 @@ __metadata:
execa: 7.2.0
globals: ^16.0.0
husky: ^9.1.4
jiti: 2.4.2
knip: ^5.41.1
lint-staged: ^15.2.2
make-dir: ^4.0.0
Expand Down Expand Up @@ -12549,15 +12548,6 @@ __metadata:
languageName: node
linkType: hard

"jiti@npm:2.4.2, jiti@npm:^2.4.2":
version: 2.4.2
resolution: "jiti@npm:2.4.2"
bin:
jiti: lib/jiti-cli.mjs
checksum: c6c30c7b6b293e9f26addfb332b63d964a9f143cdd2cf5e946dbe5143db89f7c1b50ad9223b77fb1f6ddb0b9c5ecef995fea024ecf7d2861d285d779cde66e1e
languageName: node
linkType: hard

"jiti@npm:^1.20.0":
version: 1.21.6
resolution: "jiti@npm:1.21.6"
Expand All @@ -12567,6 +12557,15 @@ __metadata:
languageName: node
linkType: hard

"jiti@npm:^2.4.2":
version: 2.4.2
resolution: "jiti@npm:2.4.2"
bin:
jiti: lib/jiti-cli.mjs
checksum: c6c30c7b6b293e9f26addfb332b63d964a9f143cdd2cf5e946dbe5143db89f7c1b50ad9223b77fb1f6ddb0b9c5ecef995fea024ecf7d2861d285d779cde66e1e
languageName: node
linkType: hard

"jju@npm:~1.4.0":
version: 1.4.0
resolution: "jju@npm:1.4.0"
Expand Down