generator-es5-npm-module

generator-es5-npm-module

This generator creates project for you where you can start working with your npm module.

Getting Started

npm install -g yo generator-es5-npm-module
mkdir my-project && cd my-project
yo es5-npm-module

Or you can create folder with your project and just copy\paste this code to terminal (you should be located under your project folder)

npm install -g yo generator-es5-npm-module && yo es5-npm-module

Project structure

When project is generated you will get project with that structure:

|-- my-project # Root of your project
  |-- lib # Folder with your source code
  |  |-- index.js # Some basic script of your module
  |-- test # Folder with tests for your module
  |  |-- index.test.js # Testing your main script
  |  |-- mocha.opts # File for mocha options
  |-- .editorconfig # editorconfig for IDE with standardized JavaScript code-style
  |-- .gitignore # gitignore template for NodeJS applications
  |-- .jshintrc # JSHint configuration
  |-- .npmignore # npmignore template with some stuff disabled for publish like test or .travis.yml
  |-- .travis.yml # Travis configuration file with NodeJS 0.10, 0.12 and iojs. Also it sends coverage data to Coveralls
  |-- index.js # Main script (entry point) because it's defined in package.json
  |-- package.json # package.json template with minimal data here
  |-- README.md # Readme with predefined text based on your answers

License

The MIT License (MIT)

Copyright © 2015 Eugene Obrezkov

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.