Make linting less badder (#3794)

* Run eslint from root

* turn off duplicative type rules

* Remove prettier

* Add biome for formatting

* Add ignore

* ignore fixtures

* Biome format fixes

* update lint-staged

* update package-lock

* switch prettier to biome

* run new lint rule in ci

* update package specific rules

* cleanup lint:fix

* remove duplicate tsconfigs

* make eslint happy

* fix spacing

* Move lint:diff to root package.json

.githooks/pre-push

@@ -1,3 +1,3 @@
 #!/usr/bin/env sh
 
-npm run lint:diff --workspaces
+npm run lint:diff

.github/workflows/lint.yml

@@ -46,5 +46,5 @@ jobs:
         working-directory: ${{ github.workspace }}
 
 
-      - run: npm run lint --workspaces --if-present
+      - run: npm run lint
         working-directory: ${{ github.workspace }}

biome.json

@@ -0,0 +1,43 @@
+{
+  "$schema": "https://biomejs.dev/schemas/1.9.4/schema.json",
+  "vcs": {
+    "enabled": true,
+    "clientKind": "git",
+    "useIgnoreFile": false
+  },
+  "files": {
+    "ignoreUnknown": true,
+    "ignore": [
+      "**/node_modules/**",
+      "**/dist/**",
+      "**/coverage/**",
+      "**/ethereum-tests/**",
+      "**/config/**",
+      "**/4844-interop/**",
+      "**/scripts/**",
+      "**/rlp/bin/**",
+      "**/benchmarks/fixture/**"
+    ]
+  },
+  "formatter": {
+    "enabled": true,
+    "indentStyle": "space",
+    "indentWidth": 2,
+    "lineWidth": 100
+  },
+  "organizeImports": {
+    "enabled": false
+  },
+  "linter": {
+    "enabled": false,
+    "rules": {
+      "recommended": true
+    }
+  },
+  "javascript": {
+    "formatter": {
+      "quoteStyle": "single",
+      "semicolons": "asNeeded"
+    }
+  }
+}

config/cli/lint-diff.sh

@@ -2,9 +2,9 @@
 REMOTE=$(git rev-parse --symbolic-full-name --abbrev-ref @{u})
 
 if [ -z "$REMOTE" ]; then
-    FILESCHANGED=". --ext .js,.jsx,.ts,.tsx"
+    FILESCHANGED=". --ext .js,.ts"
 else
-    FILESCHANGED=$(git diff --diff-filter=d --name-only --relative $REMOTE | grep -E '\.(js|jsx|ts|tsx)')
+    FILESCHANGED=$(git diff --diff-filter=d --name-only --relative $REMOTE | grep -E '\.(js|ts)')
 fi
 
 echo $FILESCHANGED
@@ -25,8 +25,8 @@ dim() {
     echo "${DIM}$1${NOCOLOR}"
 }
 
-dim "> eslint --format codeframe --config ./.eslintrc.cjs . \\ "
-dim "\t --ext .js,.jsx,.ts,.tsx \\ "
+dim "> eslint --format codeframe --config ./config/eslint.cjs . \\ "
+dim "\t --ext .js,.ts \\ "
 
 blue "[Lint]${NOCOLOR} checking..."
 
@@ -35,7 +35,7 @@ if [ -z "$FILESCHANGED" ]; then
     exit
 fi
 
-eslint --format codeframe --config ./.eslintrc.cjs $FILESCHANGED
+eslint --format codeframe --config ./config/eslint.cjs $FILESCHANGED
 
 RETURN_CODE=$?
 

config/eslint.cjs

@@ -5,7 +5,6 @@ module.exports = {
     'github',
     'implicit-dependencies',
     'import',
-    'prettier',
     'simple-import-sort',
     'ethereumjs',
   ],
@@ -20,22 +19,27 @@ module.exports = {
     'coverage',
     'dist',
     'node_modules',
-    'prettier.config.js',
     'recipes',
     'rlp.cjs',
     'scripts',
     'typedoc.js',
-    'webpack.config.js',
     'vitest.config.ts',
     'vitest.config.browser.ts',
-    'vitest.config.unit.ts'
+    'vitest.config.unit.ts',
+    'vite.*.ts',
+    'ethereum-tests',
+    'archive',
+    'devnets',
+    'eslint',
+    'lint-staged.config.js',
+    'tsconfig.lint.json',
+    'package.json',
   ],
   extends: [
     'typestrict',
     'eslint:recommended',
     'plugin:import/recommended',
     'plugin:import/typescript',
-    'prettier',
   ],
   rules: {
     'no-restricted-imports': ['error', 'ethereum-cryptography/utils.js'],
@@ -62,17 +66,18 @@ module.exports = {
     '@typescript-eslint/restrict-plus-operands': 'off',
     '@typescript-eslint/return-await': 'error',
     '@typescript-eslint/strict-boolean-expressions': ['error'],
+    '@typescript-eslint/no-use-before-define': 'warn', // TODO: decide if we care
     eqeqeq: 'error',
     'github/array-foreach': 'error',
     'implicit-dependencies/no-implicit': ['error', { peer: true, dev: true, optional: true }],
-    'import/default': 'error',
+    'import/default': 'off',
     'import/export': 'error',
     'import/exports-last': 'off', // TODO: set to `warn` for fixing and then `error`
     'import/extensions': ['error','ignorePackages'],
     'import/first': 'error',
     'import/group-exports': 'off',
-    'import/named': 'error',
-    'import/namespace': 'error',
+    'import/named': 'off',
+    'import/namespace': 'off',
     'import/no-absolute-path': 'error',
     'import/no-anonymous-default-export': 'error',
     'import/no-cycle': 'off', // TODO: set to `warn` for fixing and then `error`
@@ -103,26 +108,53 @@ module.exports = {
     'no-dupe-class-members': 'off',
     'no-extra-semi': 'off',
     'no-redeclare': 'off',
+    'no-undef': 'off',
     'no-unused-vars': 'off',
     'no-var': 'error',
     'object-shorthand': 'error',
     'prefer-const': 'error',
-    'prettier/prettier': 'error',
     'simple-import-sort/exports': 'error',
     'sort-imports': ['error', { ignoreDeclarationSort: true }],
     'ethereumjs/noBuffer': 'error',
+    'no-restricted-syntax': 'off',
   },
   parserOptions: {
     extraFileExtensions: ['.json'],
     sourceType: 'module',
-    project: './tsconfig.lint.json',
+    project: './config/tsconfig.lint.json',
   },
   overrides: [
     {
-      files: ['test/**/*.ts', 'tests/**/*.ts', 'examples/**/*.ts'],
+      files: ['**/test/**/*.ts', '**/bin/**.ts', ],
       rules: {
         'implicit-dependencies/no-implicit': 'off',
         'import/no-extraneous-dependencies': 'off',
+        'no-console': 'off',
+        '@typescript-eslint/no-floating-promises': 'warn',
+      },
+    },
+    {
+      files: ['**/examples/**/*', '**/benchmarks/*.ts', ],
+      rules: {
+        'implicit-dependencies/no-implicit': 'off',
+        'import/no-extraneous-dependencies': 'off',
+        'no-console': 'off',
+        '@typescript-eslint/no-unused-vars': 'off',
+      },
+    },
+    {
+      files: ['packages/statemanager/src/**', 'packages/vm/src/**', ],
+      rules: {
+        '@typescript-eslint/no-use-before-define': 'off',
+        'no-invalid-this': 'off',
+        'no-restricted-syntax': 'off',
+      },
+    },
+    {
+      files: ['packages/wallet/**'],
+      rules: {
+        'github/array-foreach': 'warn',
+        'no-prototype-builtins': 'warn',
       },
     },
   ],

config/tsconfig.lint.json

@@ -1,14 +1,12 @@
 {
   "extends": "./tsconfig.json",
   "include": [
-    "../packages/**/src/**/*.ts",
-    "../packages/**/test/**/*.ts",
-    "../packages/**/examples/**/*.ts",
-    "../packages/**/examples/**/*.cjs",
-    "../packages/**/examples/**/*.js",
-    "../packages/**/benchmarks/**/*.ts",
-    "../packages/**/bin/**/*.ts"
+    "../packages/**/*.ts",
+    "../packages/**/*.js",
+    "../packages/ethereum-tests/**/*.js",
+    "package.json"
   ],
+  "exclude": ["../packages/client/devnets", "../packages/client/archive", "**/ethereum-tests/**/*", "package.json"],
   "compilerOptions": {
     "noEmit": true
   }

eslint/index.js

@@ -6,7 +6,7 @@ const ruleFiles = fs
   .filter((file) => file !== 'index.js' && !file.endsWith('test.js'))
 
 const rules = Object.fromEntries(
-  ruleFiles.map((file) => [path.basename(file, '.js'), require('./' + file)])
+  ruleFiles.map((file) => [path.basename(file, '.js'), require('./' + file)]),
 )
 
 module.exports = { rules }

eslint/package.json

@@ -1,9 +1,6 @@
 {
   "name": "eslint-plugin-ethereumjs",
   "version": "0.1.0",
-  "files": [
-    "index.js",
-    "noBuffer.js"
-  ],
+  "files": ["index.js", "noBuffer.js"],
   "main": "index.js"
 }

lint-staged.config.js

@@ -1,3 +1,3 @@
 module.exports = {
-  '*.{js,json,md,ts}': 'prettier --ignore-unknown --write',
+  '*.{js,json,md,ts}': 'npx @biomejs/biome check --write',
 }