From 777b332bb7072b4d998798be0940dce165416beb Mon Sep 17 00:00:00 2001
From: Link Dupont
Date: Wed, 18 Dec 2019 14:46:13 -0500
Subject: [PATCH] Use VisibleFlags during doc generation
Hidden commands are excluded during doc generation but hidden flags are
not. Using VisibleFlags() instead of the Flags slice fixes that.
Signed-off-by: Link Dupont
---
docs.go | 4 ++--
docs_test.go | 4 ++++
2 files changed, 6 insertions(+), 2 deletions(-)
diff --git a/docs.go b/docs.go
index a8f5de92e5..dc16fc82d4 100644
--- a/docs.go
+++ b/docs.go
@@ -48,8 +48,8 @@ func (a *App) writeDocTemplate(w io.Writer) error {
return t.ExecuteTemplate(w, name, &cliTemplate{
App: a,
Commands: prepareCommands(a.Commands, 0),
- GlobalArgs: prepareArgsWithValues(a.Flags),
- SynopsisArgs: prepareArgsSynopsis(a.Flags),
+ GlobalArgs: prepareArgsWithValues(a.VisibleFlags()),
+ SynopsisArgs: prepareArgsSynopsis(a.VisibleFlags()),
})
}
diff --git a/docs_test.go b/docs_test.go
index e52cf8bd31..e49dfbab9c 100644
--- a/docs_test.go
+++ b/docs_test.go
@@ -22,6 +22,10 @@ func testApp() *App {
Aliases: []string{"b"},
Usage: "another usage text",
},
+ &BoolFlag{
+ Name: "hidden-flag",
+ Hidden: true,
+ },
}
app.Commands = []*Command{{
Aliases: []string{"c"},