Merge pull request #11 from choria-io/4.1

(#4) allow reading cheats from an embeded fs

Author: ripienaar

README.md

@@ -26,7 +26,7 @@ Some historical points in time are kept:
  * Incorporate `github.com/alecthomas/units` and `github.com/alecthomas/template` as local packages
  * Changes to make `staticcheck` happy
  * A new default template that shortens the help on large apps, old default preserved as `KingpinDefaultUsageTemplate`
- * Integration with [cheat](https://github.com/cheat/cheat) (see below)
+ * Integration with [cheat](https://github.com/cheat/cheat) (see [below](#cheats))
 
 ## Cheats
 

app.go

@@ -3,6 +3,7 @@ package fisk
 import (
 	"fmt"
 	"io"
+	"io/fs"
 	"os"
 	"path/filepath"
 	"regexp"
@@ -358,7 +359,7 @@ func (a *Application) WithCheats(tags ...string) *Application {
 		dir   string
 	)
 
-	a.CheatCommand = a.Command("cheat", fmt.Sprintf("Shows cheats for %s", a.Name)).Action(func(pc *ParseContext) error {
+	a.CheatCommand = a.Commandf("cheat", "Shows cheats for %s", a.Name).Action(func(pc *ParseContext) error {
 		switch {
 		case dir != "":
 			return a.saveCheats(dir)
@@ -407,6 +408,14 @@ See https://github.com/cheat/cheat for more details`)
 	return a
 }
 
+// CheatFile reads a file from fs and use its contents to call Cheat(). Read errors are fatal.
+func (a *Application) CheatFile(fs fs.ReadFileFS, cheat string, file string) *Application {
+	body, err := fs.ReadFile(file)
+	a.FatalIfError(err, "cannot load cheat: %v", err)
+
+	return a.Cheat(cheat, string(body))
+}
+
 // Cheat sets the cheat help text to associate with this application,
 // the cheat is the name it will be surfaced as in help, if empty its the
 // name of the application.

app_test.go

@@ -2,6 +2,7 @@ package fisk
 
 import (
 	"bytes"
+	"embed"
 	"errors"
 	"io/ioutil"
 	"os"
@@ -576,3 +577,13 @@ func TestCommandf(t *testing.T) {
 	assert.Equal(t, x.help, "foo bar")
 	assert.Equal(t, y.help, "foo bar baz")
 }
+
+//go:embed doc.go
+var docFS embed.FS
+
+func TestCheatFile(t *testing.T) {
+	c := newTestApp().CheatFile(docFS, "", "doc.go")
+	c.Command("x", "x").CheatFile(docFS, "y", "doc.go")
+	assert.Contains(t, c.cheats["test"], "Package fisk provides")
+	assert.Contains(t, c.cheats["y"], "Package fisk provides")
+}

cmd.go

@@ -2,6 +2,7 @@ package fisk
 
 import (
 	"fmt"
+	"io/fs"
 	"strings"
 )
 
@@ -247,6 +248,14 @@ func newCommand(app *Application, name, help string) *CmdClause {
 	return c
 }
 
+// CheatFile reads a file from fs and use its contents to call Cheat(). Read errors are fatal.
+func (c *CmdClause) CheatFile(fs fs.ReadFileFS, cheat string, file string) *CmdClause {
+	body, err := fs.ReadFile(file)
+	c.app.FatalIfError(err, "cannot load cheat: %v", err)
+
+	return c.Cheat(cheat, string(body))
+}
+
 // Cheat sets the cheat help text to associate with this command,
 // the cheat is the name it will be surfaced as in help, if empty it's the
 // name of the command.