generated from kubernetes/kubernetes-template-project
-
Notifications
You must be signed in to change notification settings - Fork 65
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Add new command to list flags for documentation
Signed-off-by: Omer Aplatony <[email protected]>
- Loading branch information
Showing
5 changed files
with
70 additions
and
2 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,62 @@ | ||
| /* | ||
| Copyright 2024 The Kubernetes Authors. | ||
| Licensed under the Apache License, Version 2.0 (the "License"); | ||
| you may not use this file except in compliance with the License. | ||
| You may obtain a copy of the License at | ||
| http://www.apache.org/licenses/LICENSE-2.0 | ||
| Unless required by applicable law or agreed to in writing, software | ||
| distributed under the License is distributed on an "AS IS" BASIS, | ||
| WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. | ||
| See the License for the specific language governing permissions and | ||
| limitations under the License. | ||
| */ | ||
|
|
||
| package cmd | ||
|
|
||
| import ( | ||
| "fmt" | ||
| "os" | ||
|
|
||
| "github.com/olekukonko/tablewriter" | ||
| "github.com/spf13/cobra" | ||
| "github.com/spf13/pflag" | ||
| ) | ||
|
|
||
| var generateReadmeFlags = map[string]struct{}{ | ||
| "print": {}, | ||
| } | ||
|
|
||
| func newListFlagsCommand(rootCmd *cobra.Command) *cobra.Command { | ||
| return &cobra.Command{ | ||
| Use: "list-flags", | ||
| Short: "Lists all flags for documentation", | ||
| RunE: func(cmd *cobra.Command, args []string) error { | ||
| table := tablewriter.NewWriter(os.Stdout) | ||
| table.SetHeader([]string{"Flag", "Default Value", "Required", "Description"}) | ||
| printCommandFlags(rootCmd, table) | ||
| table.Render() | ||
| return nil | ||
| }, | ||
| } | ||
| } | ||
|
|
||
| func printCommandFlags(cmd *cobra.Command, table *tablewriter.Table) { | ||
| _, ok := generateReadmeFlags[cmd.Use] | ||
| if ok { | ||
| cmd.Flags().VisitAll(func(flag *pflag.Flag) { | ||
| table.Append([]string{ | ||
| flag.Name, | ||
| flag.DefValue, | ||
| fmt.Sprintf("%v", flag.NoOptDefVal == ""), | ||
| flag.Usage, | ||
| }) | ||
| }) | ||
| } | ||
|
|
||
| for _, subCmd := range cmd.Commands() { | ||
| printCommandFlags(subCmd, table) | ||
| } | ||
| } |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters