generator-rb-js v0.1.5

generator-rb-js

Yeoman generator for projects for Rockabox JS projects, setting up:

• Node
  • Creates a package.json file
  • Adds grunt-contrib-jshint using Rockabox's conf
  • Adds grunt-jscs using Rockabox's conf
• Bower
  • Creates a pre-configured bower.json file (based on package.json)
• Grunt
  • Creates a Gruntfile.js
  • Adds a grunt test command which runs
    • JSHint
    • JSCS
• Travis or Circle CI
  • Will create a .travis.yml file for Public repo's
  • Will create a circle.yml file for Private repo's

Usage

It is suggested to use GitHub's Node.gitignore file, or just it's contents.

First of all it will be expected that a repo has been previously set up to use Node within it's project (by having a package.json within it's repo).

If you have skip this command: npm init

You will need to ensure that yeoman is installed globally:

npm install -g yo

Once installed globally install this project globally

npm install -g generator-rb-js

Now you are ready to use the generator simply run when starting a new project: yo rb-js

If you want to update a project that was originally built with this generator:

yo rb-js:update

This command will ensure the project uses the most up to date:

- JSHint conf
- JSCS conf
- Editor conf

These are retrieved from https://github.com/rockabox/rb-js-linter

Contributing

Please see https://github.com/rockabox/rb-js-linter for JS Style information.