forked from Russ76/foxglove_studio
-
Notifications
You must be signed in to change notification settings - Fork 0
/
.eslintrc.yaml
276 lines (249 loc) · 14.5 KB
/
.eslintrc.yaml
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
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
env:
browser: true
es6: true
node: true
ignorePatterns:
- dist
- out
- template
- "packages/**/wasm/*.js"
- "!.storybook"
- storybook-static
plugins:
- file-progress
extends:
- plugin:@foxglove/base
- plugin:@foxglove/react
- plugin:@foxglove/jest
settings:
import/internal-regex: "^@foxglove"
rules:
"@foxglove/license-header": error
# show progress while linting
file-progress/activate: warn
# enabled in .eslintrc.ci.yaml
prettier/prettier: off
import/no-self-import: off
import/no-duplicates: off
id-denylist:
- error
- useEffectOnce
- window # don't allow redefining window
no-console: off # configured in no-restricted-syntax
react/jsx-uses-react: off
react/prop-types: off # Unnecessary with typescript validation
react-hooks/exhaustive-deps:
- error
- additionalHooks: "(useAsync(?!AppConfigurationValue))|useCallbackWithToast"
react/jsx-curly-brace-presence: [error, never]
# The _sx_ property is slow
# https://stackoverflow.com/questions/68383046/is-there-a-performance-difference-between-the-sx-prop-and-the-makestyles-function
react/forbid-component-props:
- error
- forbid:
- propName: "sx"
message: "Use of the sx prop is not advised due to performance issues. Consider using alternative styling methods instead."
no-warning-comments:
- error
- terms: ["fixme", "xxx"]
location: anywhere
no-restricted-imports:
- error
- paths:
- name: "styled-components"
message: "styled-components has been deprecated. Use tss-react/mui instead."
- name: "@fluentui/react"
message: "@fluentui/react has been deprecated. Use tss-react/mui instead."
- name: "@mui/material"
importNames: [styled]
message: "@mui/styled has performance implications. Use tss-react/mui instead."
- name: "@mui/material/styles/styled"
message: "@mui/styled has performance implications. Use tss-react/mui instead."
- name: "@mui/system"
message: "@mui/styled has performance implications. Use tss-react/mui instead."
- name: "@mui/system/styled"
message: "@mui/styled has performance implications. Use tss-react/mui instead."
- name: "@emotion/styled"
message: "@emotion/styled has performance implications. Use tss-react/mui instead."
- name: "lodash"
importNames: [get]
message: "Use optional chaining instead of lodash.get."
- name: "lodash/get"
message: "Use optional chaining instead of lodash.get."
no-restricted-syntax:
- error
- selector: "MethodDefinition[kind='get'], Property[kind='get']"
message: "Property getters are not allowed; prefer function syntax instead."
- selector: "MethodDefinition[kind='set'], Property[kind='set']"
message: "Property setters are not allowed; prefer function syntax instead."
# We disable console methods here rather than using no-console so that it doesn't prohibit overrides such as "console.info = ..."
- selector: "CallExpression[callee.object.name='console'][callee.property.name!=/^(warn|error|debug|assert)$/]"
message: "Unexpected property on console object was called"
- selector: "TSNullKeyword, Literal[raw=null]"
message: >
Prefer undefined instead of null. When required for React refs/components, use
the `ReactNull` alias. Otherwise, if strictly necessary, disable this error with
`// eslint-disable-next-line no-restricted-syntax`. For rationale, see:
https://github.com/sindresorhus/meta/discussions/7"
jest/no-done-callback: off # Can be a useful alternative to promises
jest/expect-expect:
[error, { assertFunctionNames: [expect*, sendNotification.expectCalledDuringTest] }]
overrides:
- files: ["*.ts", "*.tsx"]
extends:
- plugin:@foxglove/typescript
parserOptions:
project: ./tsconfig.eslint.json
rules:
"@typescript-eslint/ban-ts-comment":
- error
- ts-expect-error: allow-with-description
"@typescript-eslint/no-inferrable-types": off # It's sometimes useful to explicitly name to guard against future changes
"@typescript-eslint/no-empty-function": off
"@typescript-eslint/no-implied-eval": off # We need to use `new Function()`
# These are related to `any` types, which we generally don't have except from imports
"@typescript-eslint/no-unsafe-member-access": off
"@typescript-eslint/no-unsafe-return": off
"@typescript-eslint/no-unsafe-assignment": off
"@typescript-eslint/no-unsafe-call": off
"@typescript-eslint/require-await": off # Async functions without await are used to satisfy interface requirements
# These could theoretically be turned on (or merit investigation) but are currently noisy
"@typescript-eslint/no-misused-promises": off # Often used with e.g. useCallback(async () => {})
"@typescript-eslint/restrict-template-expressions": off
"@typescript-eslint/prefer-regexp-exec": off
"@typescript-eslint/no-unnecessary-condition": error
"@typescript-eslint/unbound-method": [error, { ignoreStatic: true }]
- rules:
"@typescript-eslint/no-explicit-any": off
files:
- "**/*.stories.tsx"
- "**/*.test.tsx"
- "**/*.test.ts"
- rules:
"no-restricted-imports": off
files:
# Ignore existing implementations of fluentui, styled-components, and @mui/styled
- "web/src/VersionBanner.tsx"
- "packages/studio-base/src/components/Autocomplete.tsx"
- "packages/studio-base/src/components/ChildToggle/index.tsx"
- "packages/studio-base/src/components/ColorPicker/index.tsx"
- "packages/studio-base/src/components/CopyText.tsx"
- "packages/studio-base/src/components/DataSourceSidebar/DataSourceSidebar.tsx"
- "packages/studio-base/src/components/DataSourceSidebar/TopicList.tsx"
- "packages/studio-base/src/components/DocumentDropListener.tsx"
- "packages/studio-base/src/components/DropOverlay.tsx"
- "packages/studio-base/src/components/EmptyPanelLayout.tsx"
- "packages/studio-base/src/components/EmptyState.tsx"
- "packages/studio-base/src/components/ErrorDisplay.tsx"
- "packages/studio-base/src/components/ExpandingToolbar.tsx"
- "packages/studio-base/src/components/ExtensionDetails.tsx"
- "packages/studio-base/src/components/ExtensionsSidebar/index.tsx"
- "packages/studio-base/src/components/GradientPicker.tsx"
- "packages/studio-base/src/components/KeyboardShortcut.tsx"
- "packages/studio-base/src/components/LayoutBrowser/LayoutRow.tsx"
- "packages/studio-base/src/components/LayoutBrowser/SignInPrompt.tsx"
- "packages/studio-base/src/components/LegacyStyledComponents.tsx"
- "packages/studio-base/src/components/Menu/Item.tsx"
- "packages/studio-base/src/components/Menu/Menu.tsx"
- "packages/studio-base/src/components/NotificationModal.tsx"
- "packages/studio-base/src/components/OpenDialog/Connection.tsx"
- "packages/studio-base/src/components/OpenDialog/OpenDialog.tsx"
- "packages/studio-base/src/components/OpenDialog/Start.tsx"
- "packages/studio-base/src/components/OpenDialog/View.tsx"
- "packages/studio-base/src/components/Panel.tsx"
- "packages/studio-base/src/components/PanelLayout.tsx"
- "packages/studio-base/src/components/PanelList/index.tsx"
- "packages/studio-base/src/components/PanelRoot.tsx"
- "packages/studio-base/src/components/PanelToolbar/PanelActionsDropdown.tsx"
- "packages/studio-base/src/components/PanelToolbar/ToolbarIconButton.tsx"
- "packages/studio-base/src/components/PanelToolbar/index.tsx"
- "packages/studio-base/src/components/PlaybackControls/PlaybackTimeDisplayMethod.tsx"
- "packages/studio-base/src/components/PlaybackControls/Slider.stories.tsx"
- "packages/studio-base/src/components/PlaybackSpeedControls.tsx"
- "packages/studio-base/src/components/SegmentedControl.tsx"
- "packages/studio-base/src/components/SettingsTreeEditor/FieldEditor.tsx"
- "packages/studio-base/src/components/SettingsTreeEditor/NodeEditor.tsx"
- "packages/studio-base/src/components/SettingsTreeEditor/VisibilityToggle.tsx"
- "packages/studio-base/src/components/SettingsTreeEditor/index.tsx"
- "packages/studio-base/src/components/SettingsTreeEditor/inputs/ColorGradientInput.tsx"
- "packages/studio-base/src/components/SettingsTreeEditor/inputs/ColorPickerInput.tsx"
- "packages/studio-base/src/components/SettingsTreeEditor/inputs/ColorScalePicker.tsx"
- "packages/studio-base/src/components/SettingsTreeEditor/inputs/ColorSwatch.tsx"
- "packages/studio-base/src/components/SettingsTreeEditor/inputs/NumberInput.tsx"
- "packages/studio-base/src/components/ShareJsonModal.tsx"
- "packages/studio-base/src/components/Sidebar/SidebarButton.tsx"
- "packages/studio-base/src/components/Sidebar/index.tsx"
- "packages/studio-base/src/components/SidebarContent.tsx"
- "packages/studio-base/src/components/StudioToastProvider.tsx"
- "packages/studio-base/src/components/TextHighlight.tsx"
- "packages/studio-base/src/components/TimeBasedChart/index.tsx"
- "packages/studio-base/src/components/Tooltip.tsx"
- "packages/studio-base/src/panels/DataSourceInfo/index.tsx"
- "packages/studio-base/src/panels/Image/components/Toolbar.tsx"
- "packages/studio-base/src/panels/Image/components/TopicDropdown.tsx"
- "packages/studio-base/src/panels/Image/components/ZoomMenu.tsx"
- "packages/studio-base/src/panels/Image/index.tsx"
- "packages/studio-base/src/panels/InternalLogs/index.tsx"
- "packages/studio-base/src/panels/LegacyPlot/index.tsx"
- "packages/studio-base/src/panels/Log/FilterBar.tsx"
- "packages/studio-base/src/panels/Log/index.tsx"
- "packages/studio-base/src/panels/NodePlayground/BottomBar/DiagnosticsSection.tsx"
- "packages/studio-base/src/panels/NodePlayground/BottomBar/index.tsx"
- "packages/studio-base/src/panels/NodePlayground/Sidebar.tsx"
- "packages/studio-base/src/panels/NodePlayground/index.tsx"
- "packages/studio-base/src/panels/Parameters/AnimatedRow.tsx"
- "packages/studio-base/src/panels/Plot/PathSettingsModal.tsx"
- "packages/studio-base/src/panels/Publish/index.tsx"
- "packages/studio-base/src/panels/RawMessages/DiffSpan.tsx"
- "packages/studio-base/src/panels/RawMessages/Metadata.tsx"
- "packages/studio-base/src/panels/Tab/TabbedToolbar.tsx"
- "packages/studio-base/src/panels/Tab/ToolbarTab.tsx"
- "packages/studio-base/src/panels/Tab/index.tsx"
- "packages/studio-base/src/panels/Table/Table.tsx"
- "packages/studio-base/src/panels/Table/TableCell.tsx"
- "packages/studio-base/src/panels/ThreeDimensionalViz/CameraInfo/index.tsx"
- "packages/studio-base/src/panels/ThreeDimensionalViz/FollowTFControl.tsx"
- "packages/studio-base/src/panels/ThreeDimensionalViz/GridBuilder.stories.tsx"
- "packages/studio-base/src/panels/ThreeDimensionalViz/Interactions/GlobalVariableLink/SGlobalVariableLink.tsx"
- "packages/studio-base/src/panels/ThreeDimensionalViz/Interactions/GlobalVariableLink/UnlinkGlobalVariables.tsx"
- "packages/studio-base/src/panels/ThreeDimensionalViz/Interactions/GlobalVariableLink/UnlinkWrapper.tsx"
- "packages/studio-base/src/panels/ThreeDimensionalViz/Interactions/GlobalVariableLink/index.tsx"
- "packages/studio-base/src/panels/ThreeDimensionalViz/Interactions/GlobalVariableName.tsx"
- "packages/studio-base/src/panels/ThreeDimensionalViz/Interactions/Interaction.stories.tsx"
- "packages/studio-base/src/panels/ThreeDimensionalViz/Interactions/InteractionContextMenu.tsx"
- "packages/studio-base/src/panels/ThreeDimensionalViz/Interactions/Interactions.tsx"
- "packages/studio-base/src/panels/ThreeDimensionalViz/Interactions/LinkedGlobalVariableList.tsx"
- "packages/studio-base/src/panels/ThreeDimensionalViz/Interactions/ObjectDetails.tsx"
- "packages/studio-base/src/panels/ThreeDimensionalViz/Interactions/PointCloudDetails.tsx"
- "packages/studio-base/src/panels/ThreeDimensionalViz/Interactions/TopicLink.tsx"
- "packages/studio-base/src/panels/ThreeDimensionalViz/Interactions/styling.ts"
- "packages/studio-base/src/panels/ThreeDimensionalViz/SearchText.tsx"
- "packages/studio-base/src/panels/ThreeDimensionalViz/TopicTree/NamespaceMenu.tsx"
- "packages/studio-base/src/panels/ThreeDimensionalViz/TopicTree/NodeName.tsx"
- "packages/studio-base/src/panels/ThreeDimensionalViz/TopicTree/TextHighlight.tsx"
- "packages/studio-base/src/panels/ThreeDimensionalViz/TopicTree/TextMiddleTruncate.tsx"
- "packages/studio-base/src/panels/ThreeDimensionalViz/TopicTree/TooltipRow.tsx"
- "packages/studio-base/src/panels/ThreeDimensionalViz/TopicTree/TooltipTable.tsx"
- "packages/studio-base/src/panels/ThreeDimensionalViz/TopicTree/TopicTree.tsx"
- "packages/studio-base/src/panels/ThreeDimensionalViz/TopicTree/TopicTreeSwitcher.tsx"
- "packages/studio-base/src/panels/ThreeDimensionalViz/TopicTree/TreeNodeMenu.tsx"
- "packages/studio-base/src/panels/ThreeDimensionalViz/TopicTree/TreeNodeRow.tsx"
- "packages/studio-base/src/panels/ThreeDimensionalViz/TopicTree/renderStyleExpressionNodes.tsx"
- "packages/studio-base/src/panels/ThreeDimensionalViz/TopicTree/renderTreeNodes.tsx"
- "packages/studio-base/src/panels/ThreeDimensionalViz/World.tsx"
- "packages/studio-base/src/panels/ThreeDimensionalViz/commands/Cover.stories.tsx"
- "packages/studio-base/src/panels/URDFViewer/JointValueSliders.tsx"
- "packages/studio-base/src/panels/URDFViewer/OverlayControls.tsx"
- "packages/studio-base/src/panels/URDFViewer/index.tsx"
- "packages/studio-base/src/panels/URDFViewer/useRobotDescriptionAsset.tsx"
- "packages/studio-base/src/panels/diagnostics/DiagnosticStatus.tsx"
- "packages/studio-base/src/panels/diagnostics/DiagnosticSummary.tsx"
- "packages/studio-base/src/screens/LaunchPreferenceScreen.tsx"
- "packages/studio-base/src/stories/PanelSetup.tsx"
- "packages/studio-base/src/stories/storyHelpers.tsx"
- "packages/studio-base/src/theme/ThemeProvider.tsx"
- "packages/studio-base/src/theme/createFluentTheme.ts"
- "packages/studio-base/src/theme/fluentComponents.ts"
- "packages/studio-base/src/theme/index.stories.tsx"
- "packages/studio-base/src/typings/fluentui.d.ts"
- "packages/studio-base/src/typings/styled-components.d.ts"