chore: set up eslint-plugin-simple-import-sort and `eslint-plugin-i…

…mport` (#2086)
ethereumjs · Aug 3, 2022 · afead41 · afead41
1 parent 6967774
commit afead41
Show file tree

Hide file tree

Showing 394 changed files with 1,562 additions and 1,183 deletions.
diff --git a/config/eslint.js b/config/eslint.js
@@ -1,6 +1,12 @@
 module.exports = {
   parser: '@typescript-eslint/parser',
-  plugins: ['@typescript-eslint', 'implicit-dependencies', 'import', 'prettier'],
+  plugins: [
+    '@typescript-eslint',
+    'implicit-dependencies',
+    'import',
+    'prettier',
+    'simple-import-sort',
+  ],
   env: {
     es2020: true,
     node: true,
@@ -13,7 +19,12 @@ module.exports = {
     'typedoc.js',
     'karma.conf.js',
   ],
-  extends: ['typestrict', 'eslint:recommended'],
+  extends: [
+    'typestrict',
+    'eslint:recommended',
+    'plugin:import/recommended',
+    'plugin:import/typescript',
+  ],
   rules: {
     'no-console': 'warn',
     'no-debugger': 'error',
@@ -46,7 +57,31 @@ module.exports = {
     '@typescript-eslint/no-redeclare': ['error'],
     '@typescript-eslint/restrict-plus-operands': 'off',
     'import/no-default-export' : ['error'],
-    '@typescript-eslint/strict-boolean-expressions': ['error']
+    '@typescript-eslint/strict-boolean-expressions': ['error'],
+    'simple-import-sort/exports': 'error',
+    'import/default': 'error',
+    'import/export': 'error',
+    'import/exports-last': 'off', // TODO: set to `warn` for fixing and then `error`
+    'import/extensions': 'off',
+    'import/first': 'error',
+    'import/group-exports': 'off',
+    'import/named': 'error',
+    'import/namespace': 'error',
+    'import/no-absolute-path': 'error',
+    'import/no-anonymous-default-export': 'error',
+    'import/no-cycle': 'off', // TODO: set to `warn` for fixing and then `error`
+    'import/no-deprecated': 'off', // TODO: set to `warn` for fixing and then `error`
+    'import/no-duplicates': 'error',
+    'import/no-dynamic-require': 'off',
+    'import/no-extraneous-dependencies': 'error',
+    'import/no-mutable-exports': 'error',
+    'import/no-namespace': 'off',
+    'import/no-self-import': 'error',
+    'import/no-unresolved': 'off',
+    'import/no-unused-modules': 'error',
+    'import/no-useless-path-segments': 'error',
+    'import/no-webpack-loader-syntax': 'error',
+    'import/order': 'error',
   },
   parserOptions: {
     sourceType: 'module',

diff --git a/package-lock.json b/package-lock.json
diff --git a/package.json b/package.json
@@ -15,6 +15,7 @@
     "eslint-plugin-implicit-dependencies": "^1.0.4",
     "eslint-plugin-import": "^2.26.0",
     "eslint-plugin-prettier": "^3.1.3",
+    "eslint-plugin-simple-import-sort": "^7.0.0",
     "eslint-plugin-sonarjs": "^0.5.0",
     "husky": "^4.2.5",
     "nyc-report-lcov-absolute": "^1.0.0",

diff --git a/packages/block/src/block.ts b/packages/block/src/block.ts
@@ -1,18 +1,19 @@
-import { Trie } from '@ethereumjs/trie'
-import { keccak256 } from 'ethereum-cryptography/keccak'
-import { arrToBufArr, bufArrToArr, KECCAK256_RLP, bufferToHex, isTruthy } from '@ethereumjs/util'
-import { RLP } from 'rlp'
 import { Common, ConsensusType } from '@ethereumjs/common'
+import { Trie } from '@ethereumjs/trie'
 import {
-  TransactionFactory,
-  TypedTransaction,
-  TxOptions,
+  Capability,
   FeeMarketEIP1559Transaction,
   Transaction,
-  Capability,
+  TransactionFactory,
+  TxOptions,
+  TypedTransaction,
 } from '@ethereumjs/tx'
+import { arrToBufArr, bufArrToArr, bufferToHex, isTruthy, KECCAK256_RLP } from '@ethereumjs/util'
+import { keccak256 } from 'ethereum-cryptography/keccak'
+import { RLP } from 'rlp'
+
 import { BlockHeader } from './header'
-import { BlockData, BlockOptions, JsonBlock, BlockBuffer } from './types'
+import { BlockBuffer, BlockData, BlockOptions, JsonBlock } from './types'
 
 /**
  * An object that represents the block.

diff --git a/packages/block/src/from-rpc.ts b/packages/block/src/from-rpc.ts
@@ -1,9 +1,9 @@
-import { TransactionFactory, TypedTransaction, TxData } from '@ethereumjs/tx'
-import { toBuffer, setLengthLeft, isTruthy } from '@ethereumjs/util'
-import { Block, BlockOptions } from './index'
-import { numberToHex } from './helpers'
+import { TransactionFactory, TxData, TypedTransaction } from '@ethereumjs/tx'
+import { isTruthy, setLengthLeft, toBuffer } from '@ethereumjs/util'
 
 import { blockHeaderFromRpc } from './header-from-rpc'
+import { numberToHex } from './helpers'
+import { Block, BlockOptions } from './index'
 
 function normalizeTxParams(_txParams: any) {
   const txParams = Object.assign({}, _txParams)

diff --git a/packages/block/src/header-from-rpc.ts b/packages/block/src/header-from-rpc.ts
@@ -1,7 +1,8 @@
+import { isTruthy } from '@ethereumjs/util'
+
 import { BlockHeader } from './header'
-import { BlockOptions } from './types'
 import { numberToHex } from './helpers'
-import { isTruthy } from '@ethereumjs/util'
+import { BlockOptions } from './types'
 
 /**
  * Creates a new block header object from Ethereum JSON RPC.

diff --git a/packages/block/src/header.ts b/packages/block/src/header.ts
@@ -1,12 +1,11 @@
 import {
   Chain,
+  CliqueConfig,
   Common,
   ConsensusAlgorithm,
   ConsensusType,
   Hardfork,
-  CliqueConfig,
 } from '@ethereumjs/common'
-import { keccak256 } from 'ethereum-cryptography/keccak'
 import {
   Address,
   arrToBufArr,
@@ -18,17 +17,19 @@ import {
   bufferToHex,
   ecrecover,
   ecsign,
-  KECCAK256_RLP_ARRAY,
+  isFalsy,
+  isTruthy,
   KECCAK256_RLP,
+  KECCAK256_RLP_ARRAY,
   toType,
   TypeOutput,
   zeros,
-  isTruthy,
-  isFalsy,
 } from '@ethereumjs/util'
+import { keccak256 } from 'ethereum-cryptography/keccak'
 import { RLP } from 'rlp'
+
+import { CLIQUE_EXTRA_SEAL, CLIQUE_EXTRA_VANITY } from './clique'
 import { BlockHeaderBuffer, BlockOptions, HeaderData, JsonHeader } from './types'
-import { CLIQUE_EXTRA_VANITY, CLIQUE_EXTRA_SEAL } from './clique'
 
 interface HeaderCache {
   hash: Buffer | undefined

diff --git a/packages/block/src/types.ts b/packages/block/src/types.ts
@@ -1,6 +1,7 @@
-import { AddressLike, BigIntLike, BufferLike } from '@ethereumjs/util'
 import { Common } from '@ethereumjs/common'
-import { TxData, JsonTx, AccessListEIP2930TxData, FeeMarketEIP1559TxData } from '@ethereumjs/tx'
+import { AccessListEIP2930TxData, FeeMarketEIP1559TxData, JsonTx, TxData } from '@ethereumjs/tx'
+import { AddressLike, BigIntLike, BufferLike } from '@ethereumjs/util'
+
 import { BlockHeader } from './header'
 
 /**

diff --git a/packages/block/test/block.spec.ts b/packages/block/test/block.spec.ts
@@ -1,18 +1,19 @@
-import * as tape from 'tape'
+// explicitly import util, needed for karma-typescript bundling
+// eslint-disable-next-line @typescript-eslint/no-unused-vars, simple-import-sort/imports
+import util from 'util'
+
+import { Chain, Common, Hardfork } from '@ethereumjs/common'
 import { NestedUint8Array, toBuffer, zeros } from '@ethereumjs/util'
 import { RLP } from 'rlp'
-import { Chain, Common, Hardfork } from '@ethereumjs/common'
+import * as tape from 'tape'
+
 import { Block, BlockBuffer } from '../src'
 import { blockFromRpc } from '../src/from-rpc'
-import * as testnetMerge from './testdata/testnetMerge.json'
+import * as testDataGenesis from './testdata/genesishashestest.json'
 import * as testDataPreLondon from './testdata/testdata_pre-london.json'
 import * as testDataPreLondon2 from './testdata/testdata_pre-london-2.json'
-import * as testDataGenesis from './testdata/genesishashestest.json'
 import * as testDataFromRpcGoerli from './testdata/testdata-from-rpc-goerli.json'
-
-// explicitly import util, needed for karma-typescript bundling
-// eslint-disable-next-line @typescript-eslint/no-unused-vars
-import util from 'util'
+import * as testnetMerge from './testdata/testnetMerge.json'
 
 tape('[Block]: block functions', function (t) {
   t.test('should test block initialization', function (st) {

diff --git a/packages/block/test/clique.spec.ts b/packages/block/test/clique.spec.ts
@@ -1,7 +1,8 @@
-import * as tape from 'tape'
 import { Chain, Common, Hardfork } from '@ethereumjs/common'
-import { BlockHeader } from '../src/header'
 import { Address } from '@ethereumjs/util'
+import * as tape from 'tape'
+
+import { BlockHeader } from '../src/header'
 
 tape('[Header]: Clique PoA Functionality', function (t) {
   const common = new Common({ chain: Chain.Rinkeby, hardfork: Hardfork.Chainstart })

diff --git a/packages/block/test/difficulty.spec.ts b/packages/block/test/difficulty.spec.ts
@@ -1,6 +1,7 @@
-import * as tape from 'tape'
 import { Chain, Common } from '@ethereumjs/common'
 import { bufferToInt } from '@ethereumjs/util'
+import * as tape from 'tape'
+
 import { Block } from '../src'
 
 function runDifficultyTests(

diff --git a/packages/block/test/eip1559block.spec.ts b/packages/block/test/eip1559block.spec.ts
@@ -1,8 +1,9 @@
-import * as tape from 'tape'
 import { Chain, Common, Hardfork } from '@ethereumjs/common'
-import { BlockHeader } from '../src/header'
-import { Block } from '../src/block'
 import { FeeMarketEIP1559Transaction } from '@ethereumjs/tx'
+import * as tape from 'tape'
+
+import { Block } from '../src/block'
+import { BlockHeader } from '../src/header'
 
 // Test data from Besu (retrieved via Discord)
 // Older version at https://github.com/abdelhamidbakhta/besu/blob/bf54b6c0b40d3015fc85ff9b078fbc26592d80c0/ethereum/core/src/test/resources/org/hyperledger/besu/ethereum/core/fees/basefee-test.json

diff --git a/packages/block/test/from-rpc.spec.ts b/packages/block/test/from-rpc.spec.ts
@@ -1,13 +1,14 @@
-import * as tape from 'tape'
 import { Chain, Common, Hardfork } from '@ethereumjs/common'
 import { Transaction } from '@ethereumjs/tx'
+import * as tape from 'tape'
+
 import { blockFromRpc } from '../src/from-rpc'
 import { blockHeaderFromRpc } from '../src/header-from-rpc'
 import * as blockData from './testdata/testdata-from-rpc.json'
 import * as blockDataDifficultyAsInteger from './testdata/testdata-from-rpc-difficulty-as-integer.json'
+import * as testDataFromRpcGoerliLondon from './testdata/testdata-from-rpc-goerli-london.json'
 import * as blockDataWithUncles from './testdata/testdata-from-rpc-with-uncles.json'
 import * as uncleBlockData from './testdata/testdata-from-rpc-with-uncles_uncle-block-data.json'
-import * as testDataFromRpcGoerliLondon from './testdata/testdata-from-rpc-goerli-london.json'
 
 tape('[fromRPC]: block #2924874', function (t) {
   const common = new Common({ chain: Chain.Mainnet, hardfork: Hardfork.Istanbul })

diff --git a/packages/block/test/header.spec.ts b/packages/block/test/header.spec.ts
@@ -1,9 +1,10 @@
-import * as tape from 'tape'
-import { Address, toBuffer, zeros, KECCAK256_RLP, KECCAK256_RLP_ARRAY } from '@ethereumjs/util'
+import { Chain, CliqueConfig, Common, Hardfork } from '@ethereumjs/common'
+import { Address, KECCAK256_RLP, KECCAK256_RLP_ARRAY, toBuffer, zeros } from '@ethereumjs/util'
 import { RLP } from 'rlp'
-import { Chain, Common, CliqueConfig, Hardfork } from '@ethereumjs/common'
-import { BlockHeader } from '../src/header'
+import * as tape from 'tape'
+
 import { Block } from '../src'
+import { BlockHeader } from '../src/header'
 const blocksMainnet = require('./testdata/blocks_mainnet.json')
 const blocksGoerli = require('./testdata/blocks_goerli.json')
 

diff --git a/packages/block/test/mergeBlock.spec.ts b/packages/block/test/mergeBlock.spec.ts
@@ -1,8 +1,9 @@
-import * as tape from 'tape'
 import { Chain, Common, Hardfork } from '@ethereumjs/common'
-import { BlockHeader } from '../src/header'
 import { Address, KECCAK256_RLP, KECCAK256_RLP_ARRAY, zeros } from '@ethereumjs/util'
+import * as tape from 'tape'
+
 import { Block } from '../src/block'
+import { BlockHeader } from '../src/header'
 
 const common = new Common({
   chain: Chain.Mainnet,

diff --git a/packages/block/test/util.ts b/packages/block/test/util.ts
@@ -1,7 +1,8 @@
 import { Chain, Common, Hardfork } from '@ethereumjs/common'
-import { keccak256 } from 'ethereum-cryptography/keccak'
 import { bufArrToArr, isTruthy } from '@ethereumjs/util'
+import { keccak256 } from 'ethereum-cryptography/keccak'
 import { RLP } from 'rlp'
+
 import { Block, BlockHeader } from '../src'
 
 /**