devnote-dev / devnote-dev/geode

Project Templates

Aberta
#1 0 comentários 0 reações 1 responsável Reivindicada por @devnote-dev Ver no GitHub
enhancement help wanted
Linguagem predominante
Crystal
Estrelas
13
Forks
3
Métricas de merge de PRs
Nenhum PR com merge em 30d

Descrição

Project templates will be an improved design of the existing `crystal init` command to build default and custom project file structures. An old, experimental concept of this exists in the project which doesn't have a clear design or structure. This issue provides the design and scope for this, with subsequent issues & PRs to follow the implementation.

### Project-level setup
###### (note: these are all mock concepts that probably need to be finalised).

In `shard.yml`: custom field `project-templates: path/to/dir`

In project directory:

```yaml
# templates.yml
namespace: root-name
author: ...
version: ...
source: ...
files:
- a/b/c
- d/e/f

templates:
- name: foo
control: path/to/control_file.lua
```

Control files will *control* how projects are setup according to the template. Scripts are executed in a Lua sandbox with limited functions.

```lua
-- control_file.lua
println "welcome to the setup"
print "enter your project name: "
name = get_str_input() -- also available: 'get_bool_input()' & 'get_int_input()'

make_dir "src"
write_file("src/" .. name .. ".cr")
...
```

Full list of functions TBD.

Guia de contribuição

Nenhum guia de contribuição indexado para este repositório

Avaliação

Esta issue ainda não foi avaliada.

Receba novas issues na sua caixa de entrada

Um resumo curto de issues do GitHub para quem está começando.