improve README and help
This commit is contained in:
parent
2a311facb0
commit
9d8d5d68ab
31
README.md
31
README.md
@ -1,6 +1,20 @@
|
|||||||
# spry
|
# spry
|
||||||
|
|
||||||
Basic [Sprig](https://masterminds.github.io/sprig/) Template Rendering.
|
Basic [Sprig](https://masterminds.github.io/sprig/) &
|
||||||
|
[Helm Templating Language (HTL)](https://helm.sh/docs/howto/charts_tips_and_tricks/#know-your-template-functions)
|
||||||
|
Template Rendering Tool.
|
||||||
|
|
||||||
|
It's design emulates how the `helm template` command runs, for rendering simple
|
||||||
|
Go Templates, Sprig extended Go Templates, or Helm Templating Language (HTL)
|
||||||
|
Templates, outside of a Helm Chart.
|
||||||
|
|
||||||
|
It takes provided templates and renders them using provided values.
|
||||||
|
|
||||||
|
### _ Files
|
||||||
|
|
||||||
|
Like with `helm template` template files whose names begins with `_` will not
|
||||||
|
produce output, but are used to provide common code used in other template
|
||||||
|
files.
|
||||||
|
|
||||||
## Usage Examples
|
## Usage Examples
|
||||||
|
|
||||||
@ -18,17 +32,20 @@ Usage of ./spry [Options] [Template Files]:
|
|||||||
-fp string
|
-fp string
|
||||||
Prefix for the filename in the output. (default "# ")
|
Prefix for the filename in the output. (default "# ")
|
||||||
-helm
|
-helm
|
||||||
Use Helm templating language (superset of Sprig).
|
Use the Helm Templating Language (HTL) (a superset of Sprig).
|
||||||
-helmDNS
|
-helmDNS
|
||||||
When using Helm Tpl Lang, support DNS resolution. (default true)
|
When using HTL, support DNS resolution. (default true)
|
||||||
-helmLint
|
-helmLin
|
||||||
When using Helm Tpl Lang, enable the Linting Mode.
|
When using HTL, enable the Linting Mode.
|
||||||
-helmNestValues
|
-helmNestValues
|
||||||
When using Helm Tpl Lang, Nest provided values under '.Values' (default true)
|
When using HTL, Nest provided values under '.Values' (default true)
|
||||||
-helmStrict
|
-helmStrict
|
||||||
When using Helm Tpl Lang, use strict rendering.
|
When using HTL, use strict rendering.
|
||||||
-set value
|
-set value
|
||||||
Set a specific value (foo.bar=spam)
|
Set a specific value (foo.bar=spam)
|
||||||
|
-v Print the version and exit.
|
||||||
|
-version
|
||||||
|
Print the version and exit.
|
||||||
|
|
||||||
Template Files can also be directories to recurse for templates.
|
Template Files can also be directories to recurse for templates.
|
||||||
|
|
||||||
|
10
main.go
10
main.go
@ -82,27 +82,27 @@ func init() {
|
|||||||
flag.BoolVar(
|
flag.BoolVar(
|
||||||
&flags.helm,
|
&flags.helm,
|
||||||
"helm", false,
|
"helm", false,
|
||||||
"Use Helm templating language (superset of Sprig).",
|
"Use the Helm Templating Language (HTL) (a superset of Sprig).",
|
||||||
)
|
)
|
||||||
flag.BoolVar(
|
flag.BoolVar(
|
||||||
&flags.helmStrict,
|
&flags.helmStrict,
|
||||||
"helmStrict", false,
|
"helmStrict", false,
|
||||||
"When using Helm Tpl Lang, use strict rendering.",
|
"When using HTL, use strict rendering.",
|
||||||
)
|
)
|
||||||
flag.BoolVar(
|
flag.BoolVar(
|
||||||
&flags.helmDNSFunc,
|
&flags.helmDNSFunc,
|
||||||
"helmDNS", true,
|
"helmDNS", true,
|
||||||
"When using Helm Tpl Lang, support DNS resolution.",
|
"When using HTL, support DNS resolution.",
|
||||||
)
|
)
|
||||||
flag.BoolVar(
|
flag.BoolVar(
|
||||||
&flags.helmLint,
|
&flags.helmLint,
|
||||||
"helmLint", false,
|
"helmLint", false,
|
||||||
"When using Helm Tpl Lang, enable the Linting Mode.",
|
"When using HTL, enable the Linting Mode.",
|
||||||
)
|
)
|
||||||
flag.BoolVar(
|
flag.BoolVar(
|
||||||
&flags.helmNestValues,
|
&flags.helmNestValues,
|
||||||
"helmNestValues", true,
|
"helmNestValues", true,
|
||||||
"When using Helm Tpl Lang, Nest provided values under '.Values'",
|
"When using HTL, Nest provided values under '.Values'",
|
||||||
)
|
)
|
||||||
flag.StringVar(
|
flag.StringVar(
|
||||||
&flags.outputFilenamePrefix,
|
&flags.outputFilenamePrefix,
|
||||||
|
Loading…
Reference in New Issue
Block a user