feat: linting (#105)

* feat: linting

Signed-off-by: jmeridth <jmeridth@gmail.com>
Co-authored-by: Eddie Knight <knight@linux.com>

* fix: handle some errors, because we should

thanks copilot

Signed-off-by: jmeridth <jmeridth@gmail.com>
Co-authored-by: Eddie Knight <knight@linux.com>

---------

Signed-off-by: jmeridth <jmeridth@gmail.com>
Co-authored-by: Eddie Knight <knight@linux.com>

Author: jmeridth

.github/workflows/lint.yml

@@ -0,0 +1,25 @@
+name: lint
+on:
+  push:
+    branches:
+      - main
+  pull_request:
+  workflow_dispatch:
+
+permissions:
+  contents: read
+  pull-requests: read
+
+jobs:
+  lint:
+    name: lint
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4.2.2
+      - uses: actions/setup-go@v5.4.0
+        with:
+          go-version: stable
+      - name: golangci-lint
+        uses: golangci/golangci-lint-action@1481404843c368bc19ca9406f87d6e0fc97bdcfd
+        with:
+          version: v2.0.2

cmd/generate-plugin.go

@@ -39,10 +39,10 @@ func init() {
 	genPluginCmd.PersistentFlags().StringP("service-name", "n", "", "The name of the service (e.g. 'ECS, AKS, GCS').")
 	genPluginCmd.PersistentFlags().StringP("output-dir", "o", "generated-plugin/", "Pathname for the generated plugin.")
 
-	viper.BindPFlag("source-path", genPluginCmd.PersistentFlags().Lookup("source-path"))
-	viper.BindPFlag("local-templates", genPluginCmd.PersistentFlags().Lookup("local-templates"))
-	viper.BindPFlag("service-name", genPluginCmd.PersistentFlags().Lookup("service-name"))
-	viper.BindPFlag("output-dir", genPluginCmd.PersistentFlags().Lookup("output-dir"))
+	_ = viper.BindPFlag("source-path", genPluginCmd.PersistentFlags().Lookup("source-path"))
+	_ = viper.BindPFlag("local-templates", genPluginCmd.PersistentFlags().Lookup("local-templates"))
+	_ = viper.BindPFlag("service-name", genPluginCmd.PersistentFlags().Lookup("service-name"))
+	_ = viper.BindPFlag("output-dir", genPluginCmd.PersistentFlags().Lookup("output-dir"))
 
 	rootCmd.AddCommand(genPluginCmd)
 }
@@ -95,7 +95,10 @@ func setupTemplatingEnvironment() error {
 		TemplatesDir = viper.GetString("local-templates")
 	} else {
 		TemplatesDir = filepath.Join(os.TempDir(), "privateer-templates")
-		setupTemplatesDir()
+		err := setupTemplatesDir()
+		if err != nil {
+			return fmt.Errorf("error setting up templates directory: %w", err)
+		}
 	}
 
 	OutputDir = viper.GetString("output-dir")
@@ -159,7 +162,12 @@ func generateFileFromTemplate(data CatalogData, templatePath, OutputDir string)
 		return fmt.Errorf("error creating output file %s: %w", outputPath, err)
 	}
 
-	defer outputFile.Close()
+	defer func() {
+		err := outputFile.Close()
+		if err != nil {
+			logger.Error("error closing output file %s: %w", outputPath, err)
+		}
+	}()
 
 	err = tmpl.Execute(outputFile, data)
 	if err != nil {

cmd/install.go

@@ -21,5 +21,5 @@ var installCmd = &cobra.Command{
 
 func init() {
 	installCmd.PersistentFlags().BoolP("store", "s", false, "Github repo to source the plugin from.")
-	viper.BindPFlag("store", installCmd.PersistentFlags().Lookup("store"))
+	_ = viper.BindPFlag("store", installCmd.PersistentFlags().Lookup("store"))
 }

cmd/list.go

@@ -2,6 +2,7 @@ package cmd
 
 import (
 	"fmt"
+	"log"
 	"path"
 	"strings"
 
@@ -20,28 +21,31 @@ var listCmd = &cobra.Command{
 	Short: "Consult the Charts! List all plugins that have been installed.",
 	Run: func(cmd *cobra.Command, args []string) {
 		if viper.GetBool("all") {
-			fmt.Fprintln(writer, "| Plugin \t | Available \t| Requested \t|")
+			_, _ = fmt.Fprintln(writer, "| Plugin \t | Available \t| Requested \t|")
 			for _, pluginPkg := range GetPlugins() {
-				fmt.Fprintf(writer, "| %s \t | %t \t| %t \t|\n", pluginPkg.Name, pluginPkg.Available, pluginPkg.Requested)
+				_, _ = fmt.Fprintf(writer, "| %s \t | %t \t| %t \t|\n", pluginPkg.Name, pluginPkg.Available, pluginPkg.Requested)
 			}
 		} else {
 			// list only the available plugins
-			fmt.Fprintln(writer, "| Plugin \t | Requested \t|")
+			_, _ = fmt.Fprintln(writer, "| Plugin \t | Requested \t|")
 			for _, pluginPkg := range GetPlugins() {
 				if pluginPkg.Available {
-					fmt.Fprintf(writer, "| %s \t | %t \t|\n", pluginPkg.Name, pluginPkg.Requested)
+					_, _ = fmt.Fprintf(writer, "| %s \t | %t \t|\n", pluginPkg.Name, pluginPkg.Requested)
 				}
 			}
 		}
-		writer.Flush()
+		err := writer.Flush()
+		if err != nil {
+			log.Printf("Error flushing writer: %v", err)
+		}
 	},
 }
 
 func init() {
 	rootCmd.AddCommand(listCmd)
 
 	listCmd.PersistentFlags().BoolP("all", "a", false, "Review the Fleet! List all plugins that have been installed or requested in the current config.")
-	viper.BindPFlag("all", listCmd.PersistentFlags().Lookup("all"))
+	_ = viper.BindPFlag("all", listCmd.PersistentFlags().Lookup("all"))
 }
 
 // GetRequestedPlugins returns a list of plugin names requested in the config

cmd/version.go

@@ -2,6 +2,7 @@ package cmd
 
 import (
 	"fmt"
+	"log"
 
 	"github.com/spf13/cobra"
 	"github.com/spf13/viper"
@@ -14,10 +15,13 @@ var versionCmd = &cobra.Command{
 	Long:  ``, // TODO
 	Run: func(cmd *cobra.Command, args []string) {
 		if viper.GetBool("verbose") {
-			fmt.Fprintln(writer, fmt.Sprintf("Version:\t%s", buildVersion))
-			fmt.Fprintln(writer, fmt.Sprintf("Commit:\t%s", buildGitCommitHash))
-			fmt.Fprintln(writer, fmt.Sprintf("Build Time:\t%s", buildTime))
-			writer.Flush()
+			_, _ = fmt.Fprintf(writer, "Version:\t%s\n", buildVersion)
+			_, _ = fmt.Fprintf(writer, "Commit:\t%s\n", buildGitCommitHash)
+			_, _ = fmt.Fprintf(writer, "Build Time:\t%s\n", buildTime)
+			err := writer.Flush()
+			if err != nil {
+				log.Printf("Error flushing writer: %v", err)
+			}
 		} else {
 			fmt.Println(buildVersion)
 		}