hello world

Author: kazu69

.gitignore

@@ -0,0 +1,4 @@
+node_modules
+npm-debug.log
+tmp
+log

.htmlhintrc

@@ -0,0 +1,22 @@
+{
+    "tagname-lowercase": true,
+    "attr-lowercase": true,
+    "attr-value-double-quotes": true,
+    "attr-value-not-empty": true,
+    "attr-no-duplication": true,
+    "doctype-first": true,
+    "tag-pair": true,
+    "tag-self-close": true,
+    "spec-char-escape": true,
+    "id-unique": true,
+    "src-not-empty": true,
+    "head-script-disabled": true,
+    "img-alt-require": true,
+    "doctype-html5": true,
+    "id-class-value": true,
+    "style-disabled": true,
+    "space-tab-mixed-disabled": true,
+    "id-class-ad-disabled": true,
+    "href-abs-or-rel": true,
+    "attr-unsafe-chars": true
+}

.jshintrc

@@ -0,0 +1,13 @@
+{
+  "curly": true,
+  "eqeqeq": true,
+  "immed": true,
+  "latedef": true,
+  "newcap": true,
+  "noarg": true,
+  "sub": true,
+  "undef": true,
+  "boss": true,
+  "eqnull": true,
+  "node": true
+}

Gruntfile.js

@@ -0,0 +1,49 @@
+/*
+ * grunt-htmlhint-inline
+ * https://github.com/kazu69/grunt-htmlhint-inline
+ *
+ * Copyright (c) 2015 kazu69
+ * Licensed under the MIT license.
+ */
+
+'use strict';
+
+module.exports = function(grunt) {
+
+  grunt.initConfig({
+    jshint: {
+      all: [
+        'Gruntfile.js'
+      ],
+      options: {
+        jshintrc: '.jshintrc'
+      }
+    },
+
+    htmlhint_inline: {
+      options: {
+        htmlhintrc: '.htmlhintrc',
+        ignore: {
+            '<?php': '?>'
+        },
+        patterns: [
+          {
+            match: /hoge/g,
+            replacement: 'fuga'
+          }
+        ],
+        reporterOutput: './log/grunt.log',
+      },
+      dest: {
+        src: ['./test/*.phtml']
+      }
+    }
+
+  });
+
+  grunt.loadTasks('tasks');
+  grunt.loadNpmTasks('grunt-contrib-jshint');
+
+  grunt.registerTask('test', ['htmlhint_inline']);
+  grunt.registerTask('default', ['jshint', 'test']);
+};

README.md

@@ -0,0 +1,133 @@
+# grunt-htmlhint-inline
+
+> Grunt task for linting inline html
+
+## Getting Started
+This plugin requires Grunt `~0.4.5`
+
+If you haven't used [Grunt](http://gruntjs.com/) before, be sure to check out the [Getting Started](http://gruntjs.com/getting-started) guide, as it explains how to create a [Gruntfile](http://gruntjs.com/sample-gruntfile) as well as install and use Grunt plugins. Once you're familiar with that process, you may install this plugin with this command:
+
+```shell
+npm install grunt-htmlhint-inline --save-dev
+```
+
+Once the plugin has been installed, it may be enabled inside your Gruntfile with this line of JavaScript:
+
+```js
+grunt.loadNpmTasks('grunt-htmlhint-inline');
+```
+
+## The "htmlhint-inline" task
+
+### Overview
+In your project's Gruntfile, add a section named `htmlhint-inline` to the data object passed into `grunt.initConfig()`.
+
+```js
+grunt.initConfig({
+  htmlhint_inline: {
+      options: {
+        htmlhintrc: '.htmlhintrc',
+        ignore: {
+            '<?php': '?>'
+        }
+      },
+      dest: {
+        src: ['./test/*.phtml']
+      }
+    },
+});
+```
+
+### Options
+
+#### htmlhintrc
+Type: String Default value: null
+
+```htmlhintrc``` file must be a valid JSON.
+If you specify this file, options that have been defined in it will be used in the global.
+If there is specified in the task options, the options in this file will be overwritten.
+
+```json
+{
+  "tagname-lowercase": true
+}
+```
+
+#### patterns
+Type: Array Default: []
+
+Enable the replacement by the pattern
+
+##### patterns.match
+
+Type: RegExp|String
+
+Indicates the matching expression.
+
+##### patterns.replacement
+
+Type: String|Function
+
+#### reporterOutput
+
+Type: String  Default: null
+
+Output the task execution results to a specified file.
+
+#### force
+
+Type: Boolean Default value: false
+
+Report HTMLHint errors but dont fail the task
+
+
+### Usage Examples
+
+#### Default Options
+In this example, the default options are used to do something with whatever. So if the `testing` file has the content `Testing` and the `123` file had the content `1 2 3`, the generated result would be `Testing, 1 2 3.`
+
+```js
+grunt.initConfig({
+  htmlhint_inline: {
+      options: {
+        "tagname-lowercase": true,
+        "attr-lowercase": true,
+        ignore: {
+            '<?php': '?>'
+        }
+      },
+      dest: {
+        src: ['./test/*.phtml']
+      }
+    },
+});
+```
+
+#### Custom Options
+In this example, custom options are used to do something else with whatever else. So if the `testing` file has the content `Testing` and the `123` file had the content `1 2 3`, the generated result in this case would be `Testing: 1 2 3 !!!`
+
+```js
+grunt.initConfig({
+    htmlhint_inline: {
+      options: {
+        htmlhintrc: '.htmlhintrc',
+        ignore: {
+            '<?php': '?>'
+        },
+        patterns: [
+          {
+            match: /hoge/g,
+            replacement: 'fuga'
+          }
+        ],
+        reporterOutput: './log/grunt.log',
+      },
+      dest: {
+        src: ['./test/*.phtml']
+      }
+    }
+});
+```
+## License
+
+MIT

tasks/htmlhintinline.js

@@ -0,0 +1,124 @@
+/*
+ * grunt-htmlhint-inline
+ * https://github.com/kazu69/grunt-htmlhint-inline
+ *
+ * Copyright (c) 2015 kazu69
+ * Licensed under the MIT license.
+ */
+
+'use strict';
+
+module.exports = function (grunt) {
+
+  var lintinline = require('./lib/inlinehint'),
+      HTMLHint = require("htmlhint").HTMLHint,
+      path = require('path');
+
+  grunt.registerMultiTask('htmlhint_inline', 'Validate inline html with htmlhint', function () {
+    var done = this.async(),
+        log = grunt.log,
+        output = '';
+
+    var options = this.options({
+      force: false,
+      reporterOutput: null,
+      patterns: [],
+      htmlhintrc: null
+    });
+
+    var force = options.force;
+    delete options.force;
+
+    var reporterOutput = options.reporterOutput;
+    delete options.reporterOutput;
+
+    var patterns = options.patterns;
+    delete options.patterns;
+
+    var htmlhintrc = options.htmlhintrc
+    delete options.htmlhintrc
+
+    var ignore = options.ignore;
+    delete options.ignore;
+
+    if (htmlhintrc) {
+      var _htmlhintrc = grunt.file.readJSON(htmlhintrc);
+      // set to the default options value
+      grunt.util._.defaults(options, _htmlhintrc);
+    }
+
+    // output pre hook
+    if (reporterOutput) {
+      grunt.util.hooker.hook(process.stdout, 'write', {
+        pre: function(stdout) {
+          output += stdout;
+          // https://github.com/cowboy/javascript-hooker#hookerpreempt
+          return grunt.util.hooker.preempt();
+        }
+      });
+    }
+
+    var tempFiles = lintinline.wrapReporter(options, this.filesSrc, ignore, patterns),
+        tempFilesLength = Object.keys(tempFiles).length,
+        hintCount = 0, eachCount = 0;
+
+    Object.keys(tempFiles).forEach(function( file ) {
+        var realFilePath = tempFiles[file]['filepath'],
+            file = grunt.file.read( file ),
+            msg = "Linting " + realFilePath + "...",
+            messages;
+
+        if (file.length) {
+          messages = HTMLHint.verify(file, options);
+
+          log.write(msg);
+
+          (messages.length > 0)? log.error() :  log.ok();
+
+          messages.forEach(function( message ) {
+            log.writeln(
+              "[".red + ( "L" + message.line ).yellow +":".red +
+              ( "C" + message.col ).yellow + "]".red + ' ' + message.message.yellow
+            );
+
+            var evidence = message.evidence,
+                col = message.col;
+            if (col === 0) {
+                evidence = '?'.red + evidence;
+            } else if(col > evidence.length) {
+                evidence = evidence + ' '.red;
+            } else {
+                evidence = evidence.slice(0, col - 1) + evidence[col - 1].red + evidence.slice(col);
+            }
+            log.writeln(evidence);
+            hintCount ++;
+          });
+        }
+        else { log.writeln( "Skipping empty file " + file); }
+
+        if (reporterOutput) {
+          var destDir = path.dirname(reporterOutput);
+          if (eachCount >= tempFilesLength) {
+            grunt.util.hooker.unhook(process.stdout, 'write');
+          }
+
+          if (!grunt.file.exists(destDir)) {
+            grunt.file.mkdir(destDir);
+            grunt.file.write(options.filePath, '');
+          }
+
+          reporterOutput = grunt.template.process(reporterOutput);
+          grunt.file.write(reporterOutput, output);
+        }
+
+        eachCount++;
+
+        if ( hintCount > 0 ) return force;
+
+        log.ok(
+          tempFilesLength + ' file' +
+          (tempFilesLength === 1 ? '' : 's') + ' lint free.'
+        );
+    });
+  });
+};