-
Notifications
You must be signed in to change notification settings - Fork 234
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Merge pull request #74 from CircleCI-Public/doc
Allow printing positional arguments in generated markdown docs
- Loading branch information
Showing
5 changed files
with
276 additions
and
7 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
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,212 @@ | ||
| //Copyright 2015 Red Hat Inc. All rights reserved. | ||
| // | ||
| // 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. | ||
|
|
||
| // nolint | ||
| package md_docs | ||
|
|
||
| import ( | ||
| "bytes" | ||
| "fmt" | ||
| "io" | ||
| "os" | ||
| "path/filepath" | ||
| "sort" | ||
| "strings" | ||
| "time" | ||
|
|
||
| "github.com/spf13/cobra" | ||
| ) | ||
|
|
||
| var introHeader = ` | ||
| [Readme](https://github.com/CircleCI-Public/circleci-cli#readme) | | ||
| [Code of Conduct](https://github.com/CircleCI-Public/circleci-cli/blob/master/CODE_OF_CONDUCT.md) | | ||
| [Contribution Guidelines](https://github.com/CircleCI-Public/circleci-cli/blob/master/CONTRIBUTING.md) | | ||
| [Hacking](https://github.com/CircleCI-Public/circleci-cli/blob/master/HACKING.md) | ||
| [](https://circleci.com/gh/CircleCI-Public/circleci-cli) | ||
| [](https://github.com/CircleCI-Public/circleci-cli/releases) | ||
| [](https://godoc.org/github.com/CircleCI-Public/circleci-cli) | ||
| [](https://codecov.io/gh/CircleCI-Public/circleci-cli) | ||
| [](./LICENSE) | ||
| ` | ||
|
|
||
| // PositionalArgs returns a slice of the given command's positional arguments | ||
| func PositionalArgs(cmd *cobra.Command) []string { | ||
| args := strings.Split(cmd.Use, " ") | ||
| if len(args) <= 1 { | ||
| return nil | ||
| } | ||
| return args[1:] | ||
| } | ||
|
|
||
| // FormatPositionalArg will format the positional arguments of a command from it's annotations. | ||
| func FormatPositionalArg(cmd *cobra.Command, arg string) string { | ||
| description, ok := cmd.Annotations[arg] | ||
| if !ok { | ||
| return "" | ||
| } | ||
| return fmt.Sprintf("%-11v %s\n", arg, description) | ||
| } | ||
|
|
||
| // Print the arguments with 11 characters of padding | ||
| func printArguments(buf *bytes.Buffer, command *cobra.Command, name string) error { | ||
| if len(command.Annotations) > 0 { | ||
| buf.WriteString("### Arguments\n\n```\n") | ||
| for _, arg := range PositionalArgs(command) { | ||
| buf.WriteString(FormatPositionalArg(command, arg)) | ||
| } | ||
| buf.WriteString("```\n\n") | ||
| } | ||
|
|
||
| return nil | ||
| } | ||
|
|
||
| func printFlags(buf *bytes.Buffer, cmd *cobra.Command, name string) error { | ||
| flags := cmd.NonInheritedFlags() | ||
| flags.SetOutput(buf) | ||
| if flags.HasAvailableFlags() { | ||
| buf.WriteString("### Flags\n\n```\n") | ||
| flags.PrintDefaults() | ||
| buf.WriteString("```\n\n") | ||
| } | ||
|
|
||
| parentFlags := cmd.InheritedFlags() | ||
| parentFlags.SetOutput(buf) | ||
| if parentFlags.HasAvailableFlags() { | ||
| buf.WriteString("### Flags inherited from parent commands\n\n```\n") | ||
| parentFlags.PrintDefaults() | ||
| buf.WriteString("```\n\n") | ||
| } | ||
| return nil | ||
| } | ||
|
|
||
| // GenMarkdown creates markdown output. | ||
| func GenMarkdown(cmd *cobra.Command, w io.Writer) error { | ||
| return GenMarkdownCustom(cmd, w, func(s string) string { return s }) | ||
| } | ||
|
|
||
| // GenMarkdownCustom creates custom markdown output. | ||
| func GenMarkdownCustom(cmd *cobra.Command, w io.Writer, linkHandler func(string) string) error { | ||
| cmd.InitDefaultHelpCmd() | ||
| cmd.InitDefaultHelpFlag() | ||
|
|
||
| buf := new(bytes.Buffer) | ||
| name := cmd.CommandPath() | ||
|
|
||
| short := cmd.Short | ||
| long := cmd.Long | ||
| if len(long) == 0 { | ||
| long = short | ||
| } | ||
|
|
||
| buf.WriteString("## " + name + "\n\n") | ||
| buf.WriteString(short + "\n\n") | ||
|
|
||
| if name == "circleci" { | ||
| buf.WriteString(introHeader + "\n\n") | ||
| } | ||
| buf.WriteString("### Synopsis\n\n") | ||
| buf.WriteString(long + "\n\n") | ||
|
|
||
| if cmd.Runnable() { | ||
| buf.WriteString(fmt.Sprintf("```\n%s\n```\n\n", cmd.UseLine())) | ||
| } | ||
|
|
||
| if len(cmd.Example) > 0 { | ||
| buf.WriteString("### Examples\n\n") | ||
| buf.WriteString(fmt.Sprintf("```\n%s\n```\n\n", cmd.Example)) | ||
| } | ||
|
|
||
| if err := printArguments(buf, cmd, name); err != nil { | ||
| return err | ||
| } | ||
|
|
||
| if err := printFlags(buf, cmd, name); err != nil { | ||
| return err | ||
| } | ||
| if hasSeeAlso(cmd) { | ||
| buf.WriteString("### SEE ALSO\n\n") | ||
| if cmd.HasParent() { | ||
| parent := cmd.Parent() | ||
| pname := parent.CommandPath() | ||
| link := pname + ".md" | ||
| link = strings.Replace(link, " ", "_", -1) | ||
| buf.WriteString(fmt.Sprintf("* [%s](%s)\t - %s\n", pname, linkHandler(link), parent.Short)) | ||
| cmd.VisitParents(func(c *cobra.Command) { | ||
| if c.DisableAutoGenTag { | ||
| cmd.DisableAutoGenTag = c.DisableAutoGenTag | ||
| } | ||
| }) | ||
| } | ||
|
|
||
| children := cmd.Commands() | ||
| sort.Sort(byName(children)) | ||
|
|
||
| for _, child := range children { | ||
| if !child.IsAvailableCommand() || child.IsAdditionalHelpTopicCommand() { | ||
| continue | ||
| } | ||
| cname := name + " " + child.Name() | ||
| link := cname + ".md" | ||
| link = strings.Replace(link, " ", "_", -1) | ||
| buf.WriteString(fmt.Sprintf("* [%s](%s)\t - %s\n", cname, linkHandler(link), child.Short)) | ||
| } | ||
| buf.WriteString("\n") | ||
| } | ||
| if !cmd.DisableAutoGenTag { | ||
| buf.WriteString("###### Auto generated by spf13/cobra on " + time.Now().Format("2-Jan-2006") + "\n") | ||
| } | ||
| _, err := buf.WriteTo(w) | ||
| return err | ||
| } | ||
|
|
||
| // GenMarkdownTree will generate a markdown page for this command and all | ||
| // descendants in the directory given. The header may be nil. | ||
| // This function may not work correctly if your command names have `-` in them. | ||
| // If you have `cmd` with two subcmds, `sub` and `sub-third`, | ||
| // and `sub` has a subcommand called `third`, it is undefined which | ||
| // help output will be in the file `cmd-sub-third.1`. | ||
| func GenMarkdownTree(cmd *cobra.Command, dir string) error { | ||
| identity := func(s string) string { return s } | ||
| emptyStr := func(s string) string { return "" } | ||
| return GenMarkdownTreeCustom(cmd, dir, emptyStr, identity) | ||
| } | ||
|
|
||
| // GenMarkdownTreeCustom is the the same as GenMarkdownTree, but | ||
| // with custom filePrepender and linkHandler. | ||
| func GenMarkdownTreeCustom(cmd *cobra.Command, dir string, filePrepender, linkHandler func(string) string) error { | ||
| for _, c := range cmd.Commands() { | ||
| if !c.IsAvailableCommand() || c.IsAdditionalHelpTopicCommand() { | ||
| continue | ||
| } | ||
| if err := GenMarkdownTreeCustom(c, dir, filePrepender, linkHandler); err != nil { | ||
| return err | ||
| } | ||
| } | ||
|
|
||
| basename := strings.Replace(cmd.CommandPath(), " ", "_", -1) + ".md" | ||
| filename := filepath.Join(dir, basename) | ||
| f, err := os.Create(filename) | ||
| if err != nil { | ||
| return err | ||
| } | ||
| defer f.Close() | ||
|
|
||
| if _, err := io.WriteString(f, filePrepender(filename)); err != nil { | ||
| return err | ||
| } | ||
| if err := GenMarkdownCustom(cmd, f, linkHandler); err != nil { | ||
| return err | ||
| } | ||
| return nil | ||
| } |
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,52 @@ | ||
| // Copyright 2015 Red Hat Inc. All rights reserved. | ||
| // | ||
| // 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. | ||
|
|
||
| // nolint | ||
| package md_docs | ||
|
|
||
| import ( | ||
| "strings" | ||
|
|
||
| "github.com/spf13/cobra" | ||
| ) | ||
|
|
||
| // Test to see if we have a reason to print See Also information in docs | ||
| // Basically this is a test for a parent commend or a subcommand which is | ||
| // both not deprecated and not the autogenerated help command. | ||
| func hasSeeAlso(cmd *cobra.Command) bool { | ||
| if cmd.HasParent() { | ||
| return true | ||
| } | ||
| for _, c := range cmd.Commands() { | ||
| if !c.IsAvailableCommand() || c.IsAdditionalHelpTopicCommand() { | ||
| continue | ||
| } | ||
| return true | ||
| } | ||
| return false | ||
| } | ||
|
|
||
| // Temporary workaround for yaml lib generating incorrect yaml with long strings | ||
| // that do not contain \n. | ||
| func forceMultiLine(s string) string { | ||
| if len(s) > 60 && !strings.Contains(s, "\n") { | ||
| s = s + "\n" | ||
| } | ||
| return s | ||
| } | ||
|
|
||
| type byName []*cobra.Command | ||
|
|
||
| func (s byName) Len() int { return len(s) } | ||
| func (s byName) Swap(i, j int) { s[i], s[j] = s[j], s[i] } | ||
| func (s byName) Less(i, j int) bool { return s[i].Name() < s[j].Name() } |