Instead of using comments declare info in a special variable.
Then the variable can be used to print the DNS API provider usage.
The usage can be parsed on UI and show all needed inputs for options.
The info is stored in plain string that it's both human-readable and easy to parse:
dns_example_info='API name
An extended description.
Multiline.
Domains: list of alternative domains to find
Site: the dns provider website e.g. example.com
Docs: Link to ACME.sh wiki for the provider
Options:
VARIABLE1 Title for the option1.
VARIABLE2 Title for the option2. Default "default value".
VARIABLE3 Title for the option3. Description to show on UI. Optional.
Issues: Link to a support ticket on https://github.com/acmesh-official/acme.sh
Author: First Lastname <authoremail@example.com>, Another Author <https://github.com/example>;
'
Here:
VARIABLE1 will be required.
VARIABLE2 will be required too but will be populated with a "default value".
VARIABLE3 is optional and can be empty.
A DNS provider may have alternative options like CloudFlare may use API KEY or API Token.
You can use a second section OptionsAlt: section.
Some providers may have alternative names or domains e.g. Aliyun and AlibabaCloud.
Add them to Domains: section.
Signed-off-by: Sergey Ponomarev <stokito@gmail.com>
message:
SC2034: $VARNAME appears unused. Verify it or export it.
most of these are related to the style:
we generate global vars, which are used in other functions.
the var "lexical_url" was really unused (left it as comment)
the travis-check now does not need anymore special flags.
Signed-off-by: Bastian Bittorf <bb@npl.de>
"Don't use [] around ranges in tr, it replaces literal square brackets."
this introduces another warning:
"Use '[:lower:]' to support accents and foreign alphabets."
This is more a style thingy because we really want to only catch A-Z.
work around this by using a shellcheck-directive and a comment
that the [:lower:] will not work with e.g. busybox-ash.
if we later really want to use [:lower:], we should use 'sed' for that.
Sergey Ponomarev
neil
Maarten den Braber
neilpang
Silvan Raijer
Jens Reimann
Oldřich Jedlička
neilpang
Bastian Bittorf
root
neil