Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/semibran/scaffy
:sparkles:tiny project scaffolding tool
https://github.com/semibran/scaffy
generator template
Last synced: 3 months ago
JSON representation
:sparkles:tiny project scaffolding tool
- Host: GitHub
- URL: https://github.com/semibran/scaffy
- Owner: semibran
- License: mit
- Created: 2018-03-01T09:36:10.000Z (almost 7 years ago)
- Default Branch: master
- Last Pushed: 2023-08-04T20:44:53.000Z (over 1 year ago)
- Last Synced: 2024-10-20T14:00:28.481Z (3 months ago)
- Topics: generator, template
- Language: JavaScript
- Homepage:
- Size: 25.4 KB
- Stars: 3
- Watchers: 2
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: readme.md
- License: license
Awesome Lists containing this project
README
# scaffy
This tool is a tiny project scaffolder that customizes a given template directory using a user-defined map.
Install it globally through npm:
```sh
npm i -g scaffy
```
The following represents an example directory to be used as a template. Notice the fields in double braces.
```
templates/module
├── lib
│ └── {{name}}.js -> ''
├── license -> ...
├── package.json -> '{ "name": "{{name}}", "description": "{{description}}" }'
└── readme.md -> '# {{name}}\n> {{description}}'
```
Passing this directory into scaffy will bring up a prompt that enables you to fill in the necessary fields.
```sh
$ scaffy templates/module
scaffy v3.0.3
Using template `module`
(1/2) name: example
(2/2) description: An example module
Write to `/foo/bar/example` successful
$ cat example/readme.md
# example
> An example module
$ ls example/lib
example.js
```
This concept can be further expanded upon to cover logic-less templates as large as you deem necessary.
## usage
[![npm badge]][npm package]
### CLI
```
usage:
$ scaffy [src] [options]
options:
-h, --help show this help message
-v, --version display package version
-i, --input path to source template (alias for )
-o, --output path to which the resulting file tree is written (defaults to name arg)
-O, --open tag indicating the beginning of an expression (defaults to "{{")
-C, --close tag indicating the end of an expression (defaults to "}}")
examples:
$ scaffy
$ scaffy templates/module -o new-directory
```
### API
#### `scaffy(src, opts, cb(err, tree))`
Replaces all instances of the keys provided by `opts.data` within `src`. The resulting file tree is passed to `cb` via `tree`, which takes the form `folder : { name : folder | file }`.
Options:
* `data`: map detailing the keys to be replaced within the given template and their corresponding values (defaults to an empty object)
* `dest`: path to which the resulting file tree is written (defaults to `src`)
* `open`: tag indicating the beginning of an expression (defaults to `{{`)
* `close`: tag indicating the end of an expression (defaults to `}}`)
## related
* [`semibran/fs-tree`][semibran/fs-tree]: underlying basis for this module's reads and writes
* [`jamen/pixie`][jamen/pixie]: flexible templating engine responsible for this module's replacement mechanism
[npm badge]: https://nodei.co/npm/scaffy.png?mini
[npm package]: https://npmjs.com/package/scaffy
[semibran/fs-tree]: https://github.com/semibran/fs-tree
[jamen/pixie]: https://github.com/jamen/pixie