Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/billiegoose/cnm
Create Node Module is a cli for getting your new module off to a great start.
https://github.com/billiegoose/cnm
Last synced: 24 days ago
JSON representation
Create Node Module is a cli for getting your new module off to a great start.
- Host: GitHub
- URL: https://github.com/billiegoose/cnm
- Owner: billiegoose
- License: other
- Created: 2016-12-05T05:41:18.000Z (about 8 years ago)
- Default Branch: master
- Last Pushed: 2017-03-20T21:50:29.000Z (almost 8 years ago)
- Last Synced: 2024-10-06T03:21:47.176Z (3 months ago)
- Language: Shell
- Homepage:
- Size: 16.6 KB
- Stars: 1
- Watchers: 2
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE.md
Awesome Lists containing this project
README
cnm
Create Node Module is a cli for getting your new module off to a great start.
## TODOs
- [x] 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](http://nodejs.org) and install it, if you haven't already.
Then in the terminal, run:
```sh
npm install -g cnm
```
## Tests
First clone this repository to get the source code. Then in the topmost repo
directory run:
```sh
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](https://github.com/zeke/package-json-to-readme)_
_README.md (and other files) are maintained using [mos](https://github.com/mosjs/mos) and [projectz](https://github.com/bevry/projectz)_