style: add .golangci-lint.yaml

christophwitzko · christophwitzko · commit 25a96d4dc129 · 2023-01-13T12:13:02.000+01:00
diff --git a/.golangci.yaml b/.golangci.yaml
@@ -0,0 +1,29 @@
+linters:
+  enable:
+    - errorlint
+    - forbidigo
+    - gochecknoinits
+    - gocritic
+    - goconst
+    - gocyclo
+    - gofumpt
+    - goimports
+    - misspell
+    - revive
+    - unconvert
+    - unparam
+    - wastedassign
+
+linters-settings:
+  gocyclo:
+    min-complexity: 12
+  gofumpt:
+    extra-rules: true
+  govet:
+    enable-all: true
+    disable:
+      - fieldalignment
+
+run:
+  skip-dirs:
+    - goreleaser
diff --git a/pkg/config/config.go b/pkg/config/config.go
@@ -1,6 +1,7 @@
 package config
 
 import (
+	"errors"
 	"os"
 	"strings"
 
@@ -142,18 +143,20 @@ func must(err error) {
 	}
 }
 
+var trueString = "true"
+
 func detectCI() string {
-	if os.Getenv("GITHUB_ACTIONS") == "true" {
+	if os.Getenv("GITHUB_ACTIONS") == trueString {
 		return "github"
 	}
-	if os.Getenv("GITLAB_CI") == "true" {
+	if os.Getenv("GITLAB_CI") == trueString {
 		return "gitlab"
 	}
 	return "default"
 }
 
 func defaultProvider() string {
-	if os.Getenv("GITLAB_CI") == "true" {
+	if os.Getenv("GITLAB_CI") == trueString {
 		return "gitlab"
 	}
 	return "github"
@@ -218,7 +221,8 @@ func InitConfig(cmd *cobra.Command) error {
 	viper.SetConfigType("json")
 
 	if err := viper.ReadInConfig(); err != nil {
-		if _, ok := err.(viper.ConfigFileNotFoundError); !ok {
+		var viperConfigNotFound viper.ConfigFileNotFoundError
+		if !errors.As(err, &viperConfigNotFound) {
 			return err
 		}
 	}
diff --git a/pkg/plugin/discovery/discovery.go b/pkg/plugin/discovery/discovery.go
@@ -69,7 +69,9 @@ func (d *Discovery) FindPlugin(t, name string) (*plugin.PluginInfo, error) {
 	if err != nil {
 		return nil, err
 	}
-	if err := setAndEnsurePluginPath(pInfo); err != nil {
+
+	err = setAndEnsurePluginPath(pInfo)
+	if err != nil {
 		return nil, err
 	}
 
diff --git a/pkg/plugin/discovery/download.go b/pkg/plugin/discovery/download.go
@@ -5,6 +5,7 @@ import (
 	"compress/gzip"
 	"crypto/sha256"
 	"encoding/hex"
+	"errors"
 	"fmt"
 	"io"
 	"os"
@@ -66,7 +67,7 @@ func extractFileFromTarGz(name, inputFile, outputFile string) error {
 	tarReader := tar.NewReader(decompressedFile)
 	for {
 		header, err := tarReader.Next()
-		if err == io.EOF {
+		if errors.Is(err, io.EOF) {
 			return fmt.Errorf("could not extract file")
 		}
 		if err != nil {
@@ -97,9 +98,9 @@ func downloadPlugin(pluginInfo *plugin.PluginInfo, downloadInfo *resolver.Plugin
 		return "", err
 	}
 	if downloadInfo.Checksum != "" {
-		sum, err := hex.DecodeString(downloadInfo.Checksum)
-		if err != nil {
-			return "", err
+		sum, decErr := hex.DecodeString(downloadInfo.Checksum)
+		if decErr != nil {
+			return "", decErr
 		}
 		req.SetChecksum(sha256.New(), sum, true)
 	}
@@ -108,7 +109,8 @@ func downloadPlugin(pluginInfo *plugin.PluginInfo, downloadInfo *resolver.Plugin
 	if showProgress {
 		showDownloadProgressBar(pluginInfo.ShortNormalizedName, res)
 	}
-	if err := res.Err(); err != nil {
+	err = res.Err()
+	if err != nil {
 		return "", err
 	}
 
diff --git a/pkg/plugin/discovery/local.go b/pkg/plugin/discovery/local.go
@@ -2,15 +2,14 @@ package discovery
 
 import (
 	"errors"
-	"io/ioutil"
+	"fmt"
 	"os"
 	"path"
 	"runtime"
 	"sort"
 
-	"github.com/go-semantic-release/semantic-release/v2/pkg/plugin"
-
 	"github.com/Masterminds/semver/v3"
+	"github.com/go-semantic-release/semantic-release/v2/pkg/plugin"
 )
 
 const PluginDir = ".semrel"
@@ -20,7 +19,8 @@ var osArchDir = runtime.GOOS + "_" + runtime.GOARCH
 func setAndEnsurePluginPath(pluginInfo *plugin.PluginInfo) error {
 	pluginPath := path.Join(PluginDir, osArchDir, pluginInfo.NormalizedName)
 	if _, err := os.Stat(pluginPath); os.IsNotExist(err) {
-		if err := os.MkdirAll(pluginPath, 0o755); err != nil {
+		err = os.MkdirAll(pluginPath, 0o755)
+		if err != nil {
 			return err
 		}
 	} else if err != nil {
@@ -33,7 +33,7 @@ func setAndEnsurePluginPath(pluginInfo *plugin.PluginInfo) error {
 var ErrPluginNotFound = errors.New("no plugin was found")
 
 func getMatchingVersionDir(pluginInfo *plugin.PluginInfo) (string, error) {
-	vDirs, err := ioutil.ReadDir(pluginInfo.PluginPath)
+	vDirs, err := os.ReadDir(pluginInfo.PluginPath)
 	if err != nil {
 		return "", err
 	}
@@ -75,7 +75,7 @@ func findPluginLocally(pluginInfo *plugin.PluginInfo) (string, error) {
 		return "", ErrPluginNotFound
 	}
 
-	files, err := ioutil.ReadDir(vPth)
+	files, err := os.ReadDir(vPth)
 	if err != nil {
 		return "", err
 	}
@@ -86,7 +86,12 @@ func findPluginLocally(pluginInfo *plugin.PluginInfo) (string, error) {
 		if f.IsDir() {
 			continue
 		}
-		if f.Mode()&0o100 == 0 {
+		fInfo, err := f.Info()
+		if err != nil {
+			return "", fmt.Errorf("failed to get file info for %s: %w", f.Name(), err)
+		}
+		// check if the file is executable by the user
+		if fInfo.Mode()&0o100 == 0 {
 			continue
 		}
 		return path.Join(vPth, f.Name()), nil
diff --git a/pkg/plugin/discovery/resolver/github/github.go b/pkg/plugin/discovery/resolver/github/github.go
@@ -3,7 +3,7 @@ package github
 import (
 	"context"
 	"fmt"
-	"io/ioutil"
+	"io"
 	"net/http"
 	"os"
 	"regexp"
@@ -18,21 +18,22 @@ import (
 	"golang.org/x/oauth2"
 )
 
-type GitHubResolver struct {
+type Resolver struct {
 	ghClient *github.Client
 }
 
-func NewResolver() *GitHubResolver {
+func NewResolver() *Resolver {
 	var tc *http.Client
 	if ghToken := os.Getenv("GITHUB_TOKEN"); ghToken != "" {
 		tc = oauth2.NewClient(context.Background(), oauth2.StaticTokenSource(&oauth2.Token{AccessToken: ghToken}))
 	}
-	return &GitHubResolver{
+	return &Resolver{
 		ghClient: github.NewClient(tc),
 	}
 }
 
-func (g *GitHubResolver) githubReleaseToDownloadInfo(repoOwner, repoName string, release *github.RepositoryRelease) (*resolver.PluginDownloadInfo, error) {
+//gocyclo:ignore
+func (g *Resolver) githubReleaseToDownloadInfo(repoOwner, repoName string, release *github.RepositoryRelease) (*resolver.PluginDownloadInfo, error) {
 	var checksumAsset *github.ReleaseAsset
 	var pluginAsset *github.ReleaseAsset
 	osArchRe := regexp.MustCompile("(?i)" + runtime.GOOS + "(_|-)" + runtime.GOARCH)
@@ -56,7 +57,7 @@ func (g *GitHubResolver) githubReleaseToDownloadInfo(repoOwner, repoName string,
 		if err != nil {
 			return nil, err
 		}
-		checksumData, err := ioutil.ReadAll(checksumDownload)
+		checksumData, err := io.ReadAll(checksumDownload)
 		checksumDownload.Close()
 		if err != nil {
 			return nil, err
@@ -91,7 +92,7 @@ func (gr ghReleases) Len() int           { return len(gr) }
 func (gr ghReleases) Less(i, j int) bool { return gr[j].version.LessThan(gr[i].version) }
 func (gr ghReleases) Swap(i, j int)      { gr[i], gr[j] = gr[j], gr[i] }
 
-func (g *GitHubResolver) getAllValidGitHubReleases(repoOwner, repoName string) (ghReleases, error) {
+func (g *Resolver) getAllValidGitHubReleases(repoOwner, repoName string) (ghReleases, error) {
 	ret := make(ghReleases, 0)
 	opts := &github.ListOptions{Page: 1, PerPage: 100}
 	for {
@@ -118,7 +119,7 @@ func (g *GitHubResolver) getAllValidGitHubReleases(repoOwner, repoName string) (
 	return ret, nil
 }
 
-func (g *GitHubResolver) ResolvePlugin(pluginInfo *plugin.PluginInfo) (*resolver.PluginDownloadInfo, error) {
+func (g *Resolver) ResolvePlugin(pluginInfo *plugin.PluginInfo) (*resolver.PluginDownloadInfo, error) {
 	if pluginInfo.RepoSlug == "" {
 		pluginInfo.RepoSlug = knownPlugins[pluginInfo.ShortNormalizedName]
 	}
@@ -155,6 +156,6 @@ func (g *GitHubResolver) ResolvePlugin(pluginInfo *plugin.PluginInfo) (*resolver
 	return di, err
 }
 
-func (g *GitHubResolver) Names() []string {
+func (g *Resolver) Names() []string {
 	return []string{"github", "gh"}
 }
diff --git a/pkg/plugin/discovery/resolver/registry/registry.go b/pkg/plugin/discovery/resolver/registry/registry.go
@@ -11,24 +11,24 @@ import (
 	"github.com/go-semantic-release/semantic-release/v2/pkg/plugin/discovery/resolver"
 )
 
-type RegistryResolver struct{}
+type Resolver struct{}
 
-func NewResolver() *RegistryResolver {
-	return &RegistryResolver{}
+func NewResolver() *Resolver {
+	return &Resolver{}
 }
 
-func (r *RegistryResolver) ResolvePlugin(pluginInfo *plugin.PluginInfo) (*resolver.PluginDownloadInfo, error) {
-	pluginApiRes, err := getPluginInfo(pluginInfo.NormalizedName)
+func (r *Resolver) ResolvePlugin(pluginInfo *plugin.PluginInfo) (*resolver.PluginDownloadInfo, error) {
+	pluginAPIRes, err := getPluginInfo(pluginInfo.NormalizedName)
 	if err != nil {
 		return nil, err
 	}
 
 	foundVersion := ""
 	if pluginInfo.Constraint == nil {
-		foundVersion = pluginApiRes.LatestRelease
+		foundVersion = pluginAPIRes.LatestRelease
 	} else {
 		versions := make(semver.Collection, 0)
-		for v := range pluginApiRes.Versions {
+		for v := range pluginAPIRes.Versions {
 			pv, err := semver.NewVersion(v)
 			if err != nil {
 				return nil, err
@@ -48,7 +48,7 @@ func (r *RegistryResolver) ResolvePlugin(pluginInfo *plugin.PluginInfo) (*resolv
 		return nil, errors.New("version not found")
 	}
 
-	releaseAsset := pluginApiRes.Versions[foundVersion].getMatchingAsset()
+	releaseAsset := pluginAPIRes.Versions[foundVersion].getMatchingAsset()
 	if releaseAsset == nil {
 		return nil, fmt.Errorf("a matching plugin was not found for %s/%s", runtime.GOOS, runtime.GOARCH)
 	}
@@ -60,6 +60,6 @@ func (r *RegistryResolver) ResolvePlugin(pluginInfo *plugin.PluginInfo) (*resolv
 	}, nil
 }
 
-func (r *RegistryResolver) Names() []string {
+func (r *Resolver) Names() []string {
 	return []string{"registry"}
 }

Original file line number	Diff line number	Diff line change
`@@ -1,6 +1,7 @@`
`1`	`1`	`package config`
`2`	`2`
`3`	`3`	`import (`
	`4`	`+ "errors"`
`4`	`5`	`"os"`
`5`	`6`	`"strings"`
`6`	`7`
`@@ -142,18 +143,20 @@ func must(err error) {`
`142`	`143`	`}`
`143`	`144`	`}`
`144`	`145`
	`146`	`+var trueString = "true"`
	`147`	`+`
`145`	`148`	`func detectCI() string {`
`146`		`- if os.Getenv("GITHUB_ACTIONS") == "true" {`
	`149`	`+ if os.Getenv("GITHUB_ACTIONS") == trueString {`
`147`	`150`	`return "github"`
`148`	`151`	`}`
`149`		`- if os.Getenv("GITLAB_CI") == "true" {`
	`152`	`+ if os.Getenv("GITLAB_CI") == trueString {`
`150`	`153`	`return "gitlab"`
`151`	`154`	`}`
`152`	`155`	`return "default"`
`153`	`156`	`}`
`154`	`157`
`155`	`158`	`func defaultProvider() string {`
`156`		`- if os.Getenv("GITLAB_CI") == "true" {`
	`159`	`+ if os.Getenv("GITLAB_CI") == trueString {`
`157`	`160`	`return "gitlab"`
`158`	`161`	`}`
`159`	`162`	`return "github"`
`@@ -218,7 +221,8 @@ func InitConfig(cmd *cobra.Command) error {`
`218`	`221`	`viper.SetConfigType("json")`
`219`	`222`
`220`	`223`	`if err := viper.ReadInConfig(); err != nil {`
`221`		`- if _, ok := err.(viper.ConfigFileNotFoundError); !ok {`
	`224`	`+ var viperConfigNotFound viper.ConfigFileNotFoundError`
	`225`	`+ if !errors.As(err, &viperConfigNotFound) {`
`222`	`226`	`return err`
`223`	`227`	`}`
`224`	`228`	`}`
Original file line number	Diff line number	Diff line change
`@@ -69,7 +69,9 @@ func (d Discovery) FindPlugin(t, name string) (plugin.PluginInfo, error) {`
`69`	`69`	`if err != nil {`
`70`	`70`	`return nil, err`
`71`	`71`	`}`
`72`		`- if err := setAndEnsurePluginPath(pInfo); err != nil {`
	`72`	`+`
	`73`	`+ err = setAndEnsurePluginPath(pInfo)`
	`74`	`+ if err != nil {`
`73`	`75`	`return nil, err`
`74`	`76`	`}`
`75`	`77`