bumped version number, renamed GenerateMarkdownDocs() to GenerateMarkdown()

Author: R. S. Doiel

TODO.md

@@ -5,17 +5,20 @@
 
 ## Next
 
-+ [ ] Improve markdown to manpage conversion
-+ [ ] Implement default common sectins for "help" map that correspond to the tradtional Man page sections, the help map needs to indicate what "section" number it belongs to for generating man documentation
-
++ [ ] Update Makefile to match current practice (.e.g. website, assets, etc)
++ [ ] Merge pkgassets package into cli package.
++ [ ] Need to word wrap output of cli help, usage, etc. based on console width and height (via man support if running under Unix/Linux/Posix)
 
 ## Someday, Maybe
 
-+ [ ] Need to word wrap output of cli help, usage, etc. based on console width and height
 + [ ] See ...
 
 ## Completed
 
++ [x] Improve markdown to manpage conversion
++ [x] Implement default common sections for "help" map that correspond to the tradtional Man page sections, the help map needs to indicate what "section" number it belongs to for generating man documentation
+
+
 + [x] Environment processing stil doesn't feel right
     + Maybe have an EnvTYPE functions that adds the documentation and returns the value found or default, this would work like flag.StringVar() 
 + [x] add a way to format AppName into a text (e.g. DescriptionText, UsageText)

cli.go

@@ -31,13 +31,16 @@ import (
 	"time"
 )
 
-const Version = `v0.0.12`
+const Version = `v0.0.13`
 
+//
+// v0.0.13 renames func GenerateMarkdownDocs() to GenerateMarkdown()
+// to better match the GeneratgeManPage().
 //
 // v0.0.5 brings a more wholistic approach to building a cli
 // (command line interface), not just configuring one.
 //
-// Below are the new structs anda funcs that will remain after v0.0.6-dev
+// Below are the new structs and funcs that will remain after v0.0.6-dev
 //
 
 // Open accepts a filename, fallbackFile (usually os.Stdout, os.Stdin, os.Stderr) and returns

cmd/cligenerate/cligenerate.go

@@ -51,17 +51,17 @@ how to use the cli package.
 	bugs = `_cligenerator_ is only a proof of concept implementation`
 
 	// Standard Options
-	showHelp             bool
-	showLicense          bool
-	showVersion          bool
-	showExamples         bool
-	inputFName           string
-	outputFName          string
-	newLine              bool
-	quiet                bool
-	prettyPrint          bool
-	generateMarkdownDocs bool
-	generateManPage      bool
+	showHelp         bool
+	showLicense      bool
+	showVersion      bool
+	showExamples     bool
+	inputFName       string
+	outputFName      string
+	newLine          bool
+	quiet            bool
+	prettyPrint      bool
+	generateMarkdown bool
+	generateManPage  bool
 
 	// Application Options
 	appName             string
@@ -92,8 +92,8 @@ func main() {
 	app.BoolVar(&newLine, "nl,newline", false, "if true add a trailing newline")
 	app.BoolVar(&quiet, "quiet", false, "suppress error messages")
 	app.BoolVar(&prettyPrint, "p,pretty", false, "pretty print output")
-	app.BoolVar(&generateMarkdownDocs, "generate-markdown-docs", false, "output documentation in Markdown")
-	app.BoolVar(&generateManPage, "generate-manpage", false, "output man page")
+	app.BoolVar(&generateMarkdown, "generate-markdown", false, "generate markdown documentation")
+	app.BoolVar(&generateManPage, "generate-manpage", false, "generate man page")
 
 	// Application Options
 	app.StringVar(&appName, "app", "[YOUR APP NAME GOES HERE]", "set the name of your generated app (e.g. helloworld)")
@@ -122,8 +122,8 @@ func main() {
 	defer cli.CloseFile(outputFName, app.Out)
 
 	// Handle options
-	if generateMarkdownDocs {
-		app.GenerateMarkdownDocs(app.Out)
+	if generateMarkdown {
+		app.GenerateMarkdown(app.Out)
 		os.Exit(0)
 	}
 	if generateManPage {

generate.go

@@ -53,7 +53,7 @@ var (
 	newLine bool
 	quiet bool
 	prettyPrint bool
-	generateMarkdownDocs bool
+	generateMarkdown bool
 	generateManPage bool
 
 	// Application Options
@@ -86,7 +86,7 @@ func main() {
 	app.BoolVar(&newLine, "nl,newline", false, "if true add a trailing newline")
 	app.BoolVar(&quiet, "quiet", false, "suppress error messages")
 	app.BoolVar(&prettyPrint, "p,pretty", false, "pretty print output")
-	app.BoolVar(&generateMarkdownDocs, "generate-markdown-docs", false, "output documentation in Markdown")
+	app.BoolVar(&generateMarkdown, "generate-markdown", false, "generate Markdown documentation")
 	app.BoolVar(&generateManPage, "generate-manpage", false, "output manpage markup")
 
 	// Application Options
@@ -112,8 +112,8 @@ func main() {
 	defer cli.CloseFile(outputFName, app.Out)
 
 	// Handle options
-	if generateMarkdownDocs {
-		app.GenerateMarkdownDocs(app.Out)
+	if generateMarkdown {
+		app.GenerateMarkdown(app.Out)
 		os.Exit(0)
 	}
 	if generateManPage {

markdown.go

@@ -9,9 +9,10 @@ import (
 	"strings"
 )
 
-// GenerateMarkdownDocs writes a Markdown page to io.Writer provided. Documentation is based on
-// the application's metadata like app name, version, options, actions, etc.
-func (c *Cli) GenerateMarkdownDocs(w io.Writer) {
+// GenerateMarkdown writes a Markdown page to io.Writer provided.
+// Documentation is based on the application's metadata like app name,
+// version, options, actions, etc.
+func (c *Cli) GenerateMarkdown(w io.Writer) {
 	var parts []string
 	parts = append(parts, c.appName)
 	if len(c.options) > 0 {