Try setups for inlining the version

Author: zph

.config/brew/Formula/.gitkeep

@@ -1 +1,3 @@
 /bin/polylint
+
+dist/

.gitignore

@@ -0,0 +1,116 @@
+# This is an example .goreleaser.yml file with some sensible defaults.
+# Make sure to check the documentation at https://goreleaser.com
+
+# The lines below are called `modelines`. See `:help modeline`
+# Feel free to remove those if you don't want/need to use them.
+# yaml-language-server: $schema=https://goreleaser.com/static/schema.json
+# vim: set ts=2 sw=2 tw=0 fo=cnqoj
+
+version: 1
+
+before:
+  hooks:
+    # You may remove this if you don't use go modules.
+    - go mod tidy
+    # you may remove this if you don't need go generate
+    - go generate ./...
+
+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
+
+archives:
+  - format: tar.gz
+    # this name template makes the OS and Arch compatible with the results of `uname`.
+    name_template: >-
+      {{ .ProjectName }}_
+      {{- title .Os }}_
+      {{- if eq .Arch "amd64" }}x86_64
+      {{- else if eq .Arch "386" }}i386
+      {{- else }}{{ .Arch }}{{ end }}
+      {{- if .Arm }}v{{ .Arm }}{{ end }}
+    # use zip for windows archives
+    format_overrides:
+      - goos: windows
+        format: zip
+
+changelog:
+  sort: asc
+  filters:
+    exclude:
+      - "^docs:"
+      - "^test:"
+
+brews:
+  - name: polylint
+
+    # Git author used to commit to the repository.
+    commit_author:
+      name: goreleaserbot
+      email: [email protected]
+
+    # The project name and current git tag are used in the format string.
+    #
+    # Templates: allowed
+    commit_msg_template: "Brew formula update for {{ .ProjectName }} version {{ .Tag }}"
+
+    # Directory inside the repository to put the formula.
+    directory: .config/brew/Formula
+
+    # Your app's homepage.
+    homepage: "https://github.com/zph/polylint"
+
+    # Your app's description.
+    #
+    # Templates: allowed
+    description: "Polylint: Extensible generic linter"
+
+    # SPDX identifier of your app's license.
+    license: "MIT"
+
+    # Custom block for brew.
+    # Can be used to specify alternate downloads for devel or head releases.
+    custom_block: |
+      head "https://github.com/zph/polylint.git"
+
+    # So you can `brew test` your formula.
+    #
+    # Template: allowed
+    test: |
+      system "#{bin}/polylint --version"
+
+    # Repository to push the generated files to.
+    repository:
+      # Repository owner.
+      # Templates: allowed
+      owner: zph
+
+      # Repository name.
+      #
+      # Templates: allowed
+      name: polylint
+
+      # Optionally a branch can be provided.
+      #
+      # Default: default repository branch
+      # Templates: allowed
+      branch: main
+
+      # Sets up pull request creation instead of just pushing to the given branch.
+      # Make sure the 'branch' property is different from base before enabling
+      # it.
+      #
+      # Since: v1.17
+      pull_request:
+        # Whether to enable it or not.
+        enabled: true
+
+        # Whether to open the PR as a draft or not.
+        #
+        # Since: v1.19
+        draft: true

.goreleaser.yaml

@@ -22,3 +22,6 @@ test-watch:
 
 benchmark:
 	hyperfine --ignore-failure -- "./bin/polylint --config examples/simple.yaml run ~/src/runbook"
+
+build-dry-run:
+	goreleaser release --clean --skip publish

Makefile

@@ -39,4 +39,10 @@
   - [ ] JSON reporter
 - [ ] Configurable logging (log levels for debugging and k/v log values)
 - [ ] Add `init` command to create a default named config file
+- [ ] Remove panics that are poor programming style
 - [ ] Add testing for config files... lines, path
+- [ ] Setup goreleaser for releases
+  - [ ] Setup version bumper
+  - [ ] Ensure version is embedded into cobra cli and available for --version
+- [ ] Add way to pipe to exec process and non-zero exit is a failing to provide builtin, js, exec mechanisms
+- [ ] Setup version reading https://goreleaser.com/cookbooks/using-main.version/

TODO.md

@@ -11,6 +11,12 @@ import (
 	"github.com/spf13/viper"
 )
 
+var (
+	version = "unknown"
+	commit  = "none"
+	date    = "unknown"
+)
+
 var cfgFile string
 
 // rootCmd represents the base command when called without any subcommands
@@ -39,6 +45,7 @@ func Execute() {
 
 func init() {
 	cobra.OnInitialize(initConfig)
+	cobra.OnInitialize(setVersion)
 
 	// Here you will define your flags and configuration settings.
 	// Cobra supports persistent flags, which, if defined here,
@@ -51,6 +58,10 @@ func init() {
 	rootCmd.Flags().BoolP("toggle", "t", false, "Help message for toggle")
 }
 
+func setVersion() {
+	viper.Set("binary_version", version)
+}
+
 // initConfig reads in config file and ENV variables if set.
 func initConfig() {
 	if cfgFile != "" {

cmd/root.go

@@ -0,0 +1,40 @@
+/*
+Copyright © 2024 NAME HERE <EMAIL ADDRESS>
+*/
+package cmd
+
+import (
+	"fmt"
+
+	"github.com/spf13/cobra"
+	"github.com/spf13/viper"
+)
+
+// versionCmd represents the version command
+var versionCmd = &cobra.Command{
+	Use:   "version",
+	Short: "A brief description of your command",
+	Long: `A longer description that spans multiple lines and likely contains examples
+and usage of using your command. 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.`,
+	Run: func(cmd *cobra.Command, args []string) {
+		fmt.Printf("polylint version %s and %s, commit %s, built at %s", version, viper.GetString("binary_version"), commit, date)
+	},
+}
+
+func init() {
+	rootCmd.AddCommand(versionCmd)
+
+	// Here you will define your flags and configuration settings.
+
+	// Cobra supports Persistent Flags which will work for this command
+	// and all subcommands, e.g.:
+	// versionCmd.PersistentFlags().String("foo", "", "A help for foo")
+
+	// Cobra supports local flags which will only run when this command
+	// is called directly, e.g.:
+	// versionCmd.Flags().BoolP("toggle", "t", false, "Help message for toggle")
+}

cmd/version.go

@@ -1,6 +1,5 @@
 /*
-Copyright © 2024 NAME HERE <EMAIL ADDRESS>
-
+Copyright © 2024 Zander Hill <[email protected]>
 */
 package main
 

main.go

@@ -13,6 +13,7 @@ import (
 	"strings"
 
 	"github.com/dop251/goja"
+	"github.com/spf13/viper"
 	"golang.org/x/mod/semver"
 	"gopkg.in/yaml.v2"
 )
@@ -21,7 +22,6 @@ import (
 func extractIgnoresFromLine(line string, lineNo int, f *FileReport) error {
 	if strings.Contains(line, "polylint disable") {
 		chunks := strings.SplitN(line, "=", 2)
-		// chunks[0] = `# polylint disable.*` up to the equals sign
 		directive := strings.TrimSpace(strings.SplitN(chunks[0], "polylint", 2)[1])
 		ignoresStr := strings.TrimSpace(chunks[1])
 		if directive == "disable-for-file" {
@@ -108,14 +108,14 @@ func LoadConfigFile(content string) (ConfigFile, error) {
 	}
 
 	if !semver.IsValid(rawConfig.Version) {
-		fmt.Printf("Error: Config version %s is newer than binary version %s\n", rawConfig.Version, PolylintVersion)
+		fmt.Printf("Error: Config version %s is newer than binary version %s\n", rawConfig.Version, viper.GetString("binary_version"))
 		fmt.Println(semver.IsValid(rawConfig.Version))
 		panic("Invalid version due to semver incompatibility")
 	}
 
 	// If version file is too new for binary version
 	if semver.Compare(rawConfig.Version, PolylintVersion) == 1 {
-		fmt.Printf("Warning: config file version %s is newer than binary version %s\n", rawConfig.Version, PolylintVersion)
+		fmt.Printf("Warning: config file version %s is newer than binary version %s\n", rawConfig.Version, viper.GetString("binary_version"))
 	}
 
 	config.Version = rawConfig.Version