You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: docs/README.md
+14-10Lines changed: 14 additions & 10 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -34,16 +34,18 @@ Repository root
34
34
│ └── template-a.tpl
35
35
├── src
36
36
│ └── *
37
-
└── docs
37
+
├── docs
38
38
└── *
39
+
└── ...
39
40
```
40
41
41
-
`complate`writes the generated message to the stdout pipe.\
42
+
This way, the `complate`program is redistributed via the GIT repository. If that's not what you want, simply keep the binary in your machine. As long as the configuration file version number fits your installed program major version you're good to go.
42
43
Expecting the recommended folder structure, you should be able to simply run `./.complate/complate print | git commit -F -` in order to create a new standardized commit.
43
44
44
45
## General overview
45
46
46
-
The template itself can be declared as string inside the configuration file or as a reference to a file that contains the template. The template string can contain variables in handlebars syntax ( `{{ variable}}` ). All distinct variables must have a representation in the according section that then also defines on how to find the value for this variable.
47
+
The template itself can be declared as string inside the configuration file or as a reference to a file that contains the template. The template string can contain variables in handlebars syntax ( `{{ variable}}` ). All distinct variables must have a representation in the according section that then also defines on how to find the value for this variable.\
48
+
Pro tip: Variables are prompted in alphabetical order. Prefix you variable with `a`, `b`, `c` and such to generate a custom order.
47
49
48
50
## Technical documentation
49
51
@@ -66,7 +68,7 @@ Either one of the `backend+` flags (or both) MUST be enabled for `complate` to w
66
68
67
69
|Name|Short|Long|Description|
68
70
|-- |-- |-- |-- |
69
-
|Experimental|-e|--experimental|Activates experimental features that are not stable yet. All features that are marked as experimental are not referenced when keeping backwards compatibility inside one major version.|
71
+
|Experimental|-e|--experimental|Activates experimental features that are not stable yet. All features that are marked as experimental are ignored when keeping backwards compatibility inside one major version.|
70
72
71
73
### Commands
72
74
@@ -77,11 +79,12 @@ Either one of the `backend+` flags (or both) MUST be enabled for `complate` to w
77
79
|print|Prompts for the template, prompts for variable values and prints the data to `STDOUT`|stable|
78
80
79
81
### `print` command flags
80
-
|Name|Short|Long|Description|Status|
81
-
|-- |-- |-- |-- |-- |
82
-
|Config file path|-c|--config|The path to the configuration file that shall be used. This path can be relative or absolute. The default path is `./complate/config.yml`.|stable|
83
-
|Shell trust||--shell-trust|Enables the shell value provider for replacing template placeholders. Due to the potential security risk with this option, it is disabled by default. Possible values for this option are `none` (default), `prompt` and `ultimate`|stable|
84
-
|Backend|-b|--backend|Defines the backend for the user interaction.|`CLI` is stable. `UI` is experimental (feature = "backend+ui").|
82
+
83
+
|Name|Short|Long|Description|Remark|Status|
84
+
|-- |-- |-- |-- |-- |--|
85
+
|Config via file path|-c|--config|The path to the configuration file that shall be used. This path can be relative or absolute. The default path is `./.complate/config.yml`.|Can not be used in conjunction with the `pipe` argument.|stable|
86
+
|Shell trust||--shell-trust|Enables the shell value provider for replacing template placeholders. Due to the potential security risk with this option, it is disabled by default. Possible values for this option are `none` (default), `prompt` and `ultimate`||stable|
87
+
|Backend|-b|--backend|Defines the backend for the user interaction.||`CLI` is stable. `UI` is experimental (feature = "backend+ui").
85
88
86
89
### Configuration file
87
90
@@ -91,6 +94,7 @@ version: 0.6
91
94
templates:
92
95
default:
93
96
content:
97
+
file: ./.complate/templates/template-a.tpl
94
98
inline: |-
95
99
{{ a.summary }} | {{ e.version }}
96
100
Components: [{{ f.components }}]
@@ -125,7 +129,7 @@ templates:
125
129
- misc
126
130
127
131
```
128
-
This project also uses complate templates that can be found in `./complate/config.yml`.
132
+
This project also uses complate. The templates that can be found in `./complate/config.yml`.
0 commit comments