Merge pull request #884 from vbatts/fix_lint

*: switch to golangci-lint
opencontainers · Dec 2, 2021 · a9fdc37 · a9fdc37
2 parents a5463b7 + d147780
commit a9fdc37
Show file tree

Hide file tree

Showing 12 changed files with 1,336 additions and 38 deletions.
diff --git a/.github/workflows/docs-and-linting.yml b/.github/workflows/docs-and-linting.yml
@@ -9,7 +9,7 @@ jobs:
     runs-on: ubuntu-latest
     strategy:
       matrix:
-        go: ['1.15', '1.16', '1.17']
+        go: ['1.16', '1.17']
 
     name: Documentation and Linting
     steps:
@@ -30,8 +30,6 @@ jobs:
           export PATH=$GOPATH/bin:$PATH
           cd go/src/github.com/opencontainers/image-spec
           make install.tools
-          go get -u github.com/alecthomas/gometalinter
-          gometalinter --install
           go get -t -d ./...
           ls ../
           make

diff --git a/.golangci.yml b/.golangci.yml
@@ -0,0 +1,26 @@
+run:
+  timeout: 10m
+
+linters:
+  disable-all: true
+  enable:
+    - deadcode
+    - dupl
+    - gofmt
+    - goimports
+    - gosimple
+    - govet
+    - ineffassign
+    - misspell
+    - nakedret
+    - revive
+    - structcheck
+    - unused
+    - varcheck
+    - staticcheck
+
+linters-settings:
+  gofmt:
+    simplify: true
+  dupl:
+    threshold: 400
diff --git a/.tool/lint b/.tool/lint
diff --git a/Makefile b/Makefile
@@ -92,9 +92,9 @@ check-license:
 	@echo "checking license headers"
 	@./.tool/check-license
 
-lint:
+lint: .install.lint
 	@echo "checking lint"
-	@./.tool/lint
+	@GO111MODULE=on golangci-lint run
 
 test: schema/fs.go
 	go test -race -cover $(shell go list ./... | grep -v /vendor/)
@@ -114,6 +114,9 @@ endif
 
 install.tools: $(TOOLS:%=.install.%)
 
+.install.lint:
+	go get github.com/golangci/golangci-lint/cmd/golangci-lint@latest
+
 .install.esc:
 	go get -u github.com/mjibson/esc
 

diff --git a/go.mod b/go.mod
@@ -3,9 +3,16 @@ module github.com/opencontainers/image-spec
 go 1.11
 
 require (
+	github.com/davecgh/go-spew v1.1.1 // indirect
+	github.com/golangci/golangci-lint v1.43.0 // indirect
+	github.com/kr/text v0.2.0 // indirect
+	github.com/niemeyer/pretty v0.0.0-20200227124842-a10e7caefd8e // indirect
 	github.com/opencontainers/go-digest v1.0.0
 	github.com/pkg/errors v0.9.1
 	github.com/russross/blackfriday v1.6.0
+	github.com/stretchr/testify v1.7.0 // indirect
 	github.com/xeipuuv/gojsonreference v0.0.0-20180127040603-bd5ef7bd5415
 	github.com/xeipuuv/gojsonschema v1.2.0
+	gopkg.in/check.v1 v1.0.0-20200227125254-8fa46927fb4f // indirect
+	gopkg.in/yaml.v3 v3.0.0-20210107192922-496545a6307b // indirect
 )
diff --git a/go.sum b/go.sum
diff --git a/schema/backwards_compatibility_test.go b/schema/backwards_compatibility_test.go
@@ -21,7 +21,7 @@ import (
 
 	"github.com/opencontainers/go-digest"
 	"github.com/opencontainers/image-spec/schema"
-	"github.com/opencontainers/image-spec/specs-go/v1"
+	v1 "github.com/opencontainers/image-spec/specs-go/v1"
 )
 
 var compatMap = map[string]string{

diff --git a/schema/loader.go b/schema/loader.go
@@ -78,7 +78,7 @@ type fsLoader struct {
 }
 
 // JsonSource implements gojsonschema.JSONLoader.JsonSource. The "Json" capitalization needs to be maintained to conform to the interface.
-func (l *fsLoader) JsonSource() interface{} { // nolint: golint
+func (l *fsLoader) JsonSource() interface{} { // revive:disable-line:var-naming
 	return l.source
 }
 
@@ -117,7 +117,7 @@ func decodeJSONUsingNumber(r io.Reader) (interface{}, error) {
 }
 
 // JsonReference implements gojsonschema.JSONLoader.JsonReference. The "Json" capitalization needs to be maintained to conform to the interface.
-func (l *fsLoader) JsonReference() (gojsonreference.JsonReference, error) { // nolint: golint
+func (l *fsLoader) JsonReference() (gojsonreference.JsonReference, error) { // revive:disable-line:var-naming
 	return gojsonreference.NewJsonReference(l.JsonSource().(string))
 }
 

diff --git a/schema/schema.go b/schema/schema.go
@@ -17,7 +17,7 @@ package schema
 import (
 	"net/http"
 
-	"github.com/opencontainers/image-spec/specs-go/v1"
+	v1 "github.com/opencontainers/image-spec/specs-go/v1"
 )
 
 // Media types for the OCI image formats

diff --git a/schema/spec_test.go b/schema/spec_test.go
@@ -95,7 +95,6 @@ func validate(t *testing.T, name string) {
 		}
 
 		for _, err := range errs {
-			// TOOD(stevvooe): This is nearly useless without file, line no.
 			printFields(t, "invalid", example.Mediatype, example.Title)
 			t.Error(err)
 			fmt.Println(example.Body, "---")

diff --git a/specs-go/v1/index.go b/specs-go/v1/index.go
@@ -21,7 +21,7 @@ import "github.com/opencontainers/image-spec/specs-go"
 type Index struct {
 	specs.Versioned
 
-	// MediaType specificies the type of this document data structure e.g. `application/vnd.oci.image.index.v1+json`
+	// MediaType specifies the type of this document data structure e.g. `application/vnd.oci.image.index.v1+json`
 	MediaType string `json:"mediaType,omitempty"`
 
 	// Manifests references platform specific manifests.

diff --git a/specs-go/v1/manifest.go b/specs-go/v1/manifest.go
@@ -20,7 +20,7 @@ import "github.com/opencontainers/image-spec/specs-go"
 type Manifest struct {
 	specs.Versioned
 
-	// MediaType specificies the type of this document data structure e.g. `application/vnd.oci.image.manifest.v1+json`
+	// MediaType specifies the type of this document data structure e.g. `application/vnd.oci.image.manifest.v1+json`
 	MediaType string `json:"mediaType,omitempty"`
 
 	// Config references a configuration object for a container, by digest.