skeletor
v0.0.5
Published
An opinionated skeleton for npm modules
Downloads
74
Readme
Skeletor
Skeletor is a cli tool for generating an opinionated blueprint for a Node.js module. It assumes you are using the following:
Skeltor will generate the following layout
.
├── bin
│ └── module_name.js
├── .gitignore
├── lib
│ └── module_name.js
├── Makefile
├── package.json
├── README.md
├── test
│ └── module_name.test.js
└── .travis.yml
Don't like the layout? Create your own fork and change to your liking.
Installation
npm -g install skeletor
Default values
Skeletor will try and read defaults to populate the package.json file from your .npmrc
and .gitconfig
files.
.gitconfig
[github]
user = shapeshed
.npmrc
init.author.name = George Ornbo
init.author.url = http://shapeshed.com
init.author.email = [email protected]
Usage
skeletor [module_name]
cd [module_name]
npm install
make test
Then you can start hacking on your module, create a GitHub repo and push it up.