forked from mui/toolpad
-
Notifications
You must be signed in to change notification settings - Fork 0
/
.eslintrc.js
171 lines (168 loc) · 5.36 KB
/
.eslintrc.js
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
const baseline = require('@mui/monorepo/.eslintrc');
const lodash = require('lodash');
const path = require('path');
const ALLOWED_LODASH_METHODS = new Set(['throttle', 'debounce', 'set']);
module.exports = {
...baseline,
settings: {
'import/resolver': {
webpack: {
config: path.join(__dirname, './eslintWebpackResolverConfig.js'),
},
exports: {},
},
},
extends: [
...baseline.extends,
// Motivation: https://github.com/shian15810/eslint-plugin-typescript-enum#motivations
'plugin:typescript-enum/recommended',
],
/**
* Sorted alphanumerically within each group. built-in and each plugin form
* their own groups.
*/
rules: {
...baseline.rules,
'import/prefer-default-export': ['off'],
// TODO move rule into the main repo once it has upgraded
'@typescript-eslint/return-await': ['off'],
'no-restricted-imports': [
'error',
{
paths: [
{
name: '@mui/icons-material',
message: 'Use @mui/icons-material/<Icon> instead.',
},
{
name: 'lodash-es',
importNames: Object.keys(lodash).filter((key) => !ALLOWED_LODASH_METHODS.has(key)),
message:
'Avoid kitchensink libraries like lodash-es. We prefer a slightly more verbose, but more universally understood javascript style',
},
{
name: 'react-query',
message: 'deprecated package, use @tanstack/react-query instead.',
},
],
patterns: [
{
group: ['lodash-es/*'],
message: 'Use `import { debounce } from "lodash-es";` instead.',
},
],
},
],
'no-restricted-syntax': [
...baseline.rules['no-restricted-syntax'].filter((rule) => {
// Too opinionated for Toolpad
return rule?.selector !== 'ForOfStatement';
}),
],
// Turning react/jsx-key back on.
// https://github.com/airbnb/javascript/blob/5155aa5fc1ea9bb2c6493a06ddbd5c7a05414c86/packages/eslint-config-airbnb/rules/react.js#L94
'react/jsx-key': ['error', { checkKeyMustBeforeSpread: true, warnOnDuplicates: true }],
// This got turned of in the mono-repo:
// See https://github.com/mui/mui-toolpad/pull/866#discussion_r957222171
'react/no-unused-prop-types': [
'error',
{
customValidators: [],
skipShapeProps: true,
},
],
'import/no-unresolved': [
'error',
{
// https://github.com/import-js/eslint-plugin-import/issues/1739
ignore: ['\\.md\\?muiMarkdown$'],
},
],
'import/no-restricted-paths': [
'error',
{
zones: [
{
// Don't leak the internal runtime abstraction. It's on its way to be moved towards a separate package
target: './packages/toolpad-studio/src/runtime',
from: './packages/toolpad-studio/src/',
except: ['./runtime'],
},
],
},
],
},
overrides: [
{
files: ['examples/**/*'],
rules: {
// We use it for demonstration purposes
'no-console': 'off',
// Personal preference
'no-underscore-dangle': 'off',
// no node_modules in examples as they are not installed
'import/no-unresolved': 'off',
},
},
{
files: [
'packages/create-toolpad-app/**/*',
'packages/toolpad-studio/**/*',
'packages/toolpad-studio/**/*',
'packages/toolpad-utils/**/*',
'packages/toolpad-studio-runtime/**/*',
'packages/toolpad-studio-components/**/*',
],
excludedFiles: ['tsup.config.ts', '*.spec.ts', '*.spec.tsx', 'vitest.config.ts'],
rules: {
'import/no-extraneous-dependencies': ['error'],
},
},
{
files: [
/**
* Basically all code that is guaranteed being bundled for the client side and never used on serverside code
* can be dev dependencies to reduce the size of the published package
*/
'packages/toolpad-studio/src/components/**/*',
'packages/toolpad-studio/src/toolpad/**/*',
'packages/toolpad-studio/src/runtime/**/*',
],
excludedFiles: ['*.spec.ts', '*.spec.tsx'],
rules: {
'import/no-extraneous-dependencies': ['error', { devDependencies: true }],
},
},
{
// Starting small, we will progressively expand this to more packages.
files: [
// 'packages/create-toolpad-app/**/*',
// 'packages/toolpad-core/**/*',
// 'packages/toolpad-studio/**/*',
// 'packages/toolpad-studio/**/*',
'packages/toolpad-utils/**/*',
// 'packages/toolpad-studio-runtime/**/*',
// 'packages/toolpad-studio-components/**/*',
],
rules: {
'@typescript-eslint/no-explicit-any': ['error'],
},
},
{
files: ['packages/toolpad-studio/pages/**/*'],
rules: {
// The pattern is useful to type Next.js pages
'react/function-component-definition': 'off',
},
},
{
// Disabling this rule for now:
// https://github.com/mui/material-ui/blob/9737bc85bb6960adb742e7709e9c3710c4b6cedd/.eslintrc.js#L359
files: ['packages/*/src/**/*{.ts,.tsx,.js}'],
excludedFiles: ['*.d.ts', '*.spec.ts', '*.spec.tsx'],
rules: {
'import/no-cycle': ['error', { ignoreExternal: true }],
},
},
],
};