devstream
devstream copied to clipboard
:four_leaf_clover: `Proposal`: Spec for templates, naming system
What Would You Like to Add? Why Is This Needed?
Currently we do not have strict rules for templates and naming, which leads to confusion in using them. After members' discussion, we make the following specification for future templates, naming.
During the development of the specification, we minimized the number of code changes.
Design
Global:
- Vars passing:
[[ VAR_NAME ]]
without template syntax. - Other templates(YAML template/Inside the plugin/...):
[[ ]]
with full template syntax. - Plugin
outputs
passing:${{PLUGIN.INTANCE_ID.outputs.OUTPUT_NAME}}
- Plugin config yaml:
lowerCamelCase
Spec for plugin repo-scaffolding
:
- Template library directory variables for
repo-scaffolding
plugins:[[ VAR_NAME ]]
without template syntax. - Template library template file suffix:
.tpl.suffix
Anything else
- Standardize existing code
- Documenting the spec
what if filename template, for example golang reposcaffolding use app_name for filename placeholder
what if filename template, for example golang reposcaffolding use app_name for filename placeholder
Perhaps it could be aligned with the directory variables?