Skip to content

Create Node Module is a cli for getting your new module off to a great start.

License

Notifications You must be signed in to change notification settings

billiegoose/cnm

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

7 Commits
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

cnm

Create Node Module is a cli for getting your new module off to a great start.

TODOs

  • Initial prototype
  • Port from shell to JavaScript
  • Cache global values (like author name, email) in config file
  • Add proper CLI parser
  • Make interactive with inquirer
  • Create a simpler parser than projectz/mos that just grabs from ## Identifier to the next ## or ### and updates it based on section templates.

Templates (Planned, not implemented)

templates
├── badges.js
├── dependencies.js
├── footer.js
├── header.js
├── installation.js
├── license.js
└── tests.js

You could override the default template with a custom template in ~/.cnm or preferably save the override templates in the repo, either in a predictably named folder or a user-configurable location specified in package.json options.

Installation

Download node at nodejs.org and install it, if you haven't already.

Then in the terminal, run:

npm install -g cnm

Tests

First clone this repository to get the source code. Then in the topmost repo directory run:

npm install
npm test

License

Unless stated otherwise all works are:

  • Copyright © William Hilton

and licensed under:

Parts of this file are based on package-json-to-readme

README.md (and other files) are maintained using mos and projectz

About

Create Node Module is a cli for getting your new module off to a great start.

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published