Add goimports lint (ethereum#54)

* Add `goimports` lint. * Fix `goimports` issue. * Fix group to `github.com/scroll-tech/go-thereum`.
weiihann · Mar 24, 2022 · b6cc89f · b6cc89f
1 parent f853248
commit b6cc89f
Show file tree

Hide file tree

Showing 196 changed files with 329 additions and 115 deletions.
diff --git a/.github/workflows/l2geth_ci.yml b/.github/workflows/l2geth_ci.yml
@@ -12,11 +12,32 @@ jobs:
       uses: actions/checkout@v2
     - name: Lint
       run: |
-        rm -rf $HOME/.cache/golangci-lint 
+        rm -rf $HOME/.cache/golangci-lint
         make lint
     - name: Test
       run: |
         go get ./...
         make test
     - name: Upload coverage report
       run: bash <(curl -s https://codecov.io/bash)
+  goimports-lint:
+    runs-on: ubuntu-latest
+    steps:
+    - name: Install Go
+      uses: actions/setup-go@v2
+      with:
+        go-version: 1.17.x
+    - name: Install goimports
+      run: go get golang.org/x/tools/cmd/goimports
+    - name: Checkout code
+      uses: actions/checkout@v2
+      with:
+        ref: ${{ github.event.pull_request.head.ref }}
+    - run: goimports -local github.com/scroll-tech/go-ethereum/ -w .
+    - run: go mod tidy
+    # If there are any diffs from goimports or go mod tidy, fail.
+    - name: Verify no changes from goimports and go mod tidy
+      run: |
+        if [ -n "$(git status --porcelain)" ]; then
+          exit 1
+        fi
diff --git a/accounts/abi/bind/base_test.go b/accounts/abi/bind/base_test.go
@@ -23,6 +23,8 @@ import (
 	"strings"
 	"testing"
 
+	"github.com/stretchr/testify/assert"
+
 	"github.com/scroll-tech/go-ethereum"
 	"github.com/scroll-tech/go-ethereum/accounts/abi"
 	"github.com/scroll-tech/go-ethereum/accounts/abi/bind"
@@ -31,7 +33,6 @@ import (
 	"github.com/scroll-tech/go-ethereum/core/types"
 	"github.com/scroll-tech/go-ethereum/crypto"
 	"github.com/scroll-tech/go-ethereum/rlp"
-	"github.com/stretchr/testify/assert"
 )
 
 func mockSign(addr common.Address, tx *types.Transaction) (*types.Transaction, error) { return tx, nil }

diff --git a/accounts/abi/event_test.go b/accounts/abi/event_test.go
@@ -25,10 +25,11 @@ import (
 	"strings"
 	"testing"
 
-	"github.com/scroll-tech/go-ethereum/common"
-	"github.com/scroll-tech/go-ethereum/crypto"
 	"github.com/stretchr/testify/assert"
 	"github.com/stretchr/testify/require"
+
+	"github.com/scroll-tech/go-ethereum/common"
+	"github.com/scroll-tech/go-ethereum/crypto"
 )
 
 var jsonEventTransfer = []byte(`{

diff --git a/accounts/abi/type_test.go b/accounts/abi/type_test.go
@@ -22,6 +22,7 @@ import (
 	"testing"
 
 	"github.com/davecgh/go-spew/spew"
+
 	"github.com/scroll-tech/go-ethereum/common"
 )
 

diff --git a/accounts/abi/unpack_test.go b/accounts/abi/unpack_test.go
@@ -26,8 +26,9 @@ import (
 	"strings"
 	"testing"
 
-	"github.com/scroll-tech/go-ethereum/common"
 	"github.com/stretchr/testify/require"
+
+	"github.com/scroll-tech/go-ethereum/common"
 )
 
 // TestUnpack tests the general pack/unpack tests in packing_test.go

diff --git a/accounts/accounts.go b/accounts/accounts.go
@@ -21,11 +21,12 @@ import (
 	"fmt"
 	"math/big"
 
+	"golang.org/x/crypto/sha3"
+
 	"github.com/scroll-tech/go-ethereum"
 	"github.com/scroll-tech/go-ethereum/common"
 	"github.com/scroll-tech/go-ethereum/core/types"
 	"github.com/scroll-tech/go-ethereum/event"
-	"golang.org/x/crypto/sha3"
 )
 
 // Account represents an Ethereum account located at a specific location defined

diff --git a/accounts/keystore/account_cache.go b/accounts/keystore/account_cache.go
@@ -28,6 +28,7 @@ import (
 	"time"
 
 	mapset "github.com/deckarep/golang-set"
+
 	"github.com/scroll-tech/go-ethereum/accounts"
 	"github.com/scroll-tech/go-ethereum/common"
 	"github.com/scroll-tech/go-ethereum/log"

diff --git a/accounts/keystore/account_cache_test.go b/accounts/keystore/account_cache_test.go
@@ -29,6 +29,7 @@ import (
 
 	"github.com/cespare/cp"
 	"github.com/davecgh/go-spew/spew"
+
 	"github.com/scroll-tech/go-ethereum/accounts"
 	"github.com/scroll-tech/go-ethereum/common"
 )

diff --git a/accounts/keystore/file_cache.go b/accounts/keystore/file_cache.go
@@ -25,6 +25,7 @@ import (
 	"time"
 
 	mapset "github.com/deckarep/golang-set"
+
 	"github.com/scroll-tech/go-ethereum/log"
 )
 

diff --git a/accounts/keystore/key.go b/accounts/keystore/key.go
@@ -30,6 +30,7 @@ import (
 	"time"
 
 	"github.com/google/uuid"
+
 	"github.com/scroll-tech/go-ethereum/accounts"
 	"github.com/scroll-tech/go-ethereum/common"
 	"github.com/scroll-tech/go-ethereum/crypto"

diff --git a/accounts/keystore/passphrase.go b/accounts/keystore/passphrase.go
@@ -39,12 +39,13 @@ import (
 	"path/filepath"
 
 	"github.com/google/uuid"
+	"golang.org/x/crypto/pbkdf2"
+	"golang.org/x/crypto/scrypt"
+
 	"github.com/scroll-tech/go-ethereum/accounts"
 	"github.com/scroll-tech/go-ethereum/common"
 	"github.com/scroll-tech/go-ethereum/common/math"
 	"github.com/scroll-tech/go-ethereum/crypto"
-	"golang.org/x/crypto/pbkdf2"
-	"golang.org/x/crypto/scrypt"
 )
 
 const (

diff --git a/accounts/keystore/presale.go b/accounts/keystore/presale.go
@@ -26,9 +26,10 @@ import (
 	"fmt"
 
 	"github.com/google/uuid"
+	"golang.org/x/crypto/pbkdf2"
+
 	"github.com/scroll-tech/go-ethereum/accounts"
 	"github.com/scroll-tech/go-ethereum/crypto"
-	"golang.org/x/crypto/pbkdf2"
 )
 
 // creates a Key and stores that in the given KeyStore by decrypting a presale key JSON

diff --git a/accounts/keystore/watch.go b/accounts/keystore/watch.go
@@ -23,6 +23,7 @@ import (
 	"time"
 
 	"github.com/rjeczalik/notify"
+
 	"github.com/scroll-tech/go-ethereum/log"
 )
 

diff --git a/accounts/scwallet/hub.go b/accounts/scwallet/hub.go
@@ -42,6 +42,7 @@ import (
 	"time"
 
 	pcsc "github.com/gballet/go-libpcsclite"
+
 	"github.com/scroll-tech/go-ethereum/accounts"
 	"github.com/scroll-tech/go-ethereum/common"
 	"github.com/scroll-tech/go-ethereum/event"

diff --git a/accounts/scwallet/securechannel.go b/accounts/scwallet/securechannel.go
@@ -27,9 +27,10 @@ import (
 	"fmt"
 
 	pcsc "github.com/gballet/go-libpcsclite"
-	"github.com/scroll-tech/go-ethereum/crypto"
 	"golang.org/x/crypto/pbkdf2"
 	"golang.org/x/text/unicode/norm"
+
+	"github.com/scroll-tech/go-ethereum/crypto"
 )
 
 const (

diff --git a/accounts/scwallet/wallet.go b/accounts/scwallet/wallet.go
@@ -34,13 +34,14 @@ import (
 	"time"
 
 	pcsc "github.com/gballet/go-libpcsclite"
+	"github.com/status-im/keycard-go/derivationpath"
+
 	"github.com/scroll-tech/go-ethereum"
 	"github.com/scroll-tech/go-ethereum/accounts"
 	"github.com/scroll-tech/go-ethereum/common"
 	"github.com/scroll-tech/go-ethereum/core/types"
 	"github.com/scroll-tech/go-ethereum/crypto"
 	"github.com/scroll-tech/go-ethereum/log"
-	"github.com/status-im/keycard-go/derivationpath"
 )
 
 // ErrPairingPasswordNeeded is returned if opening the smart card requires pairing with a pairing

diff --git a/accounts/usbwallet/hub.go b/accounts/usbwallet/hub.go
@@ -24,6 +24,7 @@ import (
 	"time"
 
 	"github.com/karalabe/usb"
+
 	"github.com/scroll-tech/go-ethereum/accounts"
 	"github.com/scroll-tech/go-ethereum/event"
 	"github.com/scroll-tech/go-ethereum/log"

diff --git a/accounts/usbwallet/trezor.go b/accounts/usbwallet/trezor.go
@@ -28,6 +28,7 @@ import (
 	"math/big"
 
 	"github.com/golang/protobuf/proto"
+
 	"github.com/scroll-tech/go-ethereum/accounts"
 	"github.com/scroll-tech/go-ethereum/accounts/usbwallet/trezor"
 	"github.com/scroll-tech/go-ethereum/common"

diff --git a/accounts/usbwallet/wallet.go b/accounts/usbwallet/wallet.go
@@ -26,6 +26,7 @@ import (
 	"time"
 
 	"github.com/karalabe/usb"
+
 	"github.com/scroll-tech/go-ethereum"
 	"github.com/scroll-tech/go-ethereum/accounts"
 	"github.com/scroll-tech/go-ethereum/common"

diff --git a/build/ci.go b/build/ci.go
@@ -59,6 +59,7 @@ import (
 	"time"
 
 	"github.com/cespare/cp"
+
 	"github.com/scroll-tech/go-ethereum/crypto/signify"
 	"github.com/scroll-tech/go-ethereum/internal/build"
 	"github.com/scroll-tech/go-ethereum/params"

diff --git a/cmd/abigen/main.go b/cmd/abigen/main.go
@@ -25,14 +25,15 @@ import (
 	"regexp"
 	"strings"
 
+	"gopkg.in/urfave/cli.v1"
+
 	"github.com/scroll-tech/go-ethereum/accounts/abi"
 	"github.com/scroll-tech/go-ethereum/accounts/abi/bind"
 	"github.com/scroll-tech/go-ethereum/cmd/utils"
 	"github.com/scroll-tech/go-ethereum/common/compiler"
 	"github.com/scroll-tech/go-ethereum/crypto"
 	"github.com/scroll-tech/go-ethereum/internal/flags"
 	"github.com/scroll-tech/go-ethereum/log"
-	"gopkg.in/urfave/cli.v1"
 )
 
 var (

diff --git a/cmd/checkpoint-admin/common.go b/cmd/checkpoint-admin/common.go
@@ -19,6 +19,8 @@ package main
 import (
 	"strconv"
 
+	"gopkg.in/urfave/cli.v1"
+
 	"github.com/scroll-tech/go-ethereum/accounts"
 	"github.com/scroll-tech/go-ethereum/accounts/abi/bind"
 	"github.com/scroll-tech/go-ethereum/accounts/external"
@@ -28,7 +30,6 @@ import (
 	"github.com/scroll-tech/go-ethereum/ethclient"
 	"github.com/scroll-tech/go-ethereum/params"
 	"github.com/scroll-tech/go-ethereum/rpc"
-	"gopkg.in/urfave/cli.v1"
 )
 
 // newClient creates a client with specified remote URL.

diff --git a/cmd/checkpoint-admin/exec.go b/cmd/checkpoint-admin/exec.go
@@ -25,6 +25,8 @@ import (
 	"strings"
 	"time"
 
+	"gopkg.in/urfave/cli.v1"
+
 	"github.com/scroll-tech/go-ethereum/accounts"
 	"github.com/scroll-tech/go-ethereum/cmd/utils"
 	"github.com/scroll-tech/go-ethereum/common"
@@ -36,7 +38,6 @@ import (
 	"github.com/scroll-tech/go-ethereum/log"
 	"github.com/scroll-tech/go-ethereum/params"
 	"github.com/scroll-tech/go-ethereum/rpc"
-	"gopkg.in/urfave/cli.v1"
 )
 
 var commandDeploy = cli.Command{

diff --git a/cmd/checkpoint-admin/main.go b/cmd/checkpoint-admin/main.go
@@ -22,10 +22,11 @@ import (
 	"fmt"
 	"os"
 
+	"gopkg.in/urfave/cli.v1"
+
 	"github.com/scroll-tech/go-ethereum/common/fdlimit"
 	"github.com/scroll-tech/go-ethereum/internal/flags"
 	"github.com/scroll-tech/go-ethereum/log"
-	"gopkg.in/urfave/cli.v1"
 )
 
 var (

diff --git a/cmd/checkpoint-admin/status.go b/cmd/checkpoint-admin/status.go
@@ -19,9 +19,10 @@ package main
 import (
 	"fmt"
 
+	"gopkg.in/urfave/cli.v1"
+
 	"github.com/scroll-tech/go-ethereum/cmd/utils"
 	"github.com/scroll-tech/go-ethereum/common"
-	"gopkg.in/urfave/cli.v1"
 )
 
 var commandStatus = cli.Command{

diff --git a/cmd/clef/main.go b/cmd/clef/main.go
@@ -37,6 +37,8 @@ import (
 
 	"github.com/mattn/go-colorable"
 	"github.com/mattn/go-isatty"
+	"gopkg.in/urfave/cli.v1"
+
 	"github.com/scroll-tech/go-ethereum/accounts"
 	"github.com/scroll-tech/go-ethereum/accounts/keystore"
 	"github.com/scroll-tech/go-ethereum/cmd/utils"
@@ -56,7 +58,6 @@ import (
 	"github.com/scroll-tech/go-ethereum/signer/fourbyte"
 	"github.com/scroll-tech/go-ethereum/signer/rules"
 	"github.com/scroll-tech/go-ethereum/signer/storage"
-	"gopkg.in/urfave/cli.v1"
 )
 
 const legalWarning = `

diff --git a/cmd/devp2p/discv4cmd.go b/cmd/devp2p/discv4cmd.go
@@ -22,13 +22,14 @@ import (
 	"strings"
 	"time"
 
+	"gopkg.in/urfave/cli.v1"
+
 	"github.com/scroll-tech/go-ethereum/cmd/devp2p/internal/v4test"
 	"github.com/scroll-tech/go-ethereum/common"
 	"github.com/scroll-tech/go-ethereum/crypto"
 	"github.com/scroll-tech/go-ethereum/p2p/discover"
 	"github.com/scroll-tech/go-ethereum/p2p/enode"
 	"github.com/scroll-tech/go-ethereum/params"
-	"gopkg.in/urfave/cli.v1"
 )
 
 var (

diff --git a/cmd/devp2p/discv5cmd.go b/cmd/devp2p/discv5cmd.go
@@ -20,10 +20,11 @@ import (
 	"fmt"
 	"time"
 
+	"gopkg.in/urfave/cli.v1"
+
 	"github.com/scroll-tech/go-ethereum/cmd/devp2p/internal/v5test"
 	"github.com/scroll-tech/go-ethereum/common"
 	"github.com/scroll-tech/go-ethereum/p2p/discover"
-	"gopkg.in/urfave/cli.v1"
 )
 
 var (

diff --git a/cmd/devp2p/dns_cloudflare.go b/cmd/devp2p/dns_cloudflare.go
@@ -22,9 +22,10 @@ import (
 	"strings"
 
 	"github.com/cloudflare/cloudflare-go"
+	"gopkg.in/urfave/cli.v1"
+
 	"github.com/scroll-tech/go-ethereum/log"
 	"github.com/scroll-tech/go-ethereum/p2p/dnsdisc"
-	"gopkg.in/urfave/cli.v1"
 )
 
 var (

diff --git a/cmd/devp2p/dns_route53.go b/cmd/devp2p/dns_route53.go
@@ -30,9 +30,10 @@ import (
 	"github.com/aws/aws-sdk-go-v2/credentials"
 	"github.com/aws/aws-sdk-go-v2/service/route53"
 	"github.com/aws/aws-sdk-go-v2/service/route53/types"
+	"gopkg.in/urfave/cli.v1"
+
 	"github.com/scroll-tech/go-ethereum/log"
 	"github.com/scroll-tech/go-ethereum/p2p/dnsdisc"
-	"gopkg.in/urfave/cli.v1"
 )
 
 const (

diff --git a/cmd/devp2p/dnscmd.go b/cmd/devp2p/dnscmd.go
@@ -25,12 +25,13 @@ import (
 	"path/filepath"
 	"time"
 
+	"gopkg.in/urfave/cli.v1"
+
 	"github.com/scroll-tech/go-ethereum/accounts/keystore"
 	"github.com/scroll-tech/go-ethereum/common"
 	"github.com/scroll-tech/go-ethereum/console/prompt"
 	"github.com/scroll-tech/go-ethereum/p2p/dnsdisc"
 	"github.com/scroll-tech/go-ethereum/p2p/enode"
-	"gopkg.in/urfave/cli.v1"
 )
 
 var (