glavin001 / node-package-builder

Automated guide to help build a Node.js Package to share with NPM.

node-package-builder

Automated guide to help build a Node.js Package to share with NPM.

---

Installation

Install the global package-builder.

npm install -g package-builder

Usage

Using package-builder for the first time.

package-builder init

Features

• Help configuring package.json.
• Creating README.md
• Guide to publishing to NPM
• Generating Badges for README.md -- Travis CI -- NPM with NodeICO -- Sourcegraph -- Version Badge
• Create .gitignore file
• Setup JSHint
• Init tests directory with example test using Mocha.
• Init docs directory.
• Init lib directory with index.js for building onto.

---

License

MIT

Author

Glavin Wiechert

Contributors

• Glavin Wiechert

node-package-builder's Issues

JSHint

JSHint

• Install as devDependency and configure, http://www.jshint.com/install/

Create .gitignore with Common Configurations

Create .gitignore

Examples: https://github.com/github/gitignore

Downloading

• Use https://raw2.github.com/github/gitignore/master/{path/to/example.gitignore}

Language

• Node.js https://github.com/github/gitignore/blob/master/Node.gitignore

Operating Systems

• Mac
  https://github.com/github/gitignore/blob/master/Global/OSX.gitignore
• Linux
  https://github.com/github/gitignore/blob/master/Global/Linux.gitignore
• Windows
  https://github.com/github/gitignore/blob/master/Global/Windows.gitignore

Editors

• Vim temp files
  https://github.com/github/gitignore/blob/master/Global/vim.gitignore
• Sublime Text
  https://github.com/github/gitignore/blob/master/Global/SublimeText.gitignore
• Eclipse
  https://github.com/github/gitignore/blob/master/Global/Eclipse.gitignore
• Netbeans
  https://github.com/github/gitignore/blob/master/Global/NetBeans.gitignore

Generating Badges

Badges

• Travis CI, https://travis-ci.org/
• NPM with NodeICO, https://nodei.co/
• Sourcergraph, https://sourcegraph.com/
• Version Badge, http://badge.fury.io/

Make it a Yeoman Generator

See https://github.com/anvaka/generator-n for an example.

This should improve heavily upon generator-n 👍.

See http://yeoman.io/generators.html#writing-your-first-generator

Create README.md

Create README.md

• Add Package Title
• Add Installation Instructions
• Add License
• Add Author
• Add Contributors

Guide Publishing to NPM

Guide Publishing to NPM registry

• Add new user to NPM registry

npm adduser 

• Finally publish to npm registry

npm publish