https://github.com/terror/skeleton
💀 A project scaffolding utility
https://github.com/terror/skeleton
Last synced: 10 months ago
JSON representation
💀 A project scaffolding utility
- Host: GitHub
- URL: https://github.com/terror/skeleton
- Owner: terror
- License: cc0-1.0
- Created: 2023-05-12T04:01:36.000Z (over 2 years ago)
- Default Branch: master
- Last Pushed: 2024-07-21T18:11:34.000Z (over 1 year ago)
- Last Synced: 2025-03-14T22:03:20.572Z (10 months ago)
- Language: Rust
- Homepage:
- Size: 109 KB
- Stars: 1
- Watchers: 3
- Forks: 0
- Open Issues: 2
-
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING
- License: LICENSE
Awesome Lists containing this project
README
## skeleton 💀
[](https://github.com/terror/skeleton/actions/workflows/ci.yml)
[](https://crates.io/crates/skeleton-cli)
**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.
In essence, a **template** is a file ending in `.skeleton` with a front-matter and
content. The front-matter is structured
[YAML](https://en.wikipedia.org/wiki/YAML?useskin=vector) 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:
| Name | Type | Required | Description |
|--------------|------------|----------|---------------------------------------------------------------------------------------|
| `command` | String | No | A command to run on a template post-write. |
| `filename` | String | Yes | Specifies the name of the templates destination location during application. |
| `groups` | Sequence | No | Groups this template belongs to, used commonly when batch applying templates. |
See [subcommand.rs](https://github.com/terror/skeleton/blob/master/src/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.
The binary is called `sk` and has only been tested on a Unix-based machine.
### Demo
[](https://asciinema.org/a/rx0tWWfPTPZNXoBboE7dzX3tX)
### Installation
You can install the **skeleton** command-line utility via the rust package manager
[cargo](https://doc.rust-lang.org/cargo/):
```bash
cargo install skeleton-cli
```
...or you can build it from source:
```bash
git clone https://github.com/terror/skeleton
cd skeleton
cargo install --path .
```
### Usage
```present cargo run -- --help
Usage: sk
Commands:
add Add a new template
apply Apply a template
edit Edit an existing template
list List all templates
remove Remove an existing template
help Print this message or the help of the given subcommand(s)
Options:
-h, --help Print help
```
### 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](https://github.com/terror/bp).