chore: Upgrade ESLint and all plugis & revalidate the config and ALL of the rules #15287

peter-sanderson · 2024-11-06T21:14:31Z

This is PR that upgrades the ESLint and all its plugins + does refactoring of the whole configuration.

Configuration is now written in modern flat format.
Configuration is separated in @trezor/eslint but its used globally.
Some packages, if they need to define custom rules will require it in package.json and then they can define their own config.
Most of the newly recommended rules were introduced in previous mini-PRs (see the list here
I had to remove no-shadow rule, as it start reporting insane amount of stuff and it was hard to configure. I think we can solve it separately in future PR.

I have written a bunch of comments in the PR itself to explain stuff. I hope it help you to do code-review.

Performance:

Outcome of the reset && find . -type f -name ".eslintcache" -delete && time TIMING=1 yarn lint:js

This PR:

Rule                              | Time (ms) | Relative
:---------------------------------|----------:|--------:
@typescript-eslint/no-unused-vars |  6444.161 |    18.2%
import/no-extraneous-dependencies |  4620.629 |    13.1%
import/namespace                  |  4135.507 |    11.7%
import/named                      |  3041.406 |     8.6%
import/order                      |  2395.140 |     6.8%
react/no-direct-mutation-state    |  2234.944 |     6.3%
import/no-duplicates              |  1993.402 |     5.6%
react/require-render-return       |   673.360 |     1.9%
padding-line-between-statements   |   370.092 |     1.0%
react/no-deprecated               |   361.447 |     1.0%
TIMING=1 yarn lint:js  96,91s user 4,91s system 152% cpu 1:06,78 total

`develop`

Rule                                     | Time (ms) | Relative
:----------------------------------------|----------:|--------:
import/order                             |  2306.349 |    21.9%
import/no-extraneous-dependencies        |  1772.432 |    16.9%
@typescript-eslint/no-unused-vars        |  1282.584 |    12.2%
import/no-duplicates                     |   409.478 |     3.9%
jest/no-standalone-expect                |   331.732 |     3.2%
react/jsx-no-target-blank                |   312.352 |     3.0%
mdx/remark                               |   295.082 |     2.8%
padding-line-between-statements          |   244.067 |     2.3%
@typescript-eslint/no-restricted-imports |   198.185 |     1.9%
react/no-render-return-value             |   187.968 |     1.8%
TIMING=1 yarn lint:js  44,93s user 1,74s system 172% cpu 27,112 total

I assume the much longer run is due to many more rules and files are being checked as I removed many of the offs we had and enabled many of the checks for most of the packages. Also I suppose with recommended settings some of the rules were added on top of what we have.

github-actions · 2024-11-06T21:18:19Z

🚀 Expo preview is ready!

Project → trezor-suite-preview
Platforms → android, ios
Scheme → trezorsuitelite
Runtime Version → 10
More info

Learn more about 𝝠 Expo Github Action

peter-sanderson · 2024-11-06T21:31:41Z

eslint.config.mjs

@@ -0,0 +1,3 @@
+import { eslint } from '@trezor/eslint';
+
+export default [...eslint];


Repository top-level config is now lust a link into package that contains all of the configuration.

peter-sanderson · 2024-11-06T21:33:06Z

package.json

@@ -31,7 +31,7 @@
        "type-check": "yarn nx run-many --target=type-check",
        "type-check:force": "rimraf -rf -- **/libDev && yarn type-check",
        "test:unit": "yarn nx run-many --target=test:unit",
-        "lint:js": "eslint . --cache --cache-strategy content --ignore-path .gitignore",
+        "lint:js": "eslint . --cache --cache-strategy content --flag unstable_config_lookup_from_file",


This flag loads configuration which is closest to the checked file. This enables the overriding of the rules per package.

See: https://eslint.org/docs/latest/use/configure/configuration-files#experimental-configuration-file-resolution

peter-sanderson · 2024-11-07T10:22:55Z

packages/components/.storybook/main.js

@@ -14,18 +22,12 @@ module.exports = {
        name: getAbsolutePath('@storybook/react-webpack5'),
        options: {},
    },
-    babel: async options => {


I have tested the build of storybook and it works.

peter-sanderson · 2024-11-07T10:27:52Z

packages/product-components/.storybook/main.js

@@ -14,18 +22,12 @@ module.exports = {
        name: getAbsolutePath('@storybook/react-webpack5'),
        options: {},
    },
-    babel: async options => {


Tested the build of story book and it works.

peter-sanderson · 2024-11-07T10:33:31Z

packages/transport/jest.config.js

@@ -2,7 +2,6 @@ const { ...baseConfig } = require('../../jest.config.base');

 module.exports = {
    ...baseConfig,
-    testEnvironment: 'node',


duplicate key

…of the rules

peter-sanderson · 2024-11-07T22:36:49Z

packages/components/src/components/AutoScalingInput/AutoScalingInputExamples.stories.tsx

@@ -9,15 +9,13 @@ const Wrapper = styled.div`
    flex-direction: column;
 `;

-// eslint-disable-next-line local-rules/no-override-ds-component


When overwrite happens inside the @trezor/components it wont get reported. And now the ESLint complains about unused ignore. It is here multiple times.

peter-sanderson · 2024-11-07T22:38:11Z

packages/connect-explorer/src/components/CommonParamsLink.tsx

@@ -7,7 +7,6 @@ const Floating = styled.div`
    margin-top: -2rem;
 `;

-// eslint-disable-next-line local-rules/no-override-ds-component


Incorrect Link is from 'next/link' and not from @trezor/components. Now ESLint correctly raised error that this is unused ignore.

peter-sanderson · 2024-11-07T22:39:22Z

packages/product-components/src/components/ConfirmOnDevice/ConfirmOnDeviceContent.tsx

@@ -86,7 +86,6 @@ const Step = styled.div<{ $isActive: boolean }>`
        `}
 `;

-// eslint-disable-next-line local-rules/no-override-ds-component


This is override inside of the @trezor/produce-components this wont be reported by the rule and therefore it is unused ignore.

peter-sanderson · 2024-11-07T22:40:25Z

packages/schema-utils/src/codegen.ts

@@ -1,3 +1,4 @@
+// eslint-disable-next-line import/no-extraneous-dependencies
 import * as Codegen from '@sinclair/typebox-codegen/typescript';


@martykan I am not sure how to solve this. Please take a look.

…t is upgraded

peter-sanderson requested review from martykan, szymonlesisz, karliatto, mroz22, matejkriz, a team, komret, tomasklim, jvaclavik, adamhavel, marekrjpolak and Nodonisko as code owners November 6, 2024 21:14

This was referenced Nov 6, 2024

Upgrade ESLint and all plugis & revalidate the config and ALL of the rules #15267

Closed

EPIC - ESLint upgrade & refactor #15196

Open

peter-sanderson commented Nov 6, 2024

View reviewed changes

peter-sanderson force-pushed the eslint-upgrade5 branch 2 times, most recently from b0935ec to 7717018 Compare November 6, 2024 21:49

peter-sanderson mentioned this pull request Nov 7, 2024

Upgrade ESLint and all plugis & revalidate the config and ALL of the rules #15285

Closed

1 task

peter-sanderson force-pushed the eslint-upgrade5 branch 2 times, most recently from 1a396a1 to c07ea17 Compare November 7, 2024 10:20

peter-sanderson commented Nov 7, 2024

View reviewed changes

peter-sanderson force-pushed the eslint-upgrade5 branch 4 times, most recently from 694c6c9 to fb7a053 Compare November 7, 2024 17:21

chore: Upgrade ESLint and all plugis & revalidate the config and ALL …

0d0d79a

…of the rules

peter-sanderson added 2 commits November 7, 2024 22:21

chore: add eslint-plugin-jsx-a11y

8d3b515

chore: varios fixies

92bc152

peter-sanderson force-pushed the eslint-upgrade5 branch from fb7a053 to 92bc152 Compare November 7, 2024 22:35

peter-sanderson commented Nov 7, 2024

View reviewed changes

chore: improve no-override-ds-component so it works better when ESLin…

0212041

…t is upgraded

peter-sanderson force-pushed the eslint-upgrade5 branch from d5cbbd0 to 97d82f1 Compare November 7, 2024 23:17

chore: fix 'yarn update-project-references' & other fixies

79c88a2

peter-sanderson force-pushed the eslint-upgrade5 branch from 97d82f1 to 79c88a2 Compare November 7, 2024 23:26

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

chore: Upgrade ESLint and all plugis & revalidate the config and ALL of the rules #15287

chore: Upgrade ESLint and all plugis & revalidate the config and ALL of the rules #15287

peter-sanderson commented Nov 6, 2024 •

edited

Loading

github-actions bot commented Nov 6, 2024 •

edited

Loading

peter-sanderson Nov 6, 2024

peter-sanderson Nov 6, 2024

peter-sanderson Nov 7, 2024

peter-sanderson Nov 7, 2024

peter-sanderson Nov 7, 2024

peter-sanderson Nov 7, 2024

peter-sanderson Nov 7, 2024

peter-sanderson Nov 7, 2024 •

edited

Loading

peter-sanderson Nov 7, 2024

		@@ -0,0 +1,3 @@
		import { eslint } from '@trezor/eslint';

		export default [...eslint];

		@@ -1,3 +1,4 @@
		// eslint-disable-next-line import/no-extraneous-dependencies
		import * as Codegen from '@sinclair/typebox-codegen/typescript';

chore: Upgrade ESLint and all plugis & revalidate the config and ALL of the rules #15287

Are you sure you want to change the base?

chore: Upgrade ESLint and all plugis & revalidate the config and ALL of the rules #15287

Conversation

peter-sanderson commented Nov 6, 2024 • edited Loading

Performance:

This PR:

develop

github-actions bot commented Nov 6, 2024 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

peter-sanderson Nov 7, 2024 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

peter-sanderson commented Nov 6, 2024 •

edited

Loading

`develop`

github-actions bot commented Nov 6, 2024 •

edited

Loading

peter-sanderson Nov 7, 2024 •

edited

Loading