feat(cli): add docs command #145
Merged
Conversation
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
- combines serialization and print code paths - splits huge formatter.go into scoped files - adds "required" indicator to print - adds support for u/int map values
# Conflicts: # pkg/format/config_props.go # pkg/format/field_info.go # pkg/format/format_colorize_nodes.go # pkg/format/node.go
Codecov Report
@@ Coverage Diff @@
## main #145 +/- ##
==========================================
- Coverage 68.67% 64.48% -4.19%
==========================================
Files 76 79 +3
Lines 2279 2427 +148
==========================================
Hits 1565 1565
- Misses 577 724 +147
- Partials 137 138 +1
Continue to review full report at Codecov.
|
cdc0c65 to
6e980b6
Compare
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.
Adds a CLI command that outputs configuration documentation for a service. This can be used to automate configuration field documentation for services.
Currently it supports terminal and markdown output.
Terminal output
Markdown output
Show
Config fields
Auth
SMTP authentication method
Default:
UnknownPossible values:
None,Plain,CRAMMD5,Unknown,OAuth2Encryption
Encryption method
Default:
AutoPossible values:
None,ExplicitTLS,ImplicitTLS,AutoFromAddress
e-mail address that the mail are sent from
Required
Aliases:
fromFromName
name of the sender
Default: empty
Host
SMTP server hostname or IP address
Required
Password
authentication password or hash
Default: empty
Port
SMTP server port, common ones are 25, 465, 587 or 2525
Default:
25Subject
the subject of the sent mail
Default:
Shoutrrr NotificationAliases:
titleToAddresses
list of recipient e-mails separated by "," (comma)
Required
Aliases:
toUseHTML
whether the message being sent is in HTML
Default:
NoUseStartTLS
attempt to use SMTP StartTLS encryption
Default:
YesUsername
authentication username
Default: empty