Merge pull request #8 from billybonks/enhancement/rename-generateTest…

…-property

Enhancement/rename generate test property

README.md

@@ -26,12 +26,11 @@ var node = new StyleLint('app/styles');
 
 the default output will be the same SCSS files, in the same tree structure.
 
-###Generating Tests
+###Tests
 
-`var node = new StyleLint('app/styles', {generateTests:true});`
-
-Instead of receiving a tree of scss files, the plugin will output a tree of test files
+Tests are automatically generated
 
+If tests are generated the plugin will output a tree of test files
 
 **original tree**
 ```
@@ -60,7 +59,35 @@ new Funnel(node, {
   srcDir:'tests',
 });
 ```
-See below for more advaned test configurations
+
+If test generation is disabled the plugin will return the original tree
+
+** Disable test generation **
+set the option `disableTestGeneration:true`
+
+`var node = new StyleLint('app/styles', {disableTestGeneration:true});`
+
+** Custom test generator **
+If you want to build your own test generator set the `testGenerator` option to a function that will generate the tests
+
+```javascript
+StyleLinter.prototype.testGenerator = function(relativePath, errors) {
+  var assertions = [];
+  var module  = "module('Style Lint');\n";
+  var test = "test('" + relativePath + " should pass stylelint', function() {\n";
+  if(!errors){
+    var assertion =  "  ok(\'true , "+relativePath+" passed stylelint\');";
+    return module+test+assertion+"\n});\n";
+  } else {
+    for(var i = 0; i < errors.warnings.length; i++){
+      var warning = errors.warnings[i];
+      var index = warning.line+':'+warning.column;
+      assertions.push("  ok(" + false + ", '"+index +" "+this.escapeErrorString(warning.text)+"');");
+    }
+    return module+test+assertions.join('\n')+"\n});\n";
+  }
+};
+```
 
 Configuration
 =====
@@ -90,10 +117,16 @@ If true it will generate a unit test if the file fails lint.
 
 If true it  will generate a unit test if the passes fails lint.
 
-`generateTests` {boolean}
+`disableTestGeneration` {boolean}
 
-If true it will generate tests for both passing and failing tests, overrides the testPassingFiles and testFailingFiles
+Will disable generation of tests
 
 `disableConsoleLogging` {boolean}
 
 If true it will disable logging of errors to console
+
+`log` {boolean}
+If true it will log results to console
+
+`console` {object}
+A custom console object

index.js

@@ -9,7 +9,7 @@ StyleLinter.prototype.constructor = StyleLinter;
 
 /* Used to extract and delete options from input hash */
 StyleLinter.prototype.availableOptions = ['onError',
-                                          'generateTests',
+                                          'disableTestGeneration',
                                           'testFailingFiles',
                                           'testPassingFiles' ,
                                           'testGenerator',
@@ -23,7 +23,7 @@ StyleLinter.prototype.availableOptions = ['onError',
  * - linterConfig           (StyleLint options)
  * - onError                (Hook when error occurs)
  * - testGenerator          (Hook for custom test generation)
- * - generateTests          (Generate tests for all files)
+ * - disableTestGeneration  (Disable generatation tests for all files)
  * - testFailingFiles       (Generate tests for failing files)
  * - testPassingFiles       (Generate tests for passing files)
  * - log                    (Disables error logging in console)
@@ -56,11 +56,13 @@ function StyleLinter(inputNodes, options) {
     formatter: 'string'
   });
 
-  if(this.generateTests === false || this.generateTests === true){
-    this.testFailingFiles = this.generateTests;
-    this.testPassingFiles = this.generateTests;
+  if(typeof this.testFailingFiles === 'undefined' && typeof this.testPassingFiles === 'undefined' && typeof this.disableTestGeneration === 'undefined'){
+    this.testFailingFiles = true;
+    this.testPassingFiles = true;
+  }else if( typeof this.disableTestGeneration !== 'undefined' ){
+    this.testFailingFiles = typeof this.testFailingFiles === 'undefined' ? !this.disableTestGeneration : this.testFailingFiles;
+    this.testPassingFiles  = typeof this.testPassingFiles === 'undefined' ? !this.disableTestGeneration : this.testPassingFiles;
   }
-
   this.linterConfig.files = null;
 
   this.setSyntax(this.linterConfig.syntax);

tests/test.js

@@ -127,9 +127,9 @@ describe('Broccoli StyleLint Plugin', function() {
 
     it('sets options on object', function(){
       var linterConfig = {syntax:'scss'};
-      var options = {linterConfig:linterConfig, generateTests:true};
+      var options = {linterConfig:linterConfig, disableTestGeneration:true};
       var linter = new StyleLinter('', options);
-      expect(linter.generateTests).to.equal(true);
+      expect(linter.disableTestGeneration).to.equal(true);
       expect(linter.linterConfig).to.eql(linterConfig);
     });
 
@@ -145,7 +145,6 @@ describe('Broccoli StyleLint Plugin', function() {
       describe('Generate Tests', function(){
         it('accepted testGenerator property', function() {
           var opt = {
-            generateTests:true,
             testGenerator:function(relativePath, errors){
               return "custom test"
             }
@@ -157,12 +156,8 @@ describe('Broccoli StyleLint Plugin', function() {
                        ).to.eventually.equal(test);
         })
 
-        it('generates all tests regardless of other test config when true', function() {
-          generatorOptionsTest(3,{generateTests:true});
-        });
-
-        it('generates no tests regardless of other test config when false', function() {
-          generatorOptionsTest(3,{generateTests:true});
+        it('generates no tests regardless of other test config when disableTestGeneration is true', function() {
+          generatorOptionsTest(3,{disableTestGeneration:true});
         });
       });
       function buildAndAssertFile(options, relativePath, equal) {