module-starter

a cli tool to help you start a new node module

Installation

$ [sudo] npm install module-starter -g

Preview

See the output of this module here

Check out the cli branch here

Usage

Bootstrap a new module repository with these steps:

• Clone your repository

• run npm init with your preferred values (if no package json is found, this module will run npm init -y for you)

• run module-starter in the folder

CLI

$ module-starter
 
   module-starter 0.0.0 - a cli tool to help you start a new node module
     
   USAGE
 
     module-starter [path]
 
   ARGUMENTS
 
     [path]      Directory to initialize      optional      default: "/path/to/cwd"
 
   OPTIONS
 
     -c, --cli      Initialize a CLI module          optional      default: false
     --readme       Should overwrite the readme      optional      default: true
 
   GLOBAL OPTIONS
 
     -h, --help         Display help                                      
     -V, --version      Display version                                   
     --no-color         Disable colors                                    
     --quiet            Quiet mode - only displays warn and error messages
     -v, --verbose      Verbose mode - will also output debug messages    
 

Example

git clone https://github.com/me/my-module
cd my-module
module-starter

CLI

You can also generate a module with a CLI

git clone https://github.com/me/my-module
cd my-module
module-starter --cli

License

MIT