feat: introduce version command (#11)

Author: ns-vasilev

.golangci.yml

@@ -0,0 +1,56 @@
+version: "2"
+
+linters:
+  default: none
+  enable:
+    - 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
+    - copyloopvar         # detects places where loop variables are copied (Go 1.22+)
+    - durationcheck       # checks for two durations multiplied together
+    - exptostd            # detects functions from golang.org/x/exp/ that can be replaced by std functions
+    - fatcontext          # detects nested contexts in loops
+    - gocheckcompilerdirectives  # validates go compiler directive comments (//go:)
+    - gochecksumtype      # checks exhaustiveness on Go "sum types"
+    - gocritic            # provides diagnostics that check for bugs, performance and style issues
+    - gomoddirectives     # manages the use of 'replace', 'retract', and 'excludes' directives in go.mod
+    - goprintffuncname    # checks that printf-like functions are named with f at the end
+    - 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
+    - nilerr              # finds the code that returns nil even if it checks that the error is not nil
+    - nolintlint          # reports ill-formed or insufficient nolint directives
+    - nosprintfhostport   # checks for misuse of Sprintf to construct a host with port in a URL
+    - reassign            # checks that package variables are not reassigned
+    - unused              # checks for unused constants, variables, functions and types
+    - gosec
+    - staticcheck
+    # To enable later due to too many issues, and confirm we need them:
+    # - errcheck
+
+  exclusions:
+    paths:
+      - third-party
+    rules:
+      - path: _test\.go$
+        linters:
+          - bodyclose
+          - gosec
+
+  settings:
+    gocritic:
+      disabled-checks:
+        - appendAssign
+      disabled-tags:
+        - style
+
+formatters:
+  enable:
+    - gofmt
+  exclusions:
+    paths:
+      - third-party
+
+issues:
+  max-issues-per-linter: 0
+  max-same-issues: 0

Makefile

@@ -1,5 +1,5 @@
 # Binary & paths
-BINARY_NAME     := deeplink
+BINARY_NAME     := linkctl
 CMD_DIR         := ./cmd
 BUILD_DIR       := build
 DIST_DIR        := dist

cmd/main.go

@@ -1,3 +1,12 @@
 package main
 
-func main() {}
+import (
+	"os"
+
+	"github.com/space-code/linkctl/internal/cmd"
+)
+
+func main() {
+	code := cmd.Main()
+	os.Exit(int(code))
+}

go.mod

@@ -1,3 +1,10 @@
 module github.com/space-code/linkctl
 
 go 1.26.0
+
+require github.com/spf13/cobra v1.10.2
+
+require (
+	github.com/inconshreveable/mousetrap v1.1.0 // indirect
+	github.com/spf13/pflag v1.0.9 // indirect
+)

go.sum

@@ -0,0 +1,10 @@
+github.com/cpuguy83/go-md2man/v2 v2.0.6/go.mod h1:oOW0eioCTA6cOiMLiUPZOpcVxMig6NIQQ7OS05n1F4g=
+github.com/inconshreveable/mousetrap v1.1.0 h1:wN+x4NVGpMsO7ErUn/mUI3vEoE6Jt13X2s0bqwp9tc8=
+github.com/inconshreveable/mousetrap v1.1.0/go.mod h1:vpF70FUmC8bwa3OWnCshd2FqLfsEA9PFc4w1p2J65bw=
+github.com/russross/blackfriday/v2 v2.1.0/go.mod h1:+Rmxgy9KzJVeS9/2gXHxylqXiyQDYRxCVz55jmeOWTM=
+github.com/spf13/cobra v1.10.2 h1:DMTTonx5m65Ic0GOoRY2c16WCbHxOOw6xxezuLaBpcU=
+github.com/spf13/cobra v1.10.2/go.mod h1:7C1pvHqHw5A4vrJfjNwvOdzYu0Gml16OCs2GRiTUUS4=
+github.com/spf13/pflag v1.0.9 h1:9exaQaMOCwffKiiiYk6/BndUBv+iRViNW+4lEMi0PvY=
+github.com/spf13/pflag v1.0.9/go.mod h1:McXfInJRrz4CZXVZOBLb0bTZqETkiAhM9Iw0y3An2Bg=
+go.yaml.in/yaml/v3 v3.0.4/go.mod h1:DhzuOOF2ATzADvBadXxruRBLzYTpT36CKvDb3+aBEFg=
+gopkg.in/check.v1 v0.0.0-20161208181325-20d25e280405/go.mod h1:Co6ibVJAznAaIkqp8huTwlJQCZ016jof/cbN4VW5Yz0=

internal/build/build.go

@@ -0,0 +1,11 @@
+package build
+
+import "runtime/debug"
+
+var Version = ""
+
+func init() {
+	if info, ok := debug.ReadBuildInfo(); ok && info.Main.Version != "(devel)" {
+		Version = info.Main.Version
+	}
+}

internal/cmd/cmd.go

@@ -0,0 +1,39 @@
+package cmd
+
+import (
+	"context"
+	"fmt"
+
+	"github.com/space-code/linkctl/internal/build"
+	"github.com/space-code/linkctl/pkg/cmd/factory"
+	"github.com/space-code/linkctl/pkg/cmd/root"
+)
+
+type exitCode int
+
+const (
+	exitOK    exitCode = 0
+	exitError exitCode = 1
+)
+
+func Main() exitCode {
+	buildVersion := build.Version
+
+	cmdFactory := factory.New(buildVersion)
+	stderr := cmdFactory.IOStreams.ErrOut
+
+	ctx := context.Background()
+
+	rootCmd, err := root.NewCmdRoot(cmdFactory, buildVersion)
+	if err != nil {
+		fmt.Fprintf(stderr, "failed to create root command: %s\n", err)
+		return exitError
+	}
+
+	if _, err := rootCmd.ExecuteContextC(ctx); err != nil {
+		fmt.Fprintf(stderr, "error: %s\n", err)
+		return exitError
+	}
+
+	return exitOK
+}

pkg/cmd/factory/default.go

@@ -0,0 +1,22 @@
+package factory
+
+import (
+	"github.com/space-code/linkctl/pkg/cmdutil"
+	"github.com/space-code/linkctl/pkg/iostreams"
+)
+
+func New(appVersion string) *cmdutil.Factory {
+	f := &cmdutil.Factory{
+		AppVersion:     appVersion,
+		ExecutableName: "linkctl",
+	}
+
+	f.IOStreams = ioStreams()
+
+	return f
+}
+
+func ioStreams() *iostreams.IOStreams {
+	io := iostreams.System()
+	return io
+}

pkg/cmd/root/root.go

@@ -0,0 +1,22 @@
+package root
+
+import (
+	versionCmd "github.com/space-code/linkctl/pkg/cmd/version"
+	"github.com/space-code/linkctl/pkg/cmdutil"
+	"github.com/spf13/cobra"
+)
+
+func NewCmdRoot(f *cmdutil.Factory, appVersion string) (*cobra.Command, error) {
+	cmd := &cobra.Command{
+		Use:   "linkctl",
+		Short: "Mobile Deep Link Debugger",
+		Long:  "linkctl - debug universal links, deeplinks, and app links.",
+		Annotations: map[string]string{
+			"versionInfo": versionCmd.Format(appVersion),
+		},
+	}
+
+	cmd.AddCommand(versionCmd.NewCmdVersion(f))
+
+	return cmd, nil
+}

pkg/cmd/version/version.go

@@ -0,0 +1,40 @@
+package version
+
+import (
+	"fmt"
+	"regexp"
+	"strings"
+
+	"github.com/space-code/linkctl/pkg/cmdutil"
+	"github.com/spf13/cobra"
+)
+
+func NewCmdVersion(f *cmdutil.Factory) *cobra.Command {
+	cmd := &cobra.Command{
+		Use:    "version",
+		Short:  "Show linkctl version information",
+		Hidden: true,
+		Run: func(cmd *cobra.Command, args []string) {
+			fmt.Fprint(f.IOStreams.Out, cmd.Root().Annotations["versionInfo"])
+		},
+	}
+
+	return cmd
+}
+
+func Format(version string) string {
+	version = strings.TrimPrefix(version, "v")
+
+	return fmt.Sprintf("linkctl version %s\n%s\n", version, changelogURL(version))
+}
+
+func changelogURL(version string) string {
+	path := "https://github.com/space-code/linkctl"
+	r := regexp.MustCompile(`^v?\d+\.\d+\.\d+(-[\w.]+)?$`)
+	if !r.MatchString(version) {
+		return fmt.Sprintf("%s/releases/latest", path)
+	}
+
+	url := fmt.Sprintf("%s/releases/tag/v%s", path, strings.TrimPrefix(version, "v"))
+	return url
+}