fix: add version command (#4)

.github/workflows/check.yaml

@@ -0,0 +1,43 @@
+name: Check
+
+permissions:
+  contents: read
+
+on:
+  pull_request:
+    branches:
+      - main
+    paths-ignore:
+      - example/**
+      - "**/*.md"
+      - "**/*.yaml"
+  push:
+    branches:
+      - main
+
+jobs:
+  job:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+      - uses: actions/setup-go@v5
+        with:
+          go-version-file: go.mod
+      - name: 🧹 Lint
+        uses: golangci/golangci-lint-action@v6
+        with:
+          version: latest
+      #     args: --timeout=10m --out-format=colored-line-number
+      - name: Install dependencies
+        run: go install gotest.tools/gotestsum@latest
+      - name: 🧪 Test
+        run: gotestsum --junitfile junit.xml --format testdox -- -race -coverprofile=coverage.out -covermode=atomic
+      - name: Upload coverage reports to Codecov
+        uses: codecov/codecov-action@v4
+        with:
+          token: ${{ secrets.CODECOV_TOKEN }}
+      - name: Upload test results to Codecov
+        if: ${{ !cancelled() }}
+        uses: codecov/test-results-action@v1
+        with:
+          token: ${{ secrets.CODECOV_TOKEN }}

.golangci.yaml

@@ -0,0 +1,172 @@
+# https://github.com/golangci/golangci-lint/blob/master/.golangci.reference.yml
+
+run:
+  timeout: 5m
+  tests: false
+
+linters-settings:
+  errcheck:
+    # Report about not checking of errors in type assertions: `a := b.(MyStruct)`.
+    # Such cases aren't reported by default.
+    # Default: false
+    check-type-assertions: true
+    # https://github.com/golangci/golangci-lint/issues/4743
+
+  exhaustive:
+    # Program elements to check for exhaustiveness.
+    # Default: [ switch ]
+    check:
+      - switch
+      - map
+
+  gocritic:
+    # Settings passed to gocritic.
+    # The settings key is the name of a supported gocritic checker.
+    # The list of supported checkers can be find in https://go-critic.github.io/overview.
+    settings:
+      captLocal:
+        # Whether to restrict checker to params only.
+        # Default: true
+        paramsOnly: false
+      underef:
+        # Whether to skip (*x).method() calls where x is a pointer receiver.
+        # Default: true
+        skipRecvDeref: false
+
+  gomodguard:
+    blocked:
+      # List of blocked modules.
+      # Default: []
+      modules:
+        - github.com/golang/protobuf:
+            recommendations:
+              - google.golang.org/protobuf
+            reason: 'see https://developers.google.com/protocol-buffers/docs/reference/go/faq#modules'
+        - github.com/satori/go.uuid:
+            recommendations:
+              - github.com/google/uuid
+            reason: "satori's package is not maintained"
+        - github.com/gofrs/uuid:
+            recommendations:
+              - github.com/google/uuid
+            reason: "gofrs' package is not go module"
+
+  govet:
+    # Enable all analyzers.
+    # Default: false
+    enable-all: true
+    # Disable analyzers by name.
+    # Run `go tool vet help` to see all analyzers.
+    # Default: []
+    disable:
+      - fieldalignment # too strict
+    # Settings per analyzer.
+    settings:
+      shadow:
+        # Whether to be strict about shadowing; can be noisy.
+        # Default: false
+        strict: true
+
+  nakedret:
+    # Make an issue if func has more lines of code than this setting, and it has naked returns.
+    # Default: 30
+    max-func-lines: 0
+
+  nolintlint:
+    # Exclude following linters from requiring an explanation.
+    # Default: []
+    allow-no-explanation: []
+    # Enable to require an explanation of nonzero length after each nolint directive.
+    # Default: false
+    require-explanation: true
+    # Enable to require nolint directives to mention the specific linter being suppressed.
+    # Default: false
+    require-specific: true
+
+  stylecheck:
+    checks: ['all', '-ST1003']
+
+  tenv:
+    # The option `all` will run against whole test files (`_test.go`) regardless of method/function signatures.
+    # Otherwise, only methods that take `*testing.T`, `*testing.B`, and `testing.TB` as arguments are checked.
+    # Default: false
+    all: true
+
+linters:
+  disable-all: true
+  enable:
+    ## enabled by default
+    - errcheck # checking for unchecked errors, these unchecked errors can be critical bugs in some cases
+    - gosimple # specializes in simplifying a code
+    - govet # reports suspicious constructs, such as Printf calls whose arguments do not align with the format string
+    - ineffassign # detects when assignments to existing variables are not used
+    - staticcheck # is a go vet on steroids, applying a ton of static analysis checks
+    - typecheck # like the front-end of a Go compiler, parses and type-checks Go code
+    - unused # checks for unused constants, variables, functions and types
+    ## disabled by default
+    - asasalint # checks for pass []any as any in variadic func(...any)
+    - asciicheck # checks that your code does not contain non-ASCII identifiers
+    - bidichk # checks for dangerous unicode character sequences
+    - bodyclose # checks whether HTTP response body is closed successfully
+    - goheader
+    - containedctx # Containedctx is a linter that detects struct contained context.Context field.
+    - contextcheck # checks the function whether use a non-inherited context
+    - durationcheck # checks for two durations multiplied together
+    - errname # checks that sentinel errors are prefixed with the Err and error types are suffixed with the Error
+    - errorlint # finds code that will cause problems with the error wrapping scheme introduced in Go 1.13
+    - exhaustive # checks exhaustiveness of enum switch statements
+    - exportloopref # checks for pointers to enclosing loop variables
+    # - fatcontext
+    - forbidigo # forbids identifiers
+    - forcetypeassert # finds forced type assertions
+    - gocheckcompilerdirectives # validates go compiler directive comments (//go:)
+    - goconst # finds repeated strings that could be replaced by a constant
+    - gocritic # provides diagnostics that check for bugs, performance and style issues
+    - gofmt # checks whether code was gofmt-ed
+    - goimports # in addition to fixing imports, goimports also formats your code in the same style as gofmt
+    - gomodguard # allow and block lists linter for direct Go module dependencies. This is different from depguard where there are different block types for example version constraints and module recommendations
+    - goprintffuncname # checks that printf-like functions are named with f at the end
+    - gosec # inspects source code for security problems
+    # - intrange # checks for range over int (requires go 1.22)
+    - loggercheck # checks key value pairs for common logger libraries (kitlog,klog,logr,zap)
+    - makezero # finds slice declarations with non-zero initial length
+    - gomnd # detects magic numbers
+    - musttag # enforces field tags in (un)marshaled structs
+    - nakedret # finds naked returns in functions greater than a specified function length
+    - nestif # reports deeply nested if statements
+    - nilerr # finds the code that returns nil even if it checks that the error is not nil
+    - nilnil # checks that there is no simultaneous return of nil error and an invalid value
+    - noctx # finds sending http request without context.Context
+    - nolintlint # reports ill-formed or insufficient nolint directives
+    - nonamedreturns # reports all named returns
+    - nosprintfhostport # checks for misuse of Sprintf to construct a host with port in a URL
+    - predeclared # finds code that shadows one of Go's predeclared identifiers
+    - promlinter # checks Prometheus metrics naming via promlint
+    - protogetter # Reports direct reads from proto message fields when getters should be used.
+    - reassign # checks that package variables are not reassigned
+    # - revive # fast, configurable, extensible, flexible, and beautiful linter for Go, drop-in replacement of golint
+    - rowserrcheck # checks whether Err of rows is checked successfully
+    - sloglint # Ensure consistent code style when using log/slog.
+    # - spancheck # checks for incorrect usage of opentracing.Span # Added in golangci-lint 1.56
+    - sqlclosecheck # checks that sql.Rows and sql.Stmt are closed
+    - stylecheck # is a replacement for golint
+    - tenv # detects using os.Setenv instead of t.Setenv since Go1.17
+    - testableexamples # checks if examples are testable (have an expected output)
+    - testifylint
+    # - testpackage # makes you use a separate _test package
+    - tparallel # detects inappropriate usage of t.Parallel() method in your Go test codes
+    - unconvert # removes unnecessary type conversions
+    - unparam # reports unused function parameters
+    - usestdlibvars # detects the possibility to use variables/constants from the Go standard library
+    - wastedassign # finds wasted assignment statements
+    - whitespace # detects leading and trailing whitespace
+
+issues:
+  # Maximum count of issues with the same text.
+  # Set to 0 to disable.
+  # Default: 3
+  max-same-issues: 0
+  # Maximum issues count per one linter.
+  # Set to 0 to disable.
+  # Default: 50
+  max-issues-per-linter: 0

main.go

@@ -10,6 +10,8 @@ import (
 	"golang.org/x/mod/modfile"
 )
 
+var Version = "v0.0.0"
+
 const usage = `
 NAME
   go-mod-what - get the version of a package in a go.mod file
@@ -45,9 +47,15 @@ EXAMPLES
       v1.8.0
 `
 
+type Package struct {
+	Path    string
+	Version string
+}
+
 func main() {
 	modfilePath := flag.String("modfile", "./go.mod", "path to go.mod file")
 	help := flag.Bool("help", false, "show help")
+	version := flag.Bool("version", false, "show version")
 	onlyVersion := flag.Bool("only-version", false, "only print the version")
 	flag.Parse()
 
@@ -57,6 +65,11 @@ func main() {
 		return
 	}
 
+	if *version {
+		fmt.Fprint(os.Stdout, Version+"\n")
+		return
+	}
+
 	if len(flag.Args()) == 0 {
 		printError("no package provided", nil, true)
 	}
@@ -76,27 +89,39 @@ func main() {
 		printError("failed to parse go.mod file", err)
 	}
 
-	found := make([]bool, len(flag.Args()))
+	pkgs := flag.Args()
+	pkgVers, pkgFound := findPackages(m, pkgs)
+
+	for _, p := range pkgVers {
+		if *onlyVersion {
+			fmt.Fprintln(os.Stdout, p.Version)
+			continue
+		}
+		fmt.Fprintln(os.Stdout, p.Path+" "+p.Version)
+	}
+
+	for i, f := range pkgFound {
+		if !f {
+			fmt.Fprintf(os.Stderr, "%s not found\n", pkgs[i])
+		}
+	}
+}
+
+func findPackages(m *modfile.File, pkgs []string) ([]Package, []bool) {
+	var pkgVers []Package
+	pkgFound := make([]bool, len(pkgs))
 	for _, r := range m.Require {
-		for i, p := range flag.Args() {
+		for i, p := range pkgs {
 			if !compareRequire(p, r.Mod.Path) {
 				continue
 			}
 
-			found[i] = true
-			modPath := r.Mod.Path + " "
-			if *onlyVersion {
-				modPath = ""
-			}
-			fmt.Fprintln(os.Stdout, modPath+r.Mod.Version)
+			pkgVers = append(pkgVers, Package{Path: r.Mod.Path, Version: r.Mod.Version})
+			pkgFound[i] = true
 		}
 	}
 
-	for i, f := range found {
-		if !f {
-			fmt.Fprintf(os.Stderr, "%s not found\n", flag.Args()[i])
-		}
-	}
+	return pkgVers, pkgFound
 }
 
 // compareRequire compares module path with a string
@@ -126,7 +151,7 @@ func printUsage(w io.Writer) func() {
 // printError prints an error message and exits
 func printError(s string, err error, with ...bool) {
 	if err == nil {
-		fmt.Fprintf(os.Stderr, s+"\n\n")
+		fmt.Fprint(os.Stderr, s+"\n\n")
 	} else {
 		fmt.Fprintf(os.Stderr, s+": %s\n\n", err)
 	}