Loris is hosted on Gemcutter (gemcutter.org/), so you need to install their gem if you haven't already.
sudo gem update –system sudo gem install gemcutter gem tumble
Then to install Loris, just run the following:
sudo gem install loris On Windows you will also need to install the win32-process gem
gem install win32-process
Loris has no command line options, and no configuration file (at the moment). It looks for configurations files to decide which tasks to run.
You just need to specify which files Javascipt Lint should process. For example:
### Files # Specify which files to lint # Use “+recurse” to enable recursion (disabled by default). # To add a set of files, use “+process FileName”, “+process FolderPath*.js”, # or “+process FolderPath*.htm”. # process src/js/*.js process tests/js/*.js
Configuring JS Test Driver
To enable JS Test Driver, create a `jsTestDriver.conf` file in the folder where you run Loris. This should be a standard JS Test Driver config file (code.google.com/p/js-test-driver/wiki/ConfigurationFile).
This should specify which files JS Test Driver should process, and how it connects to the JS Test Driver server. For example:
load: - tests/qunit/equiv.js - tests/qunit/QUnitAdapter.js
- src/js/*.js - tests/js/*.js
If no `jsTestDriver.conf` file is found, the JS Test Driver task is silently skipped.
To make it really simple to run JS Test Driver tests, if the server is set to run on `localhost`, and Loris doesn't detect one running, it will automatically start one, and register your default browser with it.
This makes it a one step process to get automated tests up and running.
To run, open a command line window, navigate to the root folder of your project, and run:
0 error(s), 0 warning(s) JS Test Driver success All tests pass [PASSED] GreeterTest.testGreet [LOG] JsTestDriver Hello World! [PASSED] GreeterTest.testGoodbye [PASSED] GreeterTest.testSetName [PASSED] GreeterTest.testSetNameAndNameParamter [PASSED] Asserts.test OK true succeeds [PASSED] Asserts.test Equals succeeds [LOG] about to call assertEquals [PASSED] Asserts.test Same assert succeeds [PASSED] Lifecycle.test Setup and Teardown are run, and can contain assertions Total 8 tests (Passed: 8; Fails: 0; Errors: 0) (3.00 ms) Firefox 220.127.116.11 MacIntel: Run 8 tests (Passed: 8; Fails: 0; Errors 0) (3.00 ms)
Loris will clear the command line when re-running tasks. So the latest run is always at the top of you command line.
Loris will also report a summary of each task using Growl (growl.info/) (if it is installed). This allows you to get quick feedback without needing to refer back to the command line on every change.
JS Test Driver is written in Java, so you will need to have Java installed to run it.
To get Growl notifications, you will need to install either Growl for OSX (growl.info/) or Growl for Windows (www.growlforwindows.com/). Growl for Windows requires the .NET Framework 2.0+ (www.microsoft.com/downloads/details.aspx?FamilyID=0856EACB-4362-4B0D-8EDD-AAB15C5E04F5&displaylang=en).
Loris is pretty limited at the moment, I just wired up the basics to get it running for a work project.
It doesn't have any configuration options at the moment, so you have to follow it's assumptions for now. I'm happy to add configuration options for any element as required.
If you want to modify the code, just fork the Loris github project (github.com/karl/loris)