Skip to content

Project Templates #1

@devnote-dev

Description

@devnote-dev

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:

# 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.

-- 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.

Metadata

Metadata

Assignees

Labels

enhancementNew feature or requesthelp wantedExtra attention is needed

Projects

No projects

Milestone

No milestone

Relationships

None yet

Development

No branches or pull requests

Issue actions