Fork me on GitHub

Installation

Set up robocop.js.

With Bower (for browser use)

robocop.js is registered in the Bower package repository. With Bower you can install robocop.js and manage your frontend app's dependency on robocop.js.


To install robocop.js, open a terminal in your project's directory and enter the command:

bower install robocop.js --save

This command will install the latest stable version of robocop.js.


Enter the following command to install a specific version:

bower install robocop.js#x.x.x --save

where x.x.x is the version of robocop.js you want to install.

With NPM (for use with Node)

robocop.js is registered in the NPM package repository. With NPM you can install robocop.js and manage your Node app's dependency on robocop.js.


To install robocop.js, open a terminal in your project's directory and enter the command:

npm install robocop.js --save

This command will install the latest stable version of robocop.js.


Enter the following command to install a specific version:

npm install robocop.js@x.x.x --save

where x.x.x is the version of robocop.js you want to install.

Download Manually

Download robocop.js manually here: Downloads.


Each release has a development version of robocop.js and a minified version.

With Bower (for browser use)

robocop.js should have installed to path/to/bower_components/robocop.js/. You can reference the files in the dist/ folder, which contains development and minified versions of robocop.js.

<script src="/path/to/bower_components/robocop.js/dist/robocop.min.js"></script>

With NPM (for use with Node)

robocop.js should have installed to node_modules/robocop.js/. You can require robocop.js just like you would any other npm module.

var robocop = require('robocop.js');

Install Manually

Include the version of robocop.js you downloaded on your web page.

<script src="/js/libs/robocop-0.12.0.min.js"></script>

Transition Details

AFTER 1.0.0 See TRANSITION.md for details on breaking changes between versions.

Upgrade with Bower

After installing robocop.js with Bower, your bower.json file lists robocop.js as a dependency.

"dependencies": {
    "robocop.js": "~0.12.0"
}


The command:

bower install robocop.js -F --save

will install the latest stable version of robocop.js and save the change to your bower.json.


Alternatively, you can specify the new version you want to install, for example:

bower install robocop.js#0.12.0 --save.


bower prune will remove the old installation of robocop.js.

Upgrade with NPM

After installing robocop.js with NPM, your package.json file lists robocop.js as a dependency.

"dependencies": {
    "robocop.js": "~0.12.0"
}


The command:

npm update robocop.js --save

will install the latest stable version of robocop.js and save the change to your package.json.


Alternatively, you can specify the new version you want to install, for example:

npm install robocop.js@0.12.0 --save.

Upgrade Manually

Download the version of robocop.js you want as specified in the Download section.

Remember to update your references to robocop.js.