Add support for json output format #49
Merged
Conversation
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
g4s8
requested changes
Jan 7, 2025
render/templates.go
Outdated
| @@ -31,6 +32,10 @@ var tplFuncs = map[string]any{ | |||
| } | |||
| return sum | |||
| }, | |||
| "marshal": func(v any) string { | |||
| a, _ := json.Marshal(v) | |||
There was a problem hiding this comment.
Looks like here a fatal error can occur. We need to panic here and recover on render caller.
There was a problem hiding this comment.
I think we can return an error along with string result instead of panic.
- add an example for json format - update marshal function to return an error
|
Thanks for your feedback! I've added json format to |
g4s8
reviewed
Jan 9, 2025
_examples/simple/doc.json
Outdated
| @@ -0,0 +1 @@ | |||
| [{"env_name":"HOST","doc":"Hosts name of hosts to listen on.","env_default":"","env_separator":";","required":true,"expand":false,"non_empty":false,"from_file":false},{"env_name":"PORT","doc":"Port to listen on.","env_default":"","env_separator":"","required":true,"expand":false,"non_empty":true,"from_file":false},{"env_name":"DEBUG","doc":"Debug mode enabled.","env_default":"false","env_separator":"","required":false,"expand":false,"non_empty":false,"from_file":false},{"env_name":"PREFIX","doc":"Prefix for something.","env_default":"","env_separator":"","required":false,"expand":false,"non_empty":false,"from_file":false}] | |||
There was a problem hiding this comment.
I think it could be more readable with indentations (it could be set in json encoder), it seems here we don't need size optimization, since the size of the documentation can't be big enough.
And what do you think about omitting empty fields? E.g. envDefault and envSeparator?
There was a problem hiding this comment.
That makes sense. I've added omitempty tag for all bool fields as well.
g4s8
approved these changes
Jan 9, 2025
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
Sometimes it needs to export documentation for envs in JSON format for further automation.
This PR supports a new output format
json.