https://github.com/rrwen/cookiecutter-npm
Personal template for Node.js npm packages with Python cookiecutter
https://github.com/rrwen/cookiecutter-npm
cli command cookiecutter coveralls interface istanbul json line log node nodejs npm package personal pip python tape template test travis
Last synced: 27 days ago
JSON representation
Personal template for Node.js npm packages with Python cookiecutter
- Host: GitHub
- URL: https://github.com/rrwen/cookiecutter-npm
- Owner: rrwen
- License: mit
- Created: 2017-11-09T06:25:24.000Z (over 7 years ago)
- Default Branch: master
- Last Pushed: 2018-01-24T21:47:39.000Z (over 7 years ago)
- Last Synced: 2025-03-30T10:33:41.711Z (about 2 months ago)
- Topics: cli, command, cookiecutter, coveralls, interface, istanbul, json, line, log, node, nodejs, npm, package, personal, pip, python, tape, template, test, travis
- Language: JavaScript
- Homepage:
- Size: 54.7 KB
- Stars: 6
- Watchers: 1
- Forks: 1
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# cookiecutter-npm
Richard Wen
[email protected]
Personal template for Node.js npm packages with Python cookiecutter.
[](https://travis-ci.org/rrwen/cookiecutter-npm)
[](https://github.com/rrwen/cookiecutter-npm/blob/master/LICENSE)
## Install
1. Install [Python](https://www.python.org/downloads/)
2. Install [cookiecutter](https://pypi.python.org/pypi/cookiecutter) via `pip`
3. Install [Node.js](https://nodejs.org/en/)
```
pip install cookiecutter
```
## Usage
1. Create a template for a [npm](https://www.npmjs.com/) package using the cookiecutter command line interface
2. Change the directory to the folder with the same name as the `template_name` input
3. Update and install the developer dependencies using the [npm command](https://docs.npmjs.com/cli/npm)
```
cookiecutter gh:rrwen/cookiecutter-npm
cd
npm update --dev
npm run docs
```
See [Implementation](#implementation) for more details.
## Developer Notes
### Create Github Repository
1. Ensure [git](https://git-scm.com/) is installed
2. Change directory to the generated folder `cd `
3. Initialize the repository
4. Add the generated files to commit
5. Create an empty [Github repository](https://help.github.com/articles/create-a-repo/) with the same name as `template_name`
6. Pull any changes if the Github repository is not empty
7. Push the commit from `4.` to your created Github repository
```
git init
git add .
git commit -a -m "Initial commit"
git remote add origin https://github.com//.git
git pull origin master --allow-unrelated-histories
git push -u origin master
```
### Useful npm Commands
**Edit** the basic keys in `package.json`:
```
npm init
```
**Install all** dependencies in `package.json`:
```
npm install
```
**Install** a package and add it as a dependency with `--save`:
```
npm install --save
```
**Uninstall** a package and dependency:
```
npm uninstall --save
```
**Update all** dependencies in `package.json`:
```
npm update --dev
```
**Test** the package with [tape](https://www.npmjs.com/package/tape):
```
npm test
```
### Implementation
This template uses [cookiecutter](https://pypi.python.org/pypi/cookiecutter) to create folders and files for [npm](https://www.npmjs.com/) packages in [Node.js](https://nodejs.org/en/).
* The main file is [cookiecutter.json](https://github.com/rrwen/cookiecutter-npm/blob/master/cookiecutter.json) which defines the inputs for the command line interface
* The inputs then replace any values surrounded with `{{}}` inside the folder [{{cookiecutter.template_name}}](https://github.com/rrwen/cookiecutter-npm/tree/master/%7B%7Bcookiecutter.template_name%7D%7D)
```
cookiecutter <-- template tool
|
cookiecutter.json <-- template inputs
|
{{cookiecutter.template_name}} <-- generated template
```
The following files will be created inside a folder with the same name as the `template_name` input:
File | Description
--- | ---
**tests/test.js** | A file that uses [tape]() to test the `index.js` module and logs results into `tests/log/` for the package version specified in `package.json`
**.gitignore** | A Node [.gitignore](https://git-scm.com/docs/gitignore) automatically generated from github
**.npmignore** | A file to specify ignoring `tests/logs/*` and `docs/*`
**.travis.yml** | A [.travis.yml](https://docs.travis-ci.com/user/customizing-the-build/) file for automatic builds and tests
**LICENSE** | MIT [license file](https://help.github.com/articles/licensing-a-repository/) automatically created from github
**README.md** | A readme [Markdown](https://daringfireball.net/projects/markdown/) file with header, install, usage, and developer notes sections
**package.json** | The [npm package.json](https://docs.npmjs.com/files/package.json) specifications with [tape](https://www.npmjs.com/package/tape), [moment](https://www.npmjs.com/package/moment), [istanbul](https://www.npmjs.com/package/istanbul), [coveralls](https://www.npmjs.com/package/coveralls), and [documentation](https://www.npmjs.com/package/documentation) developer dependencies
**index.js** | The main entry file for the npm package with an exported function consuming an `options` object