set up linting and fix some lint

Signed-off-by: Elliot Murphy <statik@users.noreply.github.com>

Author: statik

.golangci.yml

@@ -20,8 +20,6 @@ linters-settings:
     min-occurrences: 3
   lll:
     line-length: 120
-  maligned:
-    suggest-new: true
   misspell:
     locale: US
   funlen:
@@ -34,6 +32,15 @@ linters:
     # prealloc is not recommended by `golangci-lint` developers.
     - prealloc
     - gochecknoglobals
+    - interfacer
+    - scopelint
+    - maligned
+    - forbidigo
+    - gochecknoinits
+    - exhaustivestruct
+    - testpackage
+    - ifshort
+    - gofumpt
 
 run:
   skip-files:

BUILD.bazel

@@ -21,8 +21,8 @@ go_library(
 go_binary(
     name = "vbs-linux",
     embed = [":go_default_library"],
-    goos = "linux",
     goarch = "amd64",
+    goos = "linux",
     visibility = ["//visibility:public"],
     x_defs = {
         "version": VERSION,
@@ -32,8 +32,8 @@ go_binary(
 go_binary(
     name = "vbs-darwin",
     embed = [":go_default_library"],
-    goos = "darwin",
     goarch = "amd64",
+    goos = "darwin",
     visibility = ["//visibility:public"],
     x_defs = {
         "version": VERSION,
@@ -43,8 +43,8 @@ go_binary(
 go_binary(
     name = "vbs-windows",
     embed = [":go_default_library"],
-    goos = "windows",
     goarch = "amd64",
+    goos = "windows",
     visibility = ["//visibility:public"],
     x_defs = {
         "version": VERSION,
@@ -125,3 +125,17 @@ sh_binary(
     tags = ["manual"],
     visibility = ["//visibility:public"],
 )
+
+sh_binary(
+    name = "lint",
+    srcs = ["lint.sh"],
+    args = [
+        "$(location @bazel_gazelle//cmd/gazelle)",
+    ],
+    data = [
+        "@bazel_gazelle//cmd/gazelle",
+        "@go_sdk//:files",
+    ],
+    tags = ["manual"],
+    visibility = ["//visibility:public"],
+)

cmd/chapters.go

@@ -46,7 +46,6 @@ var chapterSplitCmd = &cobra.Command{
 }
 
 func chapterSplit(cmd *cobra.Command, args []string) {
-
 	_, err := exec.LookPath("ffprobe")
 
 	if err != nil {
@@ -67,6 +66,10 @@ func chapterSplit(cmd *cobra.Command, args []string) {
 	}
 
 	data, err := getChapters(target)
+	if err != nil {
+		log.Fatal().Err(err).Msg("Could not extract chapters")
+	}
+
 	base := strings.Trim(path.Base(target), path.Ext(target))
 	targetdir := fmt.Sprintf("split_%s", base)
 	err = os.MkdirAll(targetdir, 0777)
@@ -79,18 +82,19 @@ func chapterSplit(cmd *cobra.Command, args []string) {
 
 	for _, c := range data.Chapters {
 		wg.Add(1)
+
 		go copyChapter(&wg, c, target, targetdir)
 	}
 
 	wg.Wait()
 }
 
-func copyChapter(wg *sync.WaitGroup, c chapter, sourcefile, targetdir string) error {
+func copyChapter(wg *sync.WaitGroup, c chapter, sourcefile, targetdir string) {
 	defer wg.Done()
 
 	title := strings.Trim(c.Tags.Title, " \n\r")
 	safetitle := sanitize.Name(title)
-	prefix := fmt.Sprintf("%03d_", c.Id)
+	prefix := fmt.Sprintf("%03d_", c.ID)
 	outfile := filepath.Join(targetdir, prefix+safetitle+path.Ext(sourcefile))
 
 	cmd := exec.Command("ffmpeg",
@@ -107,8 +111,6 @@ func copyChapter(wg *sync.WaitGroup, c chapter, sourcefile, targetdir string) er
 	if err != nil {
 		log.Error().Err(err).Msgf("%s: %s\n", outfile, output)
 	}
-
-	return err
 }
 
 // sample json output
@@ -135,7 +137,7 @@ type tags struct {
 type chapter struct {
 	StartTime string `json:"start_time"`
 	EndTime   string `json:"end_time"`
-	Id        int    `json:"id"`
+	ID        int    `json:"id"`
 	Tags      tags   `json:"tags"`
 }
 
@@ -154,16 +156,19 @@ func getChapters(target string) (ffmprobeResponse, error) {
 	response := ffmprobeResponse{}
 
 	if err != nil {
-		return response, err
+		return response, fmt.Errorf("could not probe chapters: %w", err)
 	}
 
 	err = json.Unmarshal(output, &response)
 
-	return response, err
+	if err != nil {
+		return response, fmt.Errorf("failed unmarshaling ffprobe response: %w", err)
+	}
+
+	return response, nil
 }
 
 func chapterList(cmd *cobra.Command, args []string) {
-
 	_, err := exec.LookPath("ffprobe")
 
 	if err != nil {
@@ -191,7 +196,7 @@ func chapterList(cmd *cobra.Command, args []string) {
 
 	formattedJSON, err := json.MarshalIndent(data, "", "    ")
 	if err != nil {
-		log.Fatal().Err(err).Msg("Trouble marshalling to JSON")
+		log.Fatal().Err(err).Msg("Trouble marshaling to JSON")
 	}
 
 	_, _ = os.Stdout.Write(formattedJSON)

cmd/ivs.go

@@ -38,7 +38,7 @@ var ivsPutMetadataCmd = &cobra.Command{
 	Short: "Send payload to IVS PutMetadata.",
 	Long:  `Send messages to IVS using PutMetadata API.`,
 	Run:   ivsPutMetadata,
-	Args:  cobra.ExactArgs(2),
+	Args:  cobra.ExactArgs(2), //nolint:gomnd // this is an appropriate magic number
 }
 
 func ivsOscBridge(cmd *cobra.Command, args []string) {
@@ -51,7 +51,7 @@ func ivsOscBridge(cmd *cobra.Command, args []string) {
 	svc := ivs.New(s)
 
 	d := osc.NewStandardDispatcher()
-	d.AddMsgHandler("/vbs/ivsbridge", func(msg *osc.Message) {
+	_ = d.AddMsgHandler("/vbs/ivsbridge", func(msg *osc.Message) {
 		log.Debug().Msg(msg.String())
 		data := fmt.Sprintf("%v", msg.Arguments[0])
 		input := &ivs.PutMetadataInput{
@@ -70,8 +70,7 @@ func ivsOscBridge(cmd *cobra.Command, args []string) {
 		Dispatcher: d,
 	}
 
-	err := server.ListenAndServe()
-	if err != nil {
+	if err := server.ListenAndServe(); err != nil {
 		log.Error().Err(err).Msg("error from server.ListenAndServe")
 	}
 }

cmd/root.go

@@ -29,10 +29,10 @@ import (
 
 var cfgFile string
 
-// Debug controls whether or not debug messages should be printed
+// Debug controls whether or not to enable debug level logging.
 var Debug bool
 
-// rootCmd represents the base command when called without any subcommands
+// rootCmd represents the base command when called without any subcommands.
 var rootCmd = &cobra.Command{
 	Version: "dev",
 	Use:     "vbs",
@@ -59,6 +59,7 @@ use at your own risk.
 // This is called by main.main(). It only needs to happen once to the rootCmd.
 func Execute(v string) {
 	rootCmd.SetVersionTemplate(v)
+
 	if err := rootCmd.Execute(); err != nil {
 		log.Error().Err(err).Msg("error running root command")
 		os.Exit(1)
@@ -67,6 +68,7 @@ func Execute(v string) {
 
 func init() {
 	zerolog.TimeFieldFormat = time.RFC3339
+
 	if isatty.IsTerminal(os.Stdout.Fd()) {
 		output := zerolog.ConsoleWriter{Out: os.Stderr}
 		log.Logger = log.With().Caller().Logger().Output(output)

lint.sh

@@ -0,0 +1,14 @@
+#!/usr/bin/env bash
+set -eo pipefail
+
+export RUNFILES_DIR="$PWD"/..
+export PATH="$PWD/external/go_sdk/bin:$PATH"
+gazelle="$PWD/$1"
+
+echo "Using these commands"
+command -v golangci-lint
+echo "$gazelle"
+
+cd "$BUILD_WORKSPACE_DIRECTORY"
+
+golangci-lint run

main.go

@@ -18,7 +18,7 @@ import (
 	"github.com/kindlyops/vbs/cmd"
 )
 
-// these are filled out as linker flags by bazel
+// these are filled out as linker flags by bazel.
 var (
 	version = "dev"
 )

main_test.go

@@ -17,7 +17,7 @@ func TestMain(m *testing.M) {
 	os.Exit(m.Run())
 }
 
-// Make sure that the x_defs override is working with the bazel build
+// Make sure that the x_defs override is working with the bazel build.
 func TestDefaultVersion(t *testing.T) {
 	t.Parallel()
 
@@ -37,18 +37,21 @@ func TestCLIVersion(t *testing.T) {
 	if _, err = os.Stat(path); os.IsNotExist(err) {
 		t.Fatalf("Missing binary %v", path)
 	}
+
 	file, err := filepath.EvalSymlinks(path)
 	if err != nil {
 		t.Fatalf("Invalid filename %v", path)
 	}
+
 	cmd := exec.Command(file, "--version")
 	cmd.Stderr = os.Stderr
+
 	res, err := cmd.Output()
 	if err != nil {
 		t.Fatalf("failed running '%v': %v", path, err)
 	}
-	output := strings.TrimSpace(string(res))
 
+	output := strings.TrimSpace(string(res))
 	if output != "dev.bazel version" {
 		t.Error("Expected", "dev.bazel version", "got", output)
 	}