Lib.rs

skeleton 💀

skeleton is a tool that makes it easier to start new projects.

It stores your commonly used project specific files in one place, letting you easily apply them to new projects.

The binary is called sk and has only been tested on a Unix-based system.

Demo

Installation

You can install the skeleton command-line utility via the rust package manager cargo:

cargo install skeleton-cli

...or you can build it from source:

git clone https://github.com/terror/skeleton
cd skeleton
cargo install --path .

Usage

In essence, a template is a file ending in .skeleton with a front-matter and content. The front-matter is structured YAML with effect and free variables.

An effect variable is pre-defined to perform some action. As of now, there are only 3 pre-defined variables of this type:

See subcommand.rs for further elaboration on these effect variables.

A free variable is used to substitute into the templates content, you can also specify whether or not to be interactively prompted for these types of variables when applying templates.

These types of variables follow a special kind of syntax when used within templates, for instance:

---
filename: rustfmt.toml
groups: [rust-cli]
tab_spaces: 2
---
edition = "2018"
max_width = 80
newline_style = "Unix"
tab_spaces = {% tab_spaces %}
use_field_init_shorthand = true
use_try_shorthand = true

Note that {% tab_spaces %} will replace to 2 when applying this template.

For more information, consult the help output of the command-line interface:

skeleton-cli 0.2.1
Liam <liam@scalzulli.com>
A project scaffolding utility

Usage: sk <COMMAND>

Commands:
  add     Add a new template
  apply   Apply a template
  edit    Edit an existing template
  list    List all templates
  remove  Remove an existing template
  rename  Rename an existing template
  help    Print this message or the help of the given subcommand(s)

Options:
  -h, --help     Print help
  -V, --version  Print version

Prior Art

skeleton is a re-implementation and improvement of the Python program I wrote a while back called bp, which you can find here.