boiler
Boilerplate generator 🥘
Install
npm i -g @fn2/boiler
Run
mkdir new-project; cd new-project
boiler
Options
Option | Description | Default value |
---|---|---|
--source |
Generator source (boiler directory) | boiler |
--dest |
Generator destination (project directory) | process.cwd() |
--force |
Overwrite existing files in destination | false |
Structure
Boiler finds generator info in the source directory using the following glob patterns:
Glob | Description |
---|---|
prompts/*.js |
User input prompts |
actions/*/*.js |
Actions to perform |
generators/*.js |
Groups of prompts and actions |
projects/*.js |
Groups of generators |
plopfile.js |
Plop initializer |
See plop for more information on actions, prompts, and generators.
Make your own boiler
Copy the plopfile.js
to your own directory and specify the directory in the --source
option.
Development
Execute ./bin/test
to test a generator, then check the testProject
directory for output.
Use npm link
to execute boiler locally without releasing and installing.