abcxyz / abcxyz/abc

Config system for render template aliasing

Open
#46 6 comments 0 reactions 0 assignees View on GitHub
enhancement priority_low
Dominant language
Go
Stars
16
Forks
4
PR merge metrics
No merged PRs in 30d

Description

### TL;DR

For better demos, first time adoption, and user customization allow aliased templates.

Ideally this is a local config file that is checked by the CLI, there will be some section that is similar to:

abc.config
```
{
"aliases": [
["hello", "github.com/abcxyz/abc.git//examples/templates/render/hello_jupiter"],
["go", "github.com/mattrandallbecker/my_cool_go_starter_template"],
]
}
```

When you run render the cli would read that config and create a map of all the aliases, and if the template argument doesn't look like a path, check aliases.

This would benefit our documentation by being able to change from:
```
abc templates render \
github.com/abcxyz/abc.git//examples/templates/render/hello_jupiter
```
to
```
abc templates render hello
```

but more importantly allow me to create my aliases for common service templates without adding them to my zsh file.

### Detailed design

_No response_

### Alternatives considered

_No response_

### Additional information

_No response_

Contributor guide

Open the contributing guide

Assessment

This issue has not been assessed yet.

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.