Add versioned helper

Author: zph

.goreleaser.yaml

@@ -14,15 +14,17 @@ before:
     - go mod tidy
     # you may remove this if you don't need go generate
     - go generate ./...
+    - echo '{"version":"{{ .Version }}", "tag":"{{ .Tag }}", "commit":"{{ .Commit }}", "date":"{{ .Date }}"}' >> pkg/VERSION.json
+    - git add pkg/VERSION.json && git commit -m "Update VERSION.json"
 
 builds:
   - env: []
     goos:
       - linux
       - windows
       - darwin
-    ldflags: |
-      -s -w -X cmd.version={{.Version}} -X cmd.commit={{.Commit}} -X cmd.date={{.Date}} -X cmd.builtBy=goreleaser
+    ldflags:
+      - "-s -w -X 'github.com/zph/polylint/cmd.version={{.Version}}' -X 'github.com/zph/polylint/cmd.commit={{.Commit}}' -X 'github.com/zph/polylint/cmd.date={{.Date}}' -X 'github.com/zph/polylint/cmd.builtBy=goreleaser'"
 
 archives:
   - format: tar.gz

cmd/root.go

@@ -9,33 +9,23 @@ import (
 
 	"github.com/spf13/cobra"
 	"github.com/spf13/viper"
+	pkg "github.com/zph/polylint/pkg"
 )
 
 var (
-	version = "unknown"
-	commit  = "none"
-	date    = "unknown"
+	version = "v0.0.1"
+	commit  = ""
+	date    = ""
 )
 
 var cfgFile string
 
 // rootCmd represents the base command when called without any subcommands
 var rootCmd = &cobra.Command{
 	Use:   "polylint",
-	Short: "A brief description of your application",
-	Long: `A longer description that spans multiple lines and likely contains
-examples and usage of using your application. For example:
-
-Cobra is a CLI library for Go that empowers applications.
-This application is a tool to generate the needed files
-to quickly create a Cobra application.`,
-	// Uncomment the following line if your bare application
-	// has an action associated with it:
-	// Run: func(cmd *cobra.Command, args []string) { },
+	Short: "Polylint: Extensible generalized linter",
 }
 
-// Execute adds all child commands to the root command and sets flags appropriately.
-// This is called by main.main(). It only needs to happen once to the rootCmd.
 func Execute() {
 	err := rootCmd.Execute()
 	if err != nil {
@@ -44,22 +34,20 @@ func Execute() {
 }
 
 func init() {
+	rootCmd.Version = version
 	cobra.OnInitialize(initConfig)
 	cobra.OnInitialize(setVersion)
-
-	// Here you will define your flags and configuration settings.
-	// Cobra supports persistent flags, which, if defined here,
-	// will be global for your application.
+	rootCmd.SetVersionTemplate(fmt.Sprintf("polylint\nVersion: %s\nCommit: %s\nDate: %s\n", version, commit, date))
 
 	rootCmd.PersistentFlags().StringVar(&cfgFile, "config", "", "config file (default is $HOME/.polylint.yaml)")
-
-	// Cobra also supports local flags, which will only run
-	// when this action is called directly.
-	rootCmd.Flags().BoolP("toggle", "t", false, "Help message for toggle")
 }
 
 func setVersion() {
+	if version == "v0.0.1" {
+		version = pkg.LibMetadata.Version
+	}
 	viper.Set("binary_version", version)
+	rootCmd.Version = version
 }
 
 // initConfig reads in config file and ENV variables if set.
@@ -80,8 +68,7 @@ func initConfig() {
 
 	viper.AutomaticEnv() // read in environment variables that match
 
-	// If a config file is found, read it in.
-	if err := viper.ReadInConfig(); err == nil {
-		fmt.Fprintln(os.Stderr, "Using config file:", viper.ConfigFileUsed())
+	if err := viper.ReadInConfig(); err != nil {
+		fmt.Fprintln(os.Stderr, "Error reading config file:", viper.ConfigFileUsed())
 	}
 }

cmd/version.go

@@ -3,7 +3,9 @@ Copyright © 2024 Zander Hill <[email protected]>
 */
 package main
 
-import "github.com/zph/polylint/cmd"
+import (
+	"github.com/zph/polylint/cmd"
+)
 
 func main() {
 	cmd.Execute()

main.go

@@ -0,0 +1 @@
+{"version":"0.0.1-rc1-SNAPSHOT-a16c019", "tag":"v0.0.1-rc1", "commit":"a16c0192fd6b2c802fa9993c318e6db78c1ea4d6", "date":"2024-04-12T04:26:24Z"}

pkg/VERSION.json

@@ -0,0 +1,28 @@
+package polylint
+
+import (
+	"embed"
+	"encoding/json"
+)
+
+//go:embed VERSION.json
+var f embed.FS
+
+type Metadata struct {
+	Version string `json:"version"`
+	Tag     string `json:"tag"`
+	Commit  string `json:"commit"`
+	Date    string `json:"date"`
+}
+
+var LibMetadata Metadata
+
+func init() {
+
+	var LibMetadata Metadata
+
+	data, _ := f.ReadFile("VERSION.json")
+	if err := json.Unmarshal(data, &LibMetadata); err != nil {
+		panic(err)
+	}
+}