Add golangci-lint (#181)

* fix: toolchain not available After updating golang to 1.22 we have error: ``` go: download go1.22 for darwin/arm64: toolchain not available ``` golang/go#65568 Just set full version for golang to fix this issue * fix: add build tag to windows cmd goland added this automatically :) * feat: add golangci-lint to build Using golangci-link makes it easier to check the code and avoid a lot of problems * fix: linters warnings * fix: a more specific definition of exclusion for gocritic
kevincobain2000 · Feb 11, 2024 · de3d482 · de3d482
1 parent 0e87ab3
commit de3d482
Show file tree

Hide file tree

Showing 9 changed files with 111 additions and 55 deletions.
diff --git a/.github/workflows/golangci-lint.yml b/.github/workflows/golangci-lint.yml
@@ -0,0 +1,27 @@
+name: golangci-lint
+on:
+  push:
+    branches:
+      - '**'
+  pull_request:
+    branches:
+      - '**'
+  workflow_dispatch:
+
+permissions:
+  contents: read
+jobs:
+  golangci:
+    name: lint
+    runs-on: ubuntu-latest
+    steps:
+      -
+        uses: actions/checkout@v4
+      -
+        uses: kevincobain2000/action-gobrew@v2
+        with:
+          version: latest
+      -
+        uses: golangci/golangci-lint-action@v4
+        with:
+          version: latest
diff --git a/.golangci.yaml b/.golangci.yaml
@@ -0,0 +1,24 @@
+linters:
+  # Disable all linters.
+  # Default: false
+  disable-all: true
+  # Enable specific linter
+  # https://golangci-lint.run/usage/linters/#enabled-by-default
+  enable:
+    - errcheck
+    - gosimple
+    - govet
+    - ineffassign
+    - staticcheck
+    - dupl
+    - errorlint
+    - exportloopref
+    - goconst
+    - gocritic
+    - gocyclo
+    - goprintffuncname
+    - gosec
+    - prealloc
+    - revive
+    - stylecheck
+    - whitespace
diff --git a/cmd/gobrew/main.go b/cmd/gobrew/main.go
@@ -67,7 +67,7 @@ func init() {
 			// Check if the major version is 1 and the minor version is 21 or greater
 			if majorVersionNum == 1 && minorVersionNum >= 21 {
 				// Modify the versionArg to include ".0"
-				versionArg = versionArg + ".0"
+				versionArg += ".0"
 			}
 		}
 	}
@@ -88,10 +88,10 @@ func main() {
 
 	config := gobrew.Config{
 		RootDir:           rootDir,
-		RegistryPathUrl:   registryPath,
-		GobrewDownloadUrl: gobrew.DownloadUrl,
-		GobrewTags:        gobrew.TagsApi,
-		GobrewVersionsUrl: gobrew.VersionsUrl,
+		RegistryPathURL:   registryPath,
+		GobrewDownloadURL: gobrew.DownloadURL,
+		GobrewTags:        gobrew.TagsAPI,
+		GobrewVersionsURL: gobrew.VersionsURL,
 	}
 
 	gb := gobrew.NewGoBrew(config)
@@ -108,7 +108,7 @@ func main() {
 		gb.ListRemoteVersions(true)
 	case "install":
 		gb.Install(versionArg)
-		if gb.CurrentVersion() == "None" {
+		if gb.CurrentVersion() == gobrew.NoneVersion {
 			gb.Use(versionArg)
 		}
 	case "use":

diff --git a/cmd/gobrew/main_windows.go b/cmd/gobrew/main_windows.go
@@ -1,3 +1,5 @@
+//go:build windows
+
 package main
 
 const usageMsg = `

diff --git a/go.mod b/go.mod
@@ -1,6 +1,6 @@
 module github.com/kevincobain2000/gobrew
 
-go 1.22
+go 1.22.0
 
 require (
 	github.com/Masterminds/semver v1.5.0

diff --git a/gobrew.go b/gobrew.go
@@ -20,9 +20,14 @@ import (
 const (
 	goBrewDir           string = ".gobrew"
 	DefaultRegistryPath string = "https://go.dev/dl/"
-	DownloadUrl         string = "https://github.com/kevincobain2000/gobrew/releases/latest/download/"
-	TagsApi                    = "https://raw.githubusercontent.com/kevincobain2000/gobrew/json/golang-tags.json"
-	VersionsUrl         string = "https://api.github.com/repos/kevincobain2000/gobrew/releases/latest"
+	DownloadURL         string = "https://github.com/kevincobain2000/gobrew/releases/latest/download/"
+	TagsAPI                    = "https://raw.githubusercontent.com/kevincobain2000/gobrew/json/golang-tags.json"
+	VersionsURL         string = "https://api.github.com/repos/kevincobain2000/gobrew/releases/latest"
+)
+
+const (
+	NoneVersion = "None"
+	ProgramName = "gobrew"
 )
 
 // check GoBrew implement is Command interface
@@ -31,7 +36,7 @@ var _ Command = (*GoBrew)(nil)
 // Command ...
 type Command interface {
 	ListVersions()
-	ListRemoteVersions(print bool) map[string][]string
+	ListRemoteVersions(bool) map[string][]string
 	CurrentVersion() string
 	Uninstall(version string)
 	Install(version string) string
@@ -55,10 +60,10 @@ type GoBrew struct {
 
 type Config struct {
 	RootDir           string
-	RegistryPathUrl   string
-	GobrewDownloadUrl string
+	RegistryPathURL   string
+	GobrewDownloadURL string
 	GobrewTags        string
-	GobrewVersionsUrl string
+	GobrewVersionsURL string
 }
 
 // NewGoBrew instance
@@ -85,19 +90,19 @@ func (gb *GoBrew) Interactive(ask bool) {
 	latestVersion := gb.getLatestVersion()
 	latestMajorVersion := extractMajorVersion(latestVersion)
 
-	modVersion := "None"
+	modVersion := NoneVersion
 	if gb.hasModFile() {
 		modVersion = gb.getModVersion()
 		modVersion = extractMajorVersion(modVersion)
 	}
 
 	fmt.Println()
 
-	if currentVersion == "None" {
+	if currentVersion == NoneVersion {
 		color.Warnln("GO Installed Version", ".......", currentVersion)
 	} else {
 		var labels []string
-		if modVersion != "None" && currentMajorVersion != modVersion {
+		if modVersion != NoneVersion && currentMajorVersion != modVersion {
 			labels = append(labels, "not same as go.mod")
 		}
 		if currentVersion != latestVersion {
@@ -111,7 +116,7 @@ func (gb *GoBrew) Interactive(ask bool) {
 		color.Successln("GO Installed Version", ".......", currentVersion+label)
 	}
 
-	if modVersion != "None" && latestMajorVersion != modVersion {
+	if modVersion != NoneVersion && latestMajorVersion != modVersion {
 		label := " " + color.FgYellow.Render("(not latest)")
 		color.Successln("GO go.mod Version", "   .......", modVersion+label)
 	} else {
@@ -121,7 +126,7 @@ func (gb *GoBrew) Interactive(ask bool) {
 	color.Successln("GO Latest Version", "   .......", latestVersion)
 	fmt.Println()
 
-	if currentVersion == "None" {
+	if currentVersion == NoneVersion {
 		color.Warnln("GO is not installed.")
 		c := true
 		if ask {
@@ -133,7 +138,7 @@ func (gb *GoBrew) Interactive(ask bool) {
 		return
 	}
 
-	if modVersion != "None" && currentMajorVersion != modVersion {
+	if modVersion != NoneVersion && currentMajorVersion != modVersion {
 		color.Warnf("GO Installed Version (%s) and go.mod Version (%s) are different.\n", currentMajorVersion, modVersion)
 		c := true
 		if ask {
@@ -268,12 +273,12 @@ func (gb *GoBrew) ListRemoteVersions(print bool) map[string][]string {
 func (gb *GoBrew) CurrentVersion() string {
 	fp, err := evalSymlinks(gb.currentBinDir)
 	if err != nil {
-		return "None"
+		return NoneVersion
 	}
 	version := strings.TrimSuffix(fp, filepath.Join("go", "bin"))
 	version = filepath.Base(version)
 	if version == "." {
-		return "None"
+		return NoneVersion
 	}
 	return version
 }
@@ -294,7 +299,7 @@ func (gb *GoBrew) Uninstall(version string) {
 
 // Install the given version of go
 func (gb *GoBrew) Install(version string) string {
-	if version == "" || version == "None" {
+	if version == "" || version == NoneVersion {
 		color.Errorln("[Error] No version provided")
 		os.Exit(1)
 	}
@@ -337,11 +342,11 @@ func (gb *GoBrew) Upgrade(currentVersion string) {
 		return
 	}
 
-	mkdirTemp, _ := os.MkdirTemp("", "gobrew")
-	tmpFile := filepath.Join(mkdirTemp, "gobrew"+fileExt)
-	downloadUrl, _ := url.JoinPath(gb.GobrewDownloadUrl, "gobrew-"+gb.getArch()+fileExt)
+	mkdirTemp, _ := os.MkdirTemp("", ProgramName)
+	tmpFile := filepath.Join(mkdirTemp, ProgramName+fileExt)
+	downloadURL, _ := url.JoinPath(gb.GobrewDownloadURL, "gobrew-"+gb.getArch()+fileExt)
 	utils.CheckError(
-		utils.DownloadWithProgress(downloadUrl, "gobrew"+fileExt, mkdirTemp),
+		utils.DownloadWithProgress(downloadURL, ProgramName+fileExt, mkdirTemp),
 		"[Error] Download GoBrew failed")
 
 	source, err := os.Open(tmpFile)
@@ -351,7 +356,7 @@ func (gb *GoBrew) Upgrade(currentVersion string) {
 		utils.CheckError(os.Remove(source.Name()), "==> [Error] Cannot remove tmp file:")
 	}(source)
 
-	goBrewFile := filepath.Join(gb.installDir, "bin", "gobrew"+fileExt)
+	goBrewFile := filepath.Join(gb.installDir, "bin", ProgramName+fileExt)
 	removeFile(goBrewFile)
 	destination, err := os.Create(goBrewFile)
 	utils.CheckError(err, "==> [Error] Cannot open file")

diff --git a/gobrew_test.go b/gobrew_test.go
@@ -13,13 +13,13 @@ import (
 
 func setupGobrew(t *testing.T, ts *httptest.Server) GoBrew {
 	tags, _ := url.JoinPath(ts.URL, "golang-tags.json")
-	versionUrl, _ := url.JoinPath(ts.URL, "latest")
+	versionURL, _ := url.JoinPath(ts.URL, "latest")
 	config := Config{
 		RootDir:           t.TempDir(),
-		RegistryPathUrl:   ts.URL,
-		GobrewDownloadUrl: ts.URL,
+		RegistryPathURL:   ts.URL,
+		GobrewDownloadURL: ts.URL,
 		GobrewTags:        tags,
-		GobrewVersionsUrl: versionUrl,
+		GobrewVersionsURL: versionURL,
 	}
 	gb := NewGoBrew(config)
 	return gb
@@ -59,7 +59,7 @@ func TestUpgrade(t *testing.T) {
 	binaryDir := filepath.Join(gb.installDir, "bin")
 	_ = os.MkdirAll(binaryDir, os.ModePerm)
 
-	baseName := "gobrew" + fileExt
+	baseName := ProgramName + fileExt
 	binaryFile := filepath.Join(binaryDir, baseName)
 
 	if oldFile, err := os.Create(binaryFile); err == nil {
@@ -84,7 +84,7 @@ func TestDoNotUpgradeLatestVersion(t *testing.T) {
 	binaryDir := filepath.Join(gb.installDir, "bin")
 	_ = os.MkdirAll(binaryDir, os.ModePerm)
 
-	baseName := "gobrew" + fileExt
+	baseName := ProgramName + fileExt
 	binaryFile := filepath.Join(binaryDir, baseName)
 
 	currentVersion := gb.getGobrewVersion()
@@ -109,7 +109,7 @@ func TestInteractive(t *testing.T) {
 
 	currentVersion := gb.CurrentVersion()
 	latestVersion := gb.getLatestVersion()
-	assert.Equal(t, "None", currentVersion)
+	assert.Equal(t, NoneVersion, currentVersion)
 	assert.NotEqual(t, currentVersion, latestVersion)
 
 	gb.Interactive(false)
@@ -148,7 +148,7 @@ func TestGoBrew_CurrentVersion(t *testing.T) {
 	ts := httptest.NewServer(http.FileServer(http.Dir("testdata")))
 	defer ts.Close()
 	gb := setupGobrew(t, ts)
-	assert.Equal(t, true, gb.CurrentVersion() == "None")
+	assert.Equal(t, true, gb.CurrentVersion() == NoneVersion)
 	gb.Install("1.19")
 	gb.Use("1.19")
 	assert.Equal(t, true, gb.CurrentVersion() == "1.19")