fix lint

Author: worlpaker

.golangci.yml

@@ -0,0 +1,69 @@
+# yaml-language-server: $schema=https://golangci-lint.run/jsonschema/golangci.jsonschema.json
+
+run:
+  allow-parallel-runners: true
+  timeout: 3m
+
+linters:
+  disable-all: true
+  enable:
+    - asasalint
+    - bidichk
+    - bodyclose
+    - canonicalheader
+    - copyloopvar
+    - durationcheck
+    - errcheck
+    - errchkjson
+    - errname
+    - errorlint
+    - exhaustive
+    - fatcontext
+    - forcetypeassert
+    - gocheckcompilerdirectives
+    - gocognit
+    - gocritic
+    - gofmt
+    - gofumpt
+    - goprintffuncname
+    - gosec
+    - gosimple
+    - govet
+    - grouper
+    - inamedparam
+    - ineffassign
+    - intrange
+    - makezero
+    - mirror
+    - musttag
+    - nakedret
+    - nilerr
+    - nilnil
+    - nolintlint
+    - paralleltest
+    - perfsprint
+    - predeclared
+    - reassign
+    - revive
+    - staticcheck
+    - stylecheck
+    - testableexamples
+    - testifylint
+    - tparallel
+    - unconvert
+    - unparam
+    - unused
+    - usestdlibvars
+    - usetesting
+    - whitespace
+
+linters-settings:
+  govet:
+    enable-all: true
+
+issues:
+  exclude-rules:
+    - path: (.+)_test.go
+      linters:
+        - govet
+      text: fieldalignment

cmd/flags.go

@@ -6,16 +6,16 @@ import (
 
 // flags represents the flags for the root command.
 type flags struct {
+	set   string
 	auth  bool
 	check bool
-	set   string
 	unset bool
 }
 
 // cmdFlags configures command flags for the root command.
 func cmdFlags(c *cobra.Command, f *flags) {
+	c.Flags().StringVarP(&f.set, "set", "s", "", "set github token into os environment variable (e.g., gitty -s=your_github_token)")
 	c.Flags().BoolVarP(&f.auth, "auth", "a", false, "print authenticated username")
 	c.Flags().BoolVarP(&f.check, "check", "c", false, "check client status and remaining rate limit")
-	c.Flags().StringVarP(&f.set, "set", "s", "", "set github token into os environment variable (e.g. gitty -s=your_github_token)")
 	c.Flags().BoolVarP(&f.unset, "unset", "u", false, "unset github token from os environment variable")
 }

cmd/flags_test.go

@@ -4,21 +4,22 @@ import (
 	"testing"
 
 	"github.com/spf13/cobra"
-	"github.com/stretchr/testify/assert"
+	"github.com/stretchr/testify/require"
 )
 
 func TestCmdFlags(t *testing.T) {
+	t.Parallel()
 	c := &cobra.Command{}
 	f := &flags{}
 
 	cmdFlags(c, f)
 
 	_, err := c.Flags().GetString("set")
-	assert.Nil(t, err)
+	require.NoError(t, err)
 	_, err = c.Flags().GetBool("auth")
-	assert.Nil(t, err)
+	require.NoError(t, err)
 	_, err = c.Flags().GetBool("check")
-	assert.Nil(t, err)
+	require.NoError(t, err)
 	_, err = c.Flags().GetBool("unset")
-	assert.Nil(t, err)
+	require.NoError(t, err)
 }

cmd/root_test.go

@@ -2,14 +2,14 @@ package cmd
 
 import (
 	"context"
-	"fmt"
+	"errors"
 	"os"
 	"os/exec"
-	"syscall"
 	"testing"
 
 	"github.com/spf13/cobra"
 	"github.com/stretchr/testify/assert"
+	"github.com/stretchr/testify/require"
 	"github.com/worlpaker/gitty/gitty"
 	"github.com/worlpaker/gitty/gitty/token"
 )
@@ -20,61 +20,57 @@ func fakeNewGitty() gitty.Gitty {
 
 type mock struct{}
 
-func (m *mock) Status(ctx context.Context) error {
+func (m *mock) Status(_ context.Context) error {
 	return nil
 }
-func (m *mock) Download(ctx context.Context, url string) error {
+
+func (m *mock) Download(_ context.Context, _ string) error {
 	return nil
 }
-func (m *mock) Auth(ctx context.Context) error {
+
+func (m *mock) Auth(_ context.Context) error {
 	return nil
 }
 
 func TestSubCommands(t *testing.T) {
+	t.Parallel()
 	c := &cobra.Command{}
 	subCommands(c)
 	assert.True(t, c.HasSubCommands())
 }
 
 func TestCmdSettings(t *testing.T) {
-	// Discard output during tests.
-	defer func(stdout *os.File) {
-		os.Stdout = stdout
-	}(os.Stdout)
-	os.Stdout = os.NewFile(uintptr(syscall.Stdin), os.DevNull)
-
+	t.Parallel()
 	c := &cobra.Command{}
 	cmdSettings(c)
 	f := c.FlagErrorFunc()
-	err := f(c, fmt.Errorf("test error"))
-	assert.Nil(t, err)
+	err := f(c, errors.New("test error"))
+	require.NoError(t, err)
 }
 
 func TestExecute(t *testing.T) {
-	// Set fake args and discard output during tests.
-	oldArgs := os.Args
-	defer func(stdout *os.File) {
-		os.Args = oldArgs
-		os.Stdout = stdout
-	}(os.Stdout)
-	os.Stdout = os.NewFile(uintptr(syscall.Stdin), os.DevNull)
+	t.Parallel()
+	// Set fake args during tests.
+	originalArgs := os.Args
+	t.Cleanup(func() {
+		os.Args = originalArgs
+	})
 	os.Args = []string{"test flag", "--check"}
 
 	err := Execute(context.Background(), "1.0.0")
-	assert.Nil(t, err)
+	require.NoError(t, err)
 }
 
 func TestRunRoot(t *testing.T) {
-	// Restore token and discard output during tests.
+	t.Parallel()
+	// Restore token.
 	localToken := token.Get()
-	defer func(stdout *os.File) {
+	t.Cleanup(func() {
 		if localToken != "" {
 			err := token.Set(localToken)
-			assert.Nil(t, err)
+			require.NoError(t, err)
 		}
-		os.Stdout = stdout
-	}(os.Stdout)
-	os.Stdout = os.NewFile(uintptr(syscall.Stdin), os.DevNull)
+	})
 
 	tests := []struct {
 		name  string
@@ -111,6 +107,7 @@ func TestRunRoot(t *testing.T) {
 
 	for _, test := range tests {
 		t.Run(test.name, func(t *testing.T) {
+			t.Parallel()
 			c := &cobra.Command{}
 			g := fakeNewGitty()
 			runFunc := runRoot(context.Background(), &test.flags, g)
@@ -119,11 +116,12 @@ func TestRunRoot(t *testing.T) {
 			// The result might not be nil in very rare cases.
 			// Error: &exec.ExitError{ProcessState:(*os.ProcessState)(0xc00017a288), Stderr:[]uint8(nil)}
 			if err != nil {
-				if e, ok := err.(*exec.ExitError); ok && !e.Success() {
+				var execErr *exec.ExitError
+				if errors.As(err, &execErr) && !execErr.Success() {
 					return
 				}
 			}
-			assert.Nil(t, err)
+			require.NoError(t, err)
 		})
 	}
 }

cmd/version.go

@@ -11,7 +11,7 @@ func versionCmd() *cobra.Command {
 	return &cobra.Command{
 		Use:   "version",
 		Short: "Print the version number of gitty",
-		Run: func(cmd *cobra.Command, args []string) {
+		Run: func(cmd *cobra.Command, _ []string) {
 			fmt.Println("gitty version", cmd.Root().Version)
 		},
 	}

cmd/version_test.go

@@ -1,20 +1,13 @@
 package cmd
 
 import (
-	"os"
-	"syscall"
 	"testing"
 
 	"github.com/spf13/cobra"
 )
 
 func TestVersionCmd(t *testing.T) {
-	// Discard output during tests.
-	defer func(stdout *os.File) {
-		os.Stdout = stdout
-	}(os.Stdout)
-	os.Stdout = os.NewFile(uintptr(syscall.Stdin), os.DevNull)
-
+	t.Parallel()
 	c := &cobra.Command{Version: "1.0.0"}
 	v := versionCmd()
 	v.Run(c, nil)

gitty/github.go

@@ -43,7 +43,7 @@ type Client interface {
 }
 
 // Ensure service implements the Client interface.
-var _ Client = &service{}
+var _ Client = (*service)(nil)
 
 // Get issues a GET to the specified URL. If the response is one of the
 // following redirect codes, Get follows the redirect after calling the

gitty/github_test.go

@@ -6,12 +6,12 @@ import (
 	"io"
 	"net/http"
 	"os"
-
 	"testing"
 
 	"github.com/brianvoe/gofakeit/v7"
 	"github.com/google/go-github/v67/github"
 	"github.com/stretchr/testify/assert"
+	"github.com/stretchr/testify/require"
 )
 
 func TestNewClient(t *testing.T) {
@@ -37,20 +37,15 @@ func TestNewClient(t *testing.T) {
 
 	for _, test := range tests {
 		t.Run(test.name, func(t *testing.T) {
-			if !test.auth {
-				err := os.Unsetenv(tokenKey)
-				assert.Nil(t, err)
+			if test.auth {
+				t.Setenv(tokenKey, fakeValue)
 				client := newClient()
-				assert.Equal(t, test.expected, client)
+				assert.Equal(t, test.expected.UserAgent, client.UserAgent)
 			} else {
-				err := os.Setenv(tokenKey, fakeValue)
-				assert.Nil(t, err)
-				t.Cleanup(func() {
-					err = os.Unsetenv(tokenKey)
-					assert.Nil(t, err)
-				})
+				err := os.Unsetenv(tokenKey)
+				require.NoError(t, err)
 				client := newClient()
-				assert.Equal(t, test.expected.UserAgent, client.UserAgent)
+				assert.Equal(t, test.expected, client)
 			}
 		})
 	}
@@ -60,7 +55,7 @@ var mockGetBody = []byte(`{"data":"test"}`)
 
 type mock struct{}
 
-func (m mock) RoundTrip(req *http.Request) (*http.Response, error) {
+func (m mock) RoundTrip(_ *http.Request) (*http.Response, error) {
 	resp := &http.Response{
 		StatusCode: http.StatusOK,
 		Body:       io.NopCloser(bytes.NewReader(mockGetBody)),
@@ -79,35 +74,41 @@ func setup() *service {
 }
 
 func TestGet(t *testing.T) {
+	t.Parallel()
 	s := setup()
+
 	resp, err := s.Get("https://test.com")
-	assert.Nil(t, err)
+	require.NoError(t, err)
 	defer resp.Body.Close()
 	assert.Equal(t, http.StatusOK, resp.StatusCode)
+
 	expectedBody, _ := io.ReadAll(resp.Body)
-	assert.Equal(t, mockGetBody, expectedBody)
+	assert.Equal(t, expectedBody, mockGetBody)
 }
 
 func TestGetContents(t *testing.T) {
+	t.Parallel()
 	s := setup()
 	opts := &github.RepositoryContentGetOptions{
 		Ref: "main",
 	}
 	_, _, resp, err := s.GetContents(context.Background(), "owner", "repo", "path", opts)
-	assert.Nil(t, err)
+	require.NoError(t, err)
 	assert.Equal(t, http.StatusOK, resp.StatusCode)
 }
 
 func TestRateLimit(t *testing.T) {
+	t.Parallel()
 	s := setup()
 	_, resp, err := s.RateLimit(context.Background())
-	assert.Nil(t, err)
+	require.NoError(t, err)
 	assert.Equal(t, http.StatusOK, resp.StatusCode)
 }
 
 func TestGetUser(t *testing.T) {
+	t.Parallel()
 	s := setup()
 	_, resp, err := s.GetUser(context.Background(), "")
-	assert.Nil(t, err)
+	require.NoError(t, err)
 	assert.Equal(t, http.StatusOK, resp.StatusCode)
 }

gitty/gitty.go

@@ -19,7 +19,7 @@ type Gitty interface {
 }
 
 // Ensure Git implements the Gitty interface.
-var _ Gitty = &Git{}
+var _ Gitty = (*Git)(nil)
 
 // New creates a new Gitty.
 func New() Gitty {