github/wp-plugin-go
0
0
Fork 0
mirror of https://github.com/thegeeklab/wp-plugin-go.git synced 2024-06-03 04:49:41 +02:00
Code Issues Releases Activity

fix: dont add none-plugin flags to docs (#46)

Browse Source
This commit is contained in:
Robert Kaussow 2024-01-01 18:07:31 +01:00 committed by GitHub
parent ae9066d3cc
commit ddde4d726e
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
2 changed files with 11 additions and 3 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

9
docs/docs.go
View File

@ -78,6 +78,7 @@ func prepareArgsWithValues(flags []cli.Flag) []*PluginArg {
func parseFlags(flags []cli.Flag) []*PluginArg { func parseFlags(flags []cli.Flag) []*PluginArg {
args := make([]*PluginArg, 0) args := make([]*PluginArg, 0)
namePrefix := "plugin_"
for _, f := range flags { for _, f := range flags {
flag, ok := f.(cli.DocGenerationFlag) flag, ok := f.(cli.DocGenerationFlag)
@ -87,10 +88,12 @@ func parseFlags(flags []cli.Flag) []*PluginArg {
modArg := &PluginArg{} modArg := &PluginArg{}
name := flag.GetEnvVars()[0] name := strings.ToLower(strings.TrimSpace(flag.GetEnvVars()[0]))
name = strings.TrimPrefix(name, "PLUGIN_") if !strings.HasPrefix(name, namePrefix) {
modArg.Name = strings.ToLower(strings.TrimSpace(name)) continue
}
modArg.Name = strings.TrimPrefix(name, namePrefix)
modArg.Description = flag.GetUsage() modArg.Description = flag.GetUsage()
modArg.Default = flag.GetDefaultText() modArg.Default = flag.GetDefaultText()

5
docs/docs_test.go
View File

@ -42,6 +42,11 @@ func testApp() *cli.App {
Usage: "slice flag", Usage: "slice flag",
EnvVars: []string{"PLUGIN_SLICE_FLAG"}, EnvVars: []string{"PLUGIN_SLICE_FLAG"},
}, },
&cli.StringFlag{
Name: "hidden.flag",
Usage: "hidden flag",
EnvVars: []string{"HIDDEN_FLAG", "PLUGIN_HIDDEN_FLAG"},
},
}, },
} }