Skip to content

finnp/create-module

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

25 Commits
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

create-module

Join the chat at https://gitter.im/finnp/create-module NPM

js-standard-style

Helper tool for the usual steps to create a module.

Install

npm install create-module --global

Usage

create-module <package> [--check] [--offline]

Does the following work-flow:

mkdir <package>
cd <package>
# create <githubrepo> for <package>
git init
git remote add origin <githubrepo>
echo <readme> > readme.md
echo node_modules > .gitignore
npm init
git add --all
git commit -m "initial commit"
git push origin master
# set github repo description to package.json description

if the 'check' flag is used, it will check npm to see if module exists. if the 'offline' flag is used, it will not create a new Github repo and push the code to Github

The readme.md is initialised with this template:

# <package>
[![NPM](https://nodei.co/npm/<package>.png)](https://nodei.co/npm/<package>/)