devnote-dev / devnote-dev/geode

Project Templates

オープン
#1 コメント 0 件 リアクション 0 件 担当者 1 名 @devnote-dev が担当を希望しています GitHub で見る
enhancement help wanted
主要言語
Crystal
スター
13
フォーク
3
PR マージ指標
30日以内にマージされた PR はありません

説明

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.

コントリビューションガイド

このリポジトリのコントリビューションガイドは索引されていません

評価

この issue はまだ評価されていません。

新しい issue をメールで受け取る

初心者向けの GitHub issue を短くまとめたダイジェスト。