Enable gci linter with automatic fix. Apply lint fixes. (#236)

If we want to standardize import grouping and sorting, we should enforce it in code.
pulumi · Jan 10, 2024 · 78a682a · 78a682a
2 parents a06cc87 + 6b30505
commit 78a682a
Show file tree

Hide file tree

Showing 12 changed files with 40 additions and 14 deletions.
diff --git a/.golangci.yml b/.golangci.yml
@@ -0,0 +1,13 @@
+linters:
+  enable:
+    - gci
+
+linters-settings:
+  gci:
+    sections:
+      - standard # Standard section: captures all standard packages.
+      - blank # Blank section: contains all blank imports.
+      - default # Default section: contains all imports that could not be matched to another section type.
+      - prefix(github.com/pulumi/) # Custom section: groups all imports with the github.com/pulumi/ prefix.
+      - prefix(github.com/pulumi/upgrade-provider) # Custom section: local imports
+    custom-order: true
diff --git a/Makefile b/Makefile
@@ -13,5 +13,8 @@ install:
 lint:
 	golangci-lint run
 
+lint.fix:
+	golangci-lint run --fix
+
 test:
 	go test -v ./...
diff --git a/main.go b/main.go
@@ -10,11 +10,12 @@ import (
 	"strings"
 
 	semver "github.com/Masterminds/semver/v3"
-	"github.com/pulumi/pulumi/sdk/v3/go/common/util/contract"
 	"github.com/spf13/cobra"
 	"github.com/spf13/pflag"
 	"github.com/spf13/viper"
 
+	"github.com/pulumi/pulumi/sdk/v3/go/common/util/contract"
+
 	"github.com/pulumi/upgrade-provider/colorize"
 	"github.com/pulumi/upgrade-provider/upgrade"
 )

diff --git a/step/v2/util_test.go b/step/v2/util_test.go
@@ -7,9 +7,10 @@ import (
 	"strings"
 	"testing"
 
-	"github.com/pulumi/upgrade-provider/step/v2"
 	"github.com/stretchr/testify/assert"
 	"github.com/stretchr/testify/require"
+
+	"github.com/pulumi/upgrade-provider/step/v2"
 )
 
 func TestWithCwd(t *testing.T) {

diff --git a/upgrade/kind.go b/upgrade/kind.go
@@ -6,10 +6,11 @@ import (
 	"path/filepath"
 	"strings"
 
-	"github.com/pulumi/pulumi/sdk/v3/go/common/util/contract"
 	"golang.org/x/mod/modfile"
 	"golang.org/x/mod/module"
 
+	"github.com/pulumi/pulumi/sdk/v3/go/common/util/contract"
+
 	stepv2 "github.com/pulumi/upgrade-provider/step/v2"
 )
 

diff --git a/upgrade/kind_test.go b/upgrade/kind_test.go
@@ -2,11 +2,13 @@ package upgrade
 
 import (
 	"context"
-	"github.com/pulumi/upgrade-provider/step/v2"
+	"testing"
+
 	"github.com/stretchr/testify/assert"
 	"golang.org/x/mod/modfile"
 	"golang.org/x/mod/module"
-	"testing"
+
+	"github.com/pulumi/upgrade-provider/step/v2"
 )
 
 func TestGetUpstreamProviderOrgFromConfig(t *testing.T) {

diff --git a/upgrade/steps.go b/upgrade/steps.go
@@ -17,12 +17,13 @@ import (
 	"strings"
 
 	semver "github.com/Masterminds/semver/v3"
-	"github.com/pulumi/pulumi/sdk/v3/go/common/util/contract"
 	"golang.org/x/mod/modfile"
 	"golang.org/x/mod/module"
 	goSemver "golang.org/x/mod/semver"
 	"gopkg.in/yaml.v3"
 
+	"github.com/pulumi/pulumi/sdk/v3/go/common/util/contract"
+
 	"github.com/pulumi/upgrade-provider/colorize"
 	"github.com/pulumi/upgrade-provider/step"
 	stepv2 "github.com/pulumi/upgrade-provider/step/v2"

diff --git a/upgrade/steps_helpers.go b/upgrade/steps_helpers.go
@@ -11,10 +11,11 @@ import (
 	"strings"
 
 	"github.com/Masterminds/semver/v3"
-	"github.com/pulumi/pulumi/sdk/v3/go/common/util/contract"
 	"golang.org/x/mod/modfile"
 	"golang.org/x/mod/module"
 
+	"github.com/pulumi/pulumi/sdk/v3/go/common/util/contract"
+
 	stepv2 "github.com/pulumi/upgrade-provider/step/v2"
 )
 

diff --git a/upgrade/steps_helpers_test.go b/upgrade/steps_helpers_test.go
@@ -10,9 +10,10 @@ import (
 
 	"github.com/Masterminds/semver/v3"
 	"github.com/hexops/autogold/v2"
-	"github.com/pulumi/upgrade-provider/step/v2"
 	"github.com/stretchr/testify/assert"
 	"golang.org/x/mod/module"
+
+	"github.com/pulumi/upgrade-provider/step/v2"
 )
 
 func TestRemoveVersionPrefix(t *testing.T) {

diff --git a/upgrade/steps_test.go b/upgrade/steps_test.go
@@ -8,9 +8,10 @@ import (
 	"testing"
 
 	"github.com/Masterminds/semver/v3"
-	"github.com/pulumi/upgrade-provider/step/v2"
 	"github.com/stretchr/testify/assert"
 	"github.com/stretchr/testify/require"
+
+	"github.com/pulumi/upgrade-provider/step/v2"
 )
 
 func TestGetWorkingBranch(t *testing.T) {

diff --git a/upgrade/upgrade_test.go b/upgrade/upgrade_test.go
@@ -8,10 +8,11 @@ import (
 	"testing"
 
 	"github.com/Masterminds/semver/v3"
-	"github.com/pulumi/upgrade-provider/step/v2"
 	"github.com/stretchr/testify/assert"
 	"github.com/stretchr/testify/require"
 	"golang.org/x/mod/module"
+
+	"github.com/pulumi/upgrade-provider/step/v2"
 )
 
 func TestInformGithub(t *testing.T) {

diff --git a/upgrade/util.go b/upgrade/util.go
@@ -48,9 +48,9 @@ type Context struct {
 	//
 	UpstreamProviderName string
 	// The org component in the upstream provider's repo path.
-	// 
-	// This must be provided when upstream is hosted at a repo that does 
-	// not match the Go Module path it is declared as. Otherwise it can 
+	//
+	// This must be provided when upstream is hosted at a repo that does
+	// not match the Go Module path it is declared as. Otherwise it can
 	// be inferred.
 	//
 	// For example, if we have an upstream provider with import path:
@@ -62,7 +62,7 @@ type Context struct {
 	//	github.com/my-org/terraform-provider-my-provider
 	//
 	// Then UpstreamProviderOrg should be `my-org`.
-	UpstreamProviderOrg  string
+	UpstreamProviderOrg string
 
 	// The desired version of pulumi/{pkg,sdk} to link to.
 	//