Make cli logs more clear to people

.jshintrc → .jshintrc1

@@ -13,7 +13,6 @@
     "sub": true,
 
     "browser": true,
-    "wsh": true,
     "-W099": true,
 	"-W100": true,
 
@@ -22,9 +21,6 @@
         "HTMLParser",
         "require",
         "exports",
-        "process",
-        "describe",
-        "it",
         "console",
         "JSHINT",
         "CSSLint"

.jshintrc2

@@ -0,0 +1,23 @@
+{
+    "curly": true,
+    "expr": true,
+    "newcap": false,
+    "regexdash": true,
+    "trailing": true,
+    "undef": true,
+    "unused": true,
+    "maxerr": 100,
+
+    "eqnull": true,
+    "evil": true,
+    "sub": true,
+
+    "node": true,
+    "-W099": true,
+	"-W100": true,
+
+    "predef": [
+        "describe",
+        "it"
+    ]
+}

CHANGE.md

@@ -11,10 +11,11 @@ add:
 4. Support json raw format in cli
 5. tag-pair(rule): Show the line of the start tag
 6. space-tab-mixed-disabled(rule): Support space and tab mode, for check only space or tab
+7. Make cli logs more clear to people
 
 fix:
 
-1. fix issue: #77 `<link rel=icon><link rel=icon>`
+1. Fix issue: #77 `<link rel=icon><link rel=icon>`
 2. Made the descriptions and error messages of rules more clear to people
 
 ## ver 0.9.7 (2015-3-8)

Gruntfile.js

@@ -13,10 +13,16 @@ module.exports = function(grunt) {
     grunt.initConfig({
         pkg: grunt.file.readJSON('package.json'),
         jshint: {
-            all: {
-                src: ['Gruntfile.js', 'src/**/*.js', 'test/**/*.js', 'bin/*'],
+            browser: {
+                src: ['src/**/*.js'],
                 options: {
-                    jshintrc: ".jshintrc"
+                    jshintrc: ".jshintrc1"
+                }
+            },
+            node: {
+                src: ['Gruntfile.js', 'test/**/*.js', 'bin/*'],
+                options: {
+                    jshintrc: ".jshintrc2"
                 }
             }
         },
@@ -74,7 +80,7 @@ module.exports = function(grunt) {
     });
 
     grunt.registerTask('build', ['jshint', 'clean', 'concat']);
-    
+
     grunt.registerTask('dev', ['build', 'exec:test']);
 
     grunt.registerTask('default', ['build', 'exec:cover', 'uglify', 'replace:version']);

bin/htmlhint

@@ -95,7 +95,7 @@ function getAllFiles(arrTargets){
         for(var i=0,l=arrTargets.length;i<l;i++){
             var filepath = path.resolve(process.cwd(), arrTargets[i]);
             if(fs.existsSync(filepath) !== false){
-              if(fs.statSync(filepath).isFile) {
+              if(fs.statSync(filepath).isFile()) {
                 arrAllFiles.push(filepath);
               } else {
                 getFiles(arrTargets[i], arrAllFiles);
@@ -128,12 +128,15 @@ function getFiles(filepath, arrFiles){
 }
 
 function processFiles(arrFiles, ruleset, jsonOutput){
-    var exitcode = 0,
-        allHintCount = 0;
+    var exitcode = 0;
+    var allFileCount = 0;
+    var allHintCount = 0;
+    console.log('');
     arrFiles.forEach(function(filepath){
         var hintCount = hintFile(filepath, ruleset, jsonOutput);
         if(hintCount > 0){
             exitcode = 1;
+            allFileCount ++;
             allHintCount += hintCount;
         }
     });
@@ -142,10 +145,10 @@ function processFiles(arrFiles, ruleset, jsonOutput){
     }
     else{
         if(allHintCount > 0){
-            console.log('\r\n%d problems.'.red, allHintCount);
+            console.log('%d errors in %d files'.red, allHintCount, allFileCount);
         }
         else{
-            console.log('No problem.'.green);
+            console.log('Done, without errors.'.green);
         }
     }
     return exitcode;
@@ -166,13 +169,18 @@ function hintFile(filepath, ruleset, jsonOutput){
 }
 
 function logPretty(filepath, messages){
-    console.log(filepath+':');
+    console.log('   '+path.relative(process.cwd(), filepath));
     messages.forEach(function(hint){
-        console.log('[ %s ] line %d, col %d: %s', hint.rule.id.green, hint.line, hint.col, hint.message[hint.type === 'error'?'red':'yellow']);
+        console.log('      L%d |%s', hint.line, hint.evidence.replace(/\t/g, ' ').gray);
+        console.log('      %s^ %s', repeatStr(String(hint.line).length + 3 + hint.col - 1), (hint.message + ' (' + hint.rule.id+')')[hint.type === 'error'?'red':'yellow']);
     });
     console.log('');
 }
 
+function repeatStr(n, str){
+    return new Array(n + 1).join(str || ' ');
+}
+
 function logJson(filepath, messages, jsonOutput){
     jsonOutput.push({'file': filepath, 'messages': messages});
 }

package.json

@@ -16,7 +16,7 @@
     "grunt-cli": "0.1.6",
     "grunt-contrib-clean": "0.4.0",
     "grunt-contrib-concat": "0.1.3",
-    "grunt-contrib-jshint": "0.3.0",
+    "grunt-contrib-jshint": "0.11.3",
     "grunt-contrib-uglify": "0.2.0",
     "grunt-contrib-watch": "0.3.1",
     "grunt-exec": "0.4.0",

src/core.js

@@ -1,3 +1,4 @@
+/* jshint -W079 */
 /**
  * Copyright (c) 2015, Yanis Wang <[email protected]>
  * MIT Licensed
@@ -72,4 +73,4 @@ var HTMLHint = (function (undefined) {
 
 if (typeof exports === 'object' && exports){
     exports.HTMLHint = HTMLHint;
-}
+}

src/htmlparser.js

@@ -1,3 +1,4 @@
+/* jshint -W079 */
 /**
  * Copyright (c) 2015, Yanis Wang <[email protected]>
  * MIT Licensed
@@ -31,8 +32,8 @@ var HTMLParser = (function(undefined){
             var self = this,
                 mapCdataTags = self._mapCdataTags;
 
-            var regTag=/<(?:\/([^\s>]+)\s*|!--([\s\S]*?)--|!([^>]*?)|([\w\-:]+)((?:\s+[\w\-:]+(?:\s*=\s*(?:"[^"]*"|'[^']*'|[^\s"'\/>]*))?)*?)\s*(\/?))>/g,
-                regAttr = /\s*([\w\-:]+)(?:\s*=\s*(?:(")([^"]*)"|(')([^']*)'|([^\s"'\/>]*)))?/g,
+            var regTag=/<(?:\/([^\s>]+)\s*|!--([\s\S]*?)--|!([^>]*?)|([\w\-:]+)((?:\s+[\w\-:]+(?:\s*=\s*(?:"[^"]*"|'[^']*'|[^\s"'>]*))?)*?)\s*(\/?))>/g,
+                regAttr = /\s*([\w\-:]+)(?:\s*=\s*(?:(")([^"]*)"|(')([^']*)'|([^\s"'>]*)))?/g,
                 regLine = /\r?\n/g;
 
             var match, matchIndex, lastIndex = 0, tagName, arrAttrs, tagCDATA, attrsCDATA, arrCDATA, lastCDATAIndex = 0, text;

test/htmlparser.spec.js

@@ -446,9 +446,12 @@ describe('HTMLParser: Case parse', function(){
             expect(arrEvents[1]).to.event('tagstart',
             {
                 tagName: 'img',
-                close: '/'
+                close: ''
             });
-            expect(arrEvents[1].attrs.length).to.be(2);
+            var attrs = arrEvents[1].attrs;
+            expect(attrs.length).to.be(2);
+            expect(attrs[1].name).to.be('alt');
+            expect(attrs[1].value).to.be('/');
             done();
         });
         parser.parse('<img src="aaa" alt= />');