-
Notifications
You must be signed in to change notification settings - Fork 9
feat(cmd): add docs generator for cli #59
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Merged
Merged
Changes from all commits
Commits
Show all changes
6 commits
Select commit
Hold shift + click to select a range
42198ed
feat(cmd): add docs generator for cli
mabdh 7acb752
fix(cmd): docs
mabdh f291aca
fix(cmd): docs
mabdh b3cdaee
fix(cmd): backquote in ref
mabdh 83b91cb
fix(cmd): add option to use ansi term in cmd ref
mabdh 781c31b
feat(cmdx): add flag plain to ref command
mabdh File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or 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 hidden or 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,39 @@ | ||
| package cmdx | ||
|
|
||
| import ( | ||
| "os" | ||
| "path/filepath" | ||
|
|
||
| "github.com/spf13/cobra" | ||
| "github.com/spf13/cobra/doc" | ||
| ) | ||
|
|
||
| // GenerateMarkdownTree generate cobra cmd commands tree as markdown file | ||
| // rootOutputPath determines the folder where the markdown files are written | ||
| func GenerateMarkdownTree(rootOutputPath string, cmd *cobra.Command) error { | ||
| dirFilePath := filepath.Join(rootOutputPath, cmd.Name()) | ||
| if len(cmd.Commands()) != 0 { | ||
| if _, err := os.Stat(dirFilePath); os.IsNotExist(err) { | ||
| if err := os.Mkdir(dirFilePath, os.ModePerm); err != nil { | ||
| return err | ||
| } | ||
| } | ||
| for _, subCmd := range cmd.Commands() { | ||
| GenerateMarkdownTree(dirFilePath, subCmd) | ||
| } | ||
| } else { | ||
| outFilePath := filepath.Join(rootOutputPath, cmd.Name()) | ||
| outFilePath = outFilePath + ".md" | ||
|
|
||
| f, err := os.Create(outFilePath) | ||
| if err != nil { | ||
| return err | ||
| } | ||
|
|
||
| return doc.GenMarkdownCustom(cmd, f, func(s string) string { | ||
| return filepath.Join(dirFilePath, s) | ||
| }) | ||
| } | ||
|
|
||
| return nil | ||
| } | ||
This file contains hidden or 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 hidden or 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 hidden or 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
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
@mabdh do we want to generate a single markdown or multiple?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I think multiple markdowns would be easier to navigate via sidebar, wdyt @ravisuhag ?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
this is how the markdown shown in Siren
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
If we are showing it reference i think it better to show it single markdown. How about we make this as an option? Support both in salt.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Yes fair enough, we could also do that.