migrated from package cli to flag for toml2json

Author: rsdoiel

cmd/toml2json/toml2json.go

@@ -21,31 +21,77 @@ package main
 
 import (
 	"encoding/json"
+	"flag"
 	"fmt"
 	"io"
 	"os"
+	"path"
+	"strings"
 
 	// CaltechLibrary packages
-	"github.com/caltechlibrary/cli"
 	"github.com/caltechlibrary/datatools"
 
 	// 3rd Party packages
 	"github.com/BurntSushi/toml"
 )
 
 var (
-	description = `
-%s is a tool that converts TOML into JSON output.
-`
+	helpText = `---
+title: "{app_name} (1) user manual"
+author: "R. S. Doiel"
+pubDate: 2023-01-09
+---
+
+# NAME
+ 
+{app_name}
+
+# SYNOPSIS
+
+{app_name} [OPTIONS] [TOML_FILENAME] [JSON_NAME]
+
+# DESCRIPTION
+
+{app_name} is a tool that converts TOML into JSON. It operates
+on standard input and writes to standard output.
+
+# OPTIONS
+
+-help
+: display help
+
+-license
+: display license
+
+-version
+: display version
+
+-nl, -newline
+: if true add a trailing newline
+
+-o, -output
+: output filename
+
+-p, -pretty
+: pretty print output
+
+-quiet
+: suppress error messages
+
+
+# EXAMPLES
 
-	examples = `
 These would get the file named "my.toml" and save it as my.json
 
-    %s my.toml > my.json
+~~~
+    {app_name} my.toml > my.json
 
-    %s my.toml my.json
+    {app_name} my.toml my.json
 
-	cat my.toml | %s -i - > my.json
+	cat my.toml | {app_name} -i - > my.json
+~~~
+
+{app_name} {version}
 `
 
 	// Standard Options
@@ -65,6 +111,10 @@ These would get the file named "my.toml" and save it as my.json
 	prettyPrint bool
 )
 
+func fmtTxt(src string, appName string, version string) string {
+	return strings.ReplaceAll(strings.ReplaceAll(src, "{app_name}", appName), "{version}", version)
+}
+
 func toml2JSON(in io.Reader, out io.Writer, printPrint bool) error {
 	var (
 		src []byte
@@ -85,35 +135,27 @@ func toml2JSON(in io.Reader, out io.Writer, printPrint bool) error {
 }
 
 func main() {
-	app := cli.NewCli(datatools.Version)
-	appName := app.AppName()
-
-	// Add Help Docs
-	app.AddHelp("license", []byte(fmt.Sprintf(datatools.LicenseText, appName, datatools.Version)))
-	app.AddHelp("description", []byte(fmt.Sprintf(description, appName)))
-	app.AddHelp("examples", []byte(fmt.Sprintf(examples, appName, appName, appName)))
-
-	// Document non-option parameters
-	app.SetParams("[TOML_FILENAME]", "[JSON_NAME]")
+	appName := path.Base(os.Args[0])
 
 	// Standard Options
-	app.BoolVar(&showHelp, "h,help", false, "display help")
-	app.BoolVar(&showLicense, "l,license", false, "display license")
-	app.BoolVar(&showVersion, "v,version", false, "display version")
-	app.BoolVar(&showExamples, "examples", false, "display example(s)")
-	//app.StringVar(&inputFName, "i,input", "", "input filename")
-	app.StringVar(&outputFName, "o,output", "", "output filename")
-	app.BoolVar(&quiet, "quiet", false, "suppress error messages")
-	app.BoolVar(&generateMarkdown, "generate-markdown", false, "generate markdown documentation")
-	app.BoolVar(&generateManPage, "generate-manpage", false, "generate man page")
-	app.BoolVar(&newLine, "nl,newline", false, "if true add a trailing newline")
+	flag.BoolVar(&showHelp, "help", false, "display help")
+	flag.BoolVar(&showLicense, "license", false, "display license")
+	flag.BoolVar(&showVersion, "version", false, "display version")
+
+	flag.StringVar(&outputFName, "o", "", "output filename")
+	flag.StringVar(&outputFName, "output", "", "output filename")
+	flag.BoolVar(&quiet, "quiet", false, "suppress error messages")
+	
+	flag.BoolVar(&newLine, "nl", false, "if true add a trailing newline")
+	flag.BoolVar(&newLine, "newline", false, "if true add a trailing newline")
 
 	// App Specific Options
-	app.BoolVar(&prettyPrint, "p,pretty", false, "pretty print output")
+	flag.BoolVar(&prettyPrint, "p", false, "pretty print output")
+	flag.BoolVar(&prettyPrint, "pretty", false, "pretty print output")
 
 	// Parse env and options
-	app.Parse()
-	args := app.Args()
+	flag.Parse()
+	args := flag.Args()
 
 	// Handle case of input/output filenames provided without -i, -o
 	if len(args) > 0 {
@@ -125,46 +167,51 @@ func main() {
 
 	// Setup IO
 	var err error
-	app.Eout = os.Stderr
 
-	app.In, err = cli.Open(inputFName, os.Stdin)
-	cli.ExitOnError(app.Eout, err, quiet)
-	defer cli.CloseFile(inputFName, app.In)
+	in := os.Stdin
+	out := os.Stdout
+	eout := os.Stderr
 
-	app.Out, err = cli.Create(outputFName, os.Stdout)
-	cli.ExitOnError(app.Eout, err, quiet)
-	defer cli.CloseFile(outputFName, app.Out)
 
-	// Process options
-	if generateMarkdown {
-		app.GenerateMarkdown(app.Out)
-		os.Exit(0)
-	}
-	if generateManPage {
-		app.GenerateManPage(app.Out)
-		os.Exit(0)
+	if inputFName != "" {
+		in, err = os.Open(inputFName)
+		if err != nil {
+			fmt.Fprintln(eout, err)
+			os.Exit(1)
+		}
+		defer in.Close()
 	}
-	if showHelp || showExamples {
-		if len(args) > 0 {
-			fmt.Fprintln(app.Out, app.Help(args...))
-		} else {
-			app.Usage(app.Out)
+	
+	if outputFName != "" {
+		out, err = os.Create(outputFName)
+		if err != nil {
+			fmt.Fprintln(eout, err)
+			os.Exit(1)
 		}
+		defer out.Close()
+	}
+
+	// Process options
+	if showHelp {
+		fmt.Fprintf(out, "%s\n", fmtTxt(helpText, appName, datatools.Version))
 		os.Exit(0)
 	}
 	if showLicense {
-		fmt.Fprintln(app.Out, app.License())
+		fmt.Fprintf(out, "%s\n", datatools.LicenseText)
 		os.Exit(0)
 	}
 	if showVersion {
-		fmt.Fprintln(app.Out, app.Version())
+		fmt.Fprintf(out, "%s %s\n", appName, datatools.Version)
 		os.Exit(0)
 	}
 	if newLine {
 		eol = "\n"
 	}
 
-	err = toml2JSON(app.In, app.Out, prettyPrint)
-	cli.ExitOnError(app.Eout, err, quiet)
-	fmt.Fprintf(app.Out, "%s", eol)
+	err = toml2JSON(in, out, prettyPrint)
+	if err != nil {
+		fmt.Fprintln(eout, err)
+		os.Exit(1)
+	}
+	fmt.Fprintf(out, "%s", eol)
 }

toml2json.1.md

@@ -1,32 +1,56 @@
+---
+title: "{app_name} (1) user manual"
+author: "R. S. Doiel"
+pubDate: 2023-01-09
+---
 
-USAGE: toml2json [OPTIONS] [TOML_FILENAME] [JSON_NAME]
+# NAME
+ 
+{app_name}
 
-DESCRIPTION
+# SYNOPSIS
 
-toml2json is a tool that converts TOML into JSON output.
+{app_name} [OPTIONS] [TOML_FILENAME] [JSON_NAME]
 
-OPTIONS
+# DESCRIPTION
 
-    -examples            display example(s)
-    -generate-manpage    generate man page
-    -generate-markdown   generate markdown documentation
-    -h, -help            display help
-    -l, -license         display license
-    -nl, -newline        if true add a trailing newline
-    -o, -output          output filename
-    -p, -pretty          pretty print output
-    -quiet               suppress error messages
-    -v, -version         display version
+{app_name} is a tool that converts TOML into JSON. It operates
+on standard input and writes to standard output.
 
+# OPTIONS
 
-EXAMPLES
+-help
+: display help
+
+-license
+: display license
+
+-version
+: display version
+
+-nl, -newline
+: if true add a trailing newline
+
+-o, -output
+: output filename
+
+-p, -pretty
+: pretty print output
+
+-quiet
+: suppress error messages
+
+
+# EXAMPLES
 
 These would get the file named "my.toml" and save it as my.json
 
-    toml2json my.toml > my.json
+~~~
+    {app_name} my.toml > my.json
 
-    toml2json my.toml my.json
+    {app_name} my.toml my.json
 
-	cat my.toml | toml2json -i - > my.json
+	cat my.toml | {app_name} -i - > my.json
+~~~
 
-toml2json 1.2.1
+{app_name} {version}