skeletor

An opinionated skeleton for npm modules

npm install skeletor
10 downloads in the last week
20 downloads in the last month

Skeletor

Skeletor

Skeletor is a cli tool for generating an opinionated blueprint for a Node.js module. It assumes you are using the following:

Run skeletor like this where [module_name] is the name of your module.

skeletor [module_name]

It will generate the following output.

.
├── bin
│   └── module_name.js
├── .gitignore
├── lib
│   └── module_name.js
├── 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 = george@shapeshed.com

Usage

skeletor [module_name]
cd [module_name]
npm install
npm test

Then you can start hacking on your module, create a GitHub repo and push it up.

npm loves you