experiment: add gci to golangci-linters to order/group imports (#247)

Instructions to bring existing repos to this standard:

1. Install gci: `go install github.com/daixiang0/gci@v0.11.2`
2. Run in the repo root `gci write -s standard -s default -s
"prefix(github.com/abcxyz)" -s blank -s dot --custom-order
--skip-generated .`

Author: yolocs

.golangci.yml

@@ -52,6 +52,7 @@ linters:
     - 'exhaustive'
     - 'exportloopref'
     - 'forcetypeassert'
+    - 'gci'
     - 'gocheckcompilerdirectives'
     - 'godot'
     - 'gofmt'
@@ -126,6 +127,17 @@ linters-settings:
           - pkg: 'github.com/stretchr/testify'
             desc: 'use the standard library for tests'
 
+  gci:
+    sections:
+      - 'standard'
+      - 'default'
+      - 'prefix(github.com/abcxyz)'
+      - 'blank'
+      - 'dot'
+
+    skip-generated: true
+    custom-order: true
+
   gofumpt:
     # default: false
     extra-rules: true

bqutil/query.go

@@ -21,9 +21,10 @@ import (
 	"fmt"
 
 	"cloud.google.com/go/bigquery"
-	"github.com/abcxyz/pkg/logging"
 	"github.com/sethvargo/go-retry"
 	"google.golang.org/api/iterator"
+
+	"github.com/abcxyz/pkg/logging"
 )
 
 // Query is the interface to execute a query.

bqutil/query_test.go

@@ -20,10 +20,11 @@ import (
 	"testing"
 	"time"
 
-	"github.com/abcxyz/pkg/logging"
-	"github.com/abcxyz/pkg/testutil"
 	"github.com/google/go-cmp/cmp"
 	"github.com/sethvargo/go-retry"
+
+	"github.com/abcxyz/pkg/logging"
+	"github.com/abcxyz/pkg/testutil"
 )
 
 type fakeQuery[T any] struct {

cfgloader/cfgloader_test.go

@@ -19,9 +19,10 @@ import (
 	"fmt"
 	"testing"
 
-	"github.com/abcxyz/pkg/testutil"
 	"github.com/google/go-cmp/cmp"
 	"github.com/sethvargo/go-envconfig"
+
+	"github.com/abcxyz/pkg/testutil"
 )
 
 type fakeCfg struct {

cli/command_doc_completions_test.go

@@ -19,9 +19,10 @@ import (
 	"strconv"
 	"time"
 
-	"github.com/abcxyz/pkg/cli"
 	"github.com/posener/complete/v2"
 	"github.com/posener/complete/v2/predict"
+
+	"github.com/abcxyz/pkg/cli"
 )
 
 type SingCommand struct {

cli/flags.go

@@ -27,12 +27,12 @@ import (
 	"strings"
 	"time"
 
-	"github.com/abcxyz/pkg/logging"
-	"github.com/abcxyz/pkg/timeutil"
-
 	"github.com/kr/text"
 	"github.com/posener/complete/v2"
 	"github.com/posener/complete/v2/predict"
+
+	"github.com/abcxyz/pkg/logging"
+	"github.com/abcxyz/pkg/timeutil"
 )
 
 const maxLineLength = 80

cli/flags_test.go

@@ -24,9 +24,10 @@ import (
 	"strings"
 	"testing"
 
+	"github.com/google/go-cmp/cmp"
+
 	"github.com/abcxyz/pkg/logging"
 	"github.com/abcxyz/pkg/testutil"
-	"github.com/google/go-cmp/cmp"
 )
 
 func TestNewFlagSet(t *testing.T) {

gcputil/gcputil.go

@@ -20,6 +20,7 @@ import (
 	"os"
 
 	"cloud.google.com/go/compute/metadata"
+
 	"github.com/abcxyz/pkg/logging"
 )
 

githubapp/githubapp.go

@@ -26,10 +26,11 @@ import (
 	"net/http"
 	"time"
 
-	"github.com/abcxyz/pkg/cache"
 	"github.com/lestrrat-go/jwx/v2/jwa"
 	"github.com/lestrrat-go/jwx/v2/jwt"
 	"golang.org/x/oauth2"
+
+	"github.com/abcxyz/pkg/cache"
 )
 
 // URL used to retrieve access tokens. The pattern must contain a single '%s' which represents where in the url

githubapp/githubapp_test.go

@@ -25,8 +25,9 @@ import (
 	"testing"
 	"time"
 
-	"github.com/abcxyz/pkg/testutil"
 	"github.com/google/go-cmp/cmp"
+
+	"github.com/abcxyz/pkg/testutil"
 )
 
 func TestConfig_NewConfig(t *testing.T) {