initial commit

Author: kazu69

.gitignore

@@ -0,0 +1,3 @@
+.DS_Store
+*.log
+node_modules

.htlmhintrc

@@ -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,15 @@
+{
+  "asi": true,
+  "curly": true,
+  "eqeqeq": true,
+  "immed": true,
+  "latedef": true,
+  "newcap": true,
+  "noarg": true,
+  "sub": true,
+  "undef": true,
+  "boss": true,
+  "eqnull": true,
+  "node": true,
+  "indent": 4
+}

LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2015 kazu69
+
+Permission is hereby granted, free of charge, to any person obtaining
+ a copy of this software and associated documentation files (the 
+ "Software"), to deal in the Software without restriction, including 
+ without limitation the rights to use, copy, modify, merge, publish, 
+ distribute, sublicense, and/or sell copies of the Software, and to 
+ permit persons to whom the Software is furnished to do so, subject to 
+ the following conditions:
+
+The above copyright notice and this permission notice shall be 
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, 
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF 
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND 
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE 
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION 
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION 
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

Readme.md

@@ -0,0 +1,154 @@
+gulp-htmlhint-inline
+================
+
+## Usage
+
+First, install `gulp-htmlhint-inline` as a development dependency:
+
+```shell
+npm install --save-dev gulp-htmlhint-inline
+```
+
+Then, add it to your `gulpfile.js`:
+
+```javascript
+var gulp = require('gulp'),
+    htmlhint_inline = require('gulp-htmlhint-inline');
+
+gulp.task('htmlhint', function () {
+  var options = {
+        htmlhintrc: './.htmlhintrc',
+        ignores: {
+          '<?php': '?>'
+        },
+        patterns: [
+          {
+            match: /hoge/g,
+            replacement: 'fuga'
+          }
+        ]
+    };
+
+  gulp.src('test/*.phtml')
+      .pipe(htmlhint_inline(options))
+      .pipe(htmlhint_inline.reporter())
+      .pipe(htmlhint_inline.reporter('fail'));
+});
+```
+
+## 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
+}
+```
+
+#### ignores
+Type: Object Default: {}
+
+Remove program tag pairs.
+
+#### patterns
+Type: Array Default: []
+
+Enable the replacement by the pattern
+
+##### patterns.match
+
+Type: RegExp|String
+
+Indicates the matching expression.
+
+##### patterns.replacement
+
+Type: String | Function
+
+#### reporter
+
+##### Default Reporter
+
+```js
+var gulp = require('gulp'),
+    htmlhint_inline = require('gulp-htmlhint-inline');
+
+gulp.task('htmlhint', function () {
+  var options = {
+        htmlhintrc: './.htmlhintrc',
+        ignores: {
+          '<?php': '?>'
+        }
+    };
+
+  gulp.src('test/*.phtml')
+      .pipe(htmlhint_inline(options))
+      .pipe(htmlhint_inline.reporter());
+});
+```
+
+##### Fail Reporter
+
+In order to end the task when your task happened error of HTMLHint, please use this reporter.
+
+```js
+var gulp = require('gulp'),
+    htmlhint_inline = require('gulp-htmlhint-inline');
+
+gulp.task('htmlhint', function () {
+  var options = {
+        htmlhintrc: './.htmlhintrc',
+        ignores: {
+          '<?php': '?>'
+        }
+    };
+
+  gulp.src('test/*.phtml')
+      .pipe(htmlhint_inline(options))
+      .pipe(htmlhint_inline.reporter('fail'));
+});
+```
+
+##### Custom Reporter
+
+You can also use the custom reporter that you have created.
+
+```js
+
+var gulp = require('gulp'),
+    htmlhint_inline = require('gulp-htmlhint-inline');
+
+gulp.task('htmlhint', function () {
+  var options = {
+        htmlhintrc: './.htmlhintrc',
+        ignores: {
+          '<?php': '?>'
+        }
+    };
+
+    var cutomReporter = function (file) {
+        if (!file.htmlhint_inline.success) {
+            console.log('custom reporter: htmlhint-inline fail in '+ file.path);
+        }
+    }
+
+    return gulp.src('test/*.phtml')
+                .pipe(htmlhint_inline(options))
+                .pipe(htmlhint_inline.reporter())
+                .pipe(htmlhint_inline.reporter(cutomReporter));
+});
+
+```
+
+## License
+
+[MIT License](http://en.wikipedia.org/wiki/MIT_License)
+
+[npm-url]: https://npmjs.org/package/gulp-htmlhint-inline
+[npm-image]: https://badge.fury.io/js/gulp-htmlhint-inline.png

gulpfile.js

@@ -0,0 +1,31 @@
+'use strict';
+
+var gulp = require('gulp'),
+    jshint = require('gulp-jshint'),
+    htmlhint_inline = require('./index.js');
+
+gulp.task('lint', function () {
+    return gulp.src('./*.js')
+                .pipe(jshint())
+                .pipe(jshint.reporter('default', { verbose: true }))
+                .pipe(jshint.reporter('fail'));
+});
+
+gulp.task('test', ['lint'], function () {
+    var options = {
+        htmlhintrc: './.htmlhintrc',
+        ignores: {
+            '<?php': '?>'
+        },
+        patterns: [
+            {
+                match: /hoge/g,
+                replacement: 'fuga'
+            }
+        ]
+    };
+    return gulp.src('test/*.phtml')
+                .pipe(htmlhint_inline(options))
+                .pipe(htmlhint_inline.reporter())
+                .pipe(htmlhint_inline.reporter('fail'));
+});