feat: add custom usage

jar-b · May 26, 2021 · 50a6c05 · 50a6c05
1 parent 79c4ddc
commit 50a6c05
Show file tree

Hide file tree

Showing 2 changed files with 13 additions and 3 deletions.
diff --git a/README.md b/README.md
@@ -23,11 +23,13 @@ go get github.com/jar-b/mdtoc/cmd/mdtoc
 
 ```
 $ mdtoc -h
-Usage of mdtoc:
+Usage: mdtoc [flags] [filename]
+
+Flags:
   -dry-run
-        print generated contents, but do not write to file (optional)
+    	print generated contents, but do not write to file (optional)
   -force
-        force overwrite of existing contents (optional)
+    	force overwrite of existing contents (optional)
 ```
 
 Examples:

diff --git a/cmd/mdtoc/main.go b/cmd/mdtoc/main.go
@@ -13,6 +13,14 @@ var (
 	force, dryRun bool
 )
 
+func init() {
+	// slightly better usage output
+	flag.Usage = func() {
+		fmt.Fprintf(flag.CommandLine.Output(), "Usage: %s [flags] [filename]\n\nFlags:\n", os.Args[0])
+		flag.PrintDefaults()
+	}
+}
+
 func main() {
 	flag.BoolVar(&force, "force", false, "force overwrite of existing contents (optional)")
 	flag.BoolVar(&dryRun, "dry-run", false, "print generated contents, but do not write to file (optional)")