WMeldon / broccoli-jshint

Broccoli JSHint

Run JSHint on the provided tree.

Usage

var jshintTree = require('broccoli-jshint');

// assuming someTree is a built up tree
var tree = jshintTree(someTree, {
  destFile: 'jshint-tests.js'
});

Documentation

jshintTree(inputTree, options)

---

options.destFile {String}

The file to output the generated test output to.

---

options.log {true|false}

Should we log errors to the console?

Default: true

---

options.disableTestGenerator {true|false}

If true no tests will not be generated.

Default: false

---

options.testGenerator {Function}

The function used to generate test modules. You can provide a custom function for your client side testing framework of choice.

The function receives the following arguments:

• relativePath - The relative path to the file being tested.
• errors - A generated string of errors found.

Default generates QUnit style tests:

var path = require('path');

function(relativePath, errors) {
  return "module('" + path.dirname(relativePath) + '");";
         "test('" + relativePath + "' should pass jshint', function() { " +
         "  ok(passed, moduleName+" should pass jshint."+(errors ? "\n"+errors : '')); " +
         "});
};

ZOMG!!! TESTS?!?!!?

I know, right?

Running the tests:

npm install
npm test

License

This project is distributed under the MIT license.