[chore] adopt GCI to manage imports (open-telemetry#17585)

* [chore] adopt GCI to manage imports * fix top comment being removed * remove impi make target, remove gogci and gci make targets, and add gci to linters of golangci-lint * remove impi * adopt golangci-lint
draios · Jan 19, 2023 · 4eff714 · 4eff714
1 parent ba8a0ad
commit 4eff714
Show file tree

Hide file tree

Showing 23 changed files with 28 additions and 23 deletions.
diff --git a/.github/workflows/build-and-test.yml b/.github/workflows/build-and-test.yml
@@ -176,8 +176,6 @@ jobs:
  run: |
  make -j2 generate
  git diff --exit-code ':!*go.sum' || (echo 'Generated code is out of date, please run "make generate" and commit the changes in this PR.' && exit 1)
- - name: Impi
- run: make -j2 goimpi
  - name: MultimodVerify
  run: make multimod-verify
  - name: Components dropdown in issue templates

diff --git a/.golangci.yml b/.golangci.yml
@@ -53,6 +53,12 @@ output:
 
 # all available settings of specific linters
 linters-settings:
+ gci:
+ sections:
+ - standard
+ - default
+ - prefix(github.com/open-telemetry/opentelemetry-collector-contrib)
+
  govet:
  # report about shadowed variables
  check-shadowing: true
@@ -122,6 +128,7 @@ linters:
  - errcheck
  - errorlint
  - exportloopref
+ - gci
  - gocritic
  - gofmt
  - goimports

diff --git a/Makefile b/Makefile
@@ -104,10 +104,6 @@ gofmt:
 golint:
  $(MAKE) $(FOR_GROUP_TARGET) TARGET="lint"
 
-.PHONY: goimpi
-goimpi: $(IMPI)
- @$(MAKE) $(FOR_GROUP_TARGET) TARGET="impi"
-
 .PHONY: goporto
 goporto: $(PORTO)
  $(PORTO) -w --include-internal --skip-dirs "^cmd$$" ./

diff --git a/Makefile.Common b/Makefile.Common
@@ -48,7 +48,6 @@ MDLINKCHECK := $(TOOLS_BIN_DIR)/markdown-link-check
 MISSPELL := $(TOOLS_BIN_DIR)/misspell -error
 MISSPELL_CORRECTION := $(TOOLS_BIN_DIR)/misspell -w
 LINT := $(TOOLS_BIN_DIR)/golangci-lint
-IMPI := $(TOOLS_BIN_DIR)/impi
 MULITMOD := $(TOOLS_BIN_DIR)/multimod
 CHLOGGEN := $(TOOLS_BIN_DIR)/chloggen
 GOIMPORTS := $(TOOLS_BIN_DIR)/goimports
@@ -91,7 +90,7 @@ all-pkg-dirs:
 .DEFAULT_GOAL := common
 
 .PHONY: common
-common: checklicense impi lint misspell
+common: checklicense lint misspell
 
 .PHONY: test
 test:
@@ -179,10 +178,6 @@ misspell: $(TOOLS_BIN_DIR)/misspell
 misspell-correction: $(TOOLS_BIN_DIR)/misspell
  $(MISSPELL_CORRECTION) $(ALL_SRC_AND_DOC)
 
-.PHONY: impi
-impi: $(IMPI)
- @$(IMPI) --local github.com/open-telemetry/opentelemetry-collector-contrib --scheme stdThirdPartyLocal ./...
-
 .PHONY: moddownload
 moddownload:
  $(GOCMD) mod download

diff --git a/exporter/azuremonitorexporter/time_utils.go b/exporter/azuremonitorexporter/time_utils.go
@@ -15,6 +15,7 @@
 package azuremonitorexporter // import "github.com/open-telemetry/opentelemetry-collector-contrib/exporter/azuremonitorexporter"
 
 // Contains code common to both trace and metrics exporters
+
 import (
  "fmt"
  "time"

diff --git a/exporter/azuremonitorexporter/trace_to_envelope.go b/exporter/azuremonitorexporter/trace_to_envelope.go
@@ -15,6 +15,7 @@
 package azuremonitorexporter // import "github.com/open-telemetry/opentelemetry-collector-contrib/exporter/azuremonitorexporter"
 
 // Contains code common to both trace and metrics exporters
+
 import (
  "errors"
  "net/url"

diff --git a/extension/storage/dbstorage/config_test.go b/extension/storage/dbstorage/config_test.go
@@ -17,6 +17,7 @@
 // +build !windows
 
 package dbstorage // import "github.com/open-telemetry/opentelemetry-collector-contrib/extension/storage/dbstorage"
+
 import (
  "errors"
  "testing"

diff --git a/internal/coreinternal/attraction/hasher.go b/internal/coreinternal/attraction/hasher.go
@@ -15,8 +15,7 @@
 package attraction // import "github.com/open-telemetry/opentelemetry-collector-contrib/internal/coreinternal/attraction"
 
 import (
- // #nosec
- "crypto/sha1"
+ "crypto/sha1" // #nosec
  "encoding/binary"
  "encoding/hex"
  "math"

diff --git a/internal/tools/go.mod b/internal/tools/go.mod
@@ -4,11 +4,11 @@ go 1.18
 
 require (
  github.com/client9/misspell v0.3.4
+ github.com/daixiang0/gci v0.9.0
  github.com/golangci/golangci-lint v1.50.1
  github.com/google/addlicense v1.1.0
  github.com/jcchavezs/porto v0.4.0
  github.com/jstemmer/go-junit-report v1.0.0
- github.com/pavius/impi v0.0.3
  github.com/tcnksm/ghr v0.16.0
  go.opentelemetry.io/build-tools/checkdoc v0.4.0
  go.opentelemetry.io/build-tools/chloggen v0.3.0
@@ -49,7 +49,6 @@ require (
  github.com/chavacava/garif v0.0.0-20220630083739-93517212f375 // indirect
  github.com/cloudflare/circl v1.1.0 // indirect
  github.com/curioswitch/go-reassign v0.2.0 // indirect
- github.com/daixiang0/gci v0.8.1 // indirect
  github.com/davecgh/go-spew v1.1.1 // indirect
  github.com/denis-tingaikin/go-header v0.4.3 // indirect
  github.com/emirpasic/gods v1.18.1 // indirect

diff --git a/internal/tools/go.sum b/internal/tools/go.sum
diff --git a/internal/tools/tools.go b/internal/tools/tools.go
@@ -24,11 +24,11 @@ package tools // import "github.com/open-telemetry/opentelemetry-collector-contr
 
 import (
  _ "github.com/client9/misspell/cmd/misspell"
+ _ "github.com/daixiang0/gci"
  _ "github.com/golangci/golangci-lint/cmd/golangci-lint"
  _ "github.com/google/addlicense"
  _ "github.com/jcchavezs/porto/cmd/porto"
  _ "github.com/jstemmer/go-junit-report"
- _ "github.com/pavius/impi/cmd/impi"
  _ "github.com/tcnksm/ghr"
  _ "go.opentelemetry.io/build-tools/checkdoc"
  _ "go.opentelemetry.io/build-tools/chloggen"

diff --git a/pkg/ottl/grammar.go b/pkg/ottl/grammar.go
@@ -13,6 +13,7 @@
 // limitations under the License.
 
 package ottl // import "github.com/open-telemetry/opentelemetry-collector-contrib/pkg/ottl"
+
 import (
  "encoding/hex"
  "fmt"

diff --git a/pkg/stanza/adapter/register.go b/pkg/stanza/adapter/register.go
@@ -15,8 +15,7 @@
 package adapter // import "github.com/open-telemetry/opentelemetry-collector-contrib/pkg/stanza/adapter"
 
 import (
- // Register parsers and transformers for stanza-based log receivers
- _ "github.com/open-telemetry/opentelemetry-collector-contrib/pkg/stanza/operator/output/file"
+ _ "github.com/open-telemetry/opentelemetry-collector-contrib/pkg/stanza/operator/output/file" // Register parsers and transformers for stanza-based log receivers
  _ "github.com/open-telemetry/opentelemetry-collector-contrib/pkg/stanza/operator/output/stdout"
  _ "github.com/open-telemetry/opentelemetry-collector-contrib/pkg/stanza/operator/parser/csv"
  _ "github.com/open-telemetry/opentelemetry-collector-contrib/pkg/stanza/operator/parser/json"

diff --git a/processor/transformprocessor/internal/common/config.go b/processor/transformprocessor/internal/common/config.go
@@ -13,6 +13,7 @@
 // limitations under the License.
 
 package common // import "github.com/open-telemetry/opentelemetry-collector-contrib/processor/transformprocessor/internal/common"
+
 import (
  "fmt"
  "strings"

diff --git a/receiver/awsfirehosereceiver/internal/unmarshaler/cwmetricstream/metricsbuilder.go b/receiver/awsfirehosereceiver/internal/unmarshaler/cwmetricstream/metricsbuilder.go
@@ -13,6 +13,7 @@
 // limitations under the License.
 
 package cwmetricstream // import "github.com/open-telemetry/opentelemetry-collector-contrib/receiver/awsfirehosereceiver/internal/unmarshaler/cwmetricstream"
+
 import (
  "fmt"
  "strings"

diff --git a/receiver/azureeventhubreceiver/config.go b/receiver/azureeventhubreceiver/config.go
@@ -13,6 +13,7 @@
 // limitations under the License.
 
 package azureeventhubreceiver // import "github.com/open-telemetry/opentelemetry-collector-contrib/receiver/azureeventhubreceiver"
+
 import (
  "errors"
  "fmt"

diff --git a/receiver/azureeventhubreceiver/persister.go b/receiver/azureeventhubreceiver/persister.go
@@ -13,6 +13,7 @@
 // limitations under the License.
 
 package azureeventhubreceiver // import "github.com/open-telemetry/opentelemetry-collector-contrib/receiver/azureeventhubreceiver"
+
 import (
  "context"
  "fmt"

diff --git a/receiver/azureeventhubreceiver/persister_test.go b/receiver/azureeventhubreceiver/persister_test.go
@@ -13,6 +13,7 @@
 // limitations under the License.
 
 package azureeventhubreceiver // import "github.com/open-telemetry/opentelemetry-collector-contrib/receiver/azureeventhubreceiver"
+
 import (
  "context"
  "errors"

diff --git a/receiver/nsxtreceiver/client.go b/receiver/nsxtreceiver/client.go
@@ -13,6 +13,7 @@
 // limitations under the License.
 
 package nsxtreceiver // import "github.com/open-telemetry/opentelemetry-collector-contrib/receiver/nsxtreceiver"
+
 import (
  "context"
  "encoding/json"

diff --git a/receiver/nsxtreceiver/client_mock_test.go b/receiver/nsxtreceiver/client_mock_test.go
@@ -13,6 +13,7 @@
 // limitations under the License.
 
 package nsxtreceiver // import "github.com/open-telemetry/opentelemetry-collector-contrib/receiver/nsxtreceiver"
+
 import (
  context "context"
  testing "testing"

diff --git a/receiver/nsxtreceiver/client_test.go b/receiver/nsxtreceiver/client_test.go
@@ -13,6 +13,7 @@
 // limitations under the License.
 
 package nsxtreceiver // import "github.com/open-telemetry/opentelemetry-collector-contrib/receiver/nsxtreceiver"
+
 import (
  "context"
  "fmt"

diff --git a/receiver/nsxtreceiver/config.go b/receiver/nsxtreceiver/config.go
@@ -13,6 +13,7 @@
 // limitations under the License.
 
 package nsxtreceiver // import "github.com/open-telemetry/opentelemetry-collector-contrib/receiver/nsxtreceiver"
+
 import (
  "errors"
  "fmt"

diff --git a/receiver/purefareceiver/factory.go b/receiver/purefareceiver/factory.go
@@ -15,6 +15,7 @@
 package purefareceiver // import "github.com/open-telemetry/opentelemetry-collector-contrib/receiver/purefareceiver"
 
 // This file implements Factory for Array scraper.
+
 import (
  "context"
  "fmt"