use cobra and makefile

Author: pjdufour

Makefile

@@ -0,0 +1,36 @@
+# =================================================================
+#
+# Copyright (C) 2019 Spatial Current, Inc. - All Rights Reserved
+# Released as open source under the MIT License.  See LICENSE file.
+#
+# =================================================================
+
+bin/gotmpl_darwin_amd64:
+	GOOS=darwin GOARCH=amd64 go build -o bin/gotmpl_darwin_amd64 $$(go list ./...)
+
+bin/gotmpl_linux_amd64:
+	GOOS=linux GOARCH=amd64 go build -o bin/gotmpl_linux_amd64 $$(go list ./...)
+
+bin/gotmpl_windows_amd64.exe:
+	GOOS=windows GOARCH=amd64 go build -o bin/gotmpl_windows_amd64.exe $$(go list ./...)
+
+bin/gotmpl_linux_arm64:
+	GOOS=linux GOARCH=arm64 go build -o bin/gotmpl_linux_arm64 $$(go list ./...)
+
+build: \
+bin/gotmpl_darwin_amd64 \
+bin/gotmpl_linux_amd64 \
+bin/gotmpl_windows_amd64.exe \
+bin/gotmpl_linux_arm64
+
+fmt:
+	go fmt $$(go list ./... )
+
+install:
+	go install $$(go list ./...)
+
+test:
+	bash scripts/test.sh
+
+clean:
+	rm -fr bin

README.md

@@ -10,7 +10,7 @@
 
 No installation is required.  Just grab a [release](https://github.com/spatialcurrent/gotmpl/releases).  You might want to rename your binary to just `gotmpl` for convenience.
 
-If you do have go already installed, you can just run using `go run main.go` or install with `bash scripts/install.sh`
+If you do have go already installed, you can just run using `go run main.go` or install with `make install`
 
 # Usage
 
@@ -38,6 +38,10 @@ echo '{{ .PATH | split ":" | set | array | sort | join ":" }}' | gotmpl
 echo '{{ with $items := .data | parse "csv" }}<table style="text-align:left;font-size:16px;"><tr><th>Time</th><th>Title</th>{{ range $items }}<tr><td>{{ .Time }}</td><td>{{ .Title }}</td></tr>{{ end }}</table>{{ end }}' | data=$(cat timetable.csv) gotmpl
 ```
 
+# Testing
+
+Run tests with `make test` (or `bash scripts/test.sh`), which runs unit tests, `go vet`, `go vet with shadow`, [errcheck](https://github.com/kisielk/errcheck), [ineffassign](https://github.com/gordonklaus/ineffassign), [staticcheck](https://staticcheck.io/), and [misspell](https://github.com/client9/misspell).
+
 # Contributing
 
 [Spatial Current, Inc.](https://spatialcurrent.io) is currently accepting pull requests for this repository.  We'd love to have your contributions!  Please see [Contributing.md](https://github.com/spatialcurrent/gotmpl/blob/master/CONTRIBUTING.md) for how to get started.

main.go

@@ -17,37 +17,15 @@ import (
 
 import (
 	"github.com/pkg/errors"
+	"github.com/spf13/cobra"
 )
 
 import (
 	"github.com/spatialcurrent/go-adaptive-functions/af"
 	"github.com/spatialcurrent/go-simple-serializer/gss"
 )
 
-func main() {
-
-	fi, err := os.Stdin.Stat()
-	if err != nil {
-		panic(err)
-	}
-
-	if fi.Mode()&os.ModeNamedPipe == 0 && !fi.Mode().IsRegular() {
-		fmt.Println("Usage: TEMPLATE_TEXT | gotmpl")
-		fmt.Println("Usage: gotmpl < TEMPLATE_FILE")
-		return
-	}
-
-	text, err := ioutil.ReadAll(os.Stdin)
-	if err != nil {
-		panic(err)
-	}
-
-	ctx := map[string]string{}
-	for _, str := range os.Environ() {
-		parts := strings.SplitN(str, "=", 2)
-		ctx[parts[0]] = parts[1]
-	}
-
+func initFunctions() map[string]interface{} {
 	funcs := map[string]interface{}{
 		"parse": func(args ...interface{}) (interface{}, error) {
 			if len(args) != 2 {
@@ -75,6 +53,7 @@ func main() {
 			return nil, errors.New("invalid arguments for parse " + fmt.Sprint(args))
 		},
 	}
+
 	for _, f := range af.Functions {
 		f := f
 		for _, alias := range f.Aliases {
@@ -88,13 +67,60 @@ func main() {
 		}
 	}
 
-	tmpl, err := template.New("main").Funcs(funcs).Parse(string(text))
-	if err != nil {
-		panic(err)
+	return funcs
+}
+
+func main() {
+	cmd := &cobra.Command{
+		Use:                   "gotmpl [k=v]... < template_file",
+		DisableFlagsInUseLine: true,
+		Short:                 "gotmpl",
+		Long:                  `gotmpl is a super simple command line program for rendering templates that uses environment variables and command line arguments as its context variables.  The template is read from stdin.`,
+		RunE: func(cmd *cobra.Command, args []string) error {
+
+			fi, err := os.Stdin.Stat()
+			if err != nil {
+				return err
+			}
+
+			if fi.Mode()&os.ModeNamedPipe == 0 && !fi.Mode().IsRegular() {
+				return cmd.Usage()
+			}
+
+			text, err := ioutil.ReadAll(os.Stdin)
+			if err != nil {
+				return err
+			}
+
+			ctx := map[string]string{}
+
+			// load context from environment variables
+			for _, str := range os.Environ() {
+				parts := strings.SplitN(str, "=", 2)
+				ctx[parts[0]] = parts[1]
+			}
+
+			// load context from command line arguments
+			for _, str := range args {
+				parts := strings.SplitN(str, "=", 2)
+				ctx[parts[0]] = parts[1]
+			}
+
+			tmpl, err := template.New("main").Funcs(initFunctions()).Parse(string(text))
+			if err != nil {
+				return err
+			}
+
+			err = tmpl.Execute(os.Stdout, ctx)
+			if err != nil {
+				return err
+			}
+
+			return nil
+		},
 	}
 
-	err = tmpl.Execute(os.Stdout, ctx)
-	if err != nil {
+	if err := cmd.Execute(); err != nil {
 		panic(err)
 	}
 }

scripts/build_cli.sh

@@ -1,20 +1,34 @@
 #!/bin/bash
+
+# =================================================================
+#
+# Copyright (C) 2019 Spatial Current, Inc. - All Rights Reserved
+# Released as open source under the MIT License.  See LICENSE file.
+#
+# =================================================================
+
 DIR="$( cd "$( dirname "${BASH_SOURCE[0]}" )" && pwd )"
 set -eu
 cd $DIR/..
-pkgs=$(go list ./... )
+pkgs=$(go list ./... | grep -v /vendor/ | tr "\n" " ")
 echo "******************"
-echo "Running unit tests for: "
-for pkg in "${pkgs[@]}"; do
-   go test -p 1 -count 1 -short $pkgs
-done
+echo "Running unit tests"
+go test -p 1 -count 1 -short $pkgs
 echo "******************"
-echo "Using gometalinter with misspell, vet, ineffassign, and gosec"
-gometalinter \
---misspell-locale=US \
---disable-all \
---enable=misspell \
---enable=vet \
---enable=ineffassign \
---enable=gosec \
-./...
+echo "Running go vet"
+go vet $pkgs
+echo "******************"
+echo "Running go vet with shadow"
+go vet -vettool=$(which shadow) $pkgs
+echo "******************"
+echo "Running errcheck"
+errcheck ${pkgs}
+echo "******************"
+echo "Running ineffassign"
+find . -name '*.go' | xargs ineffassign
+echo "******************"
+echo "Running staticcheck"
+staticcheck -checks all ${pkgs}
+echo "******************"
+echo "Running misspell"
+misspell -locale US -error *.md *.go