Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/poppinlp/grunt-htmlhint-plus
Grunt task to hint html code. Support template.
https://github.com/poppinlp/grunt-htmlhint-plus
grunt grunt-htmlhint grunt-plugins grunt-task gruntplugin hint html htmlhint
Last synced: about 2 months ago
JSON representation
Grunt task to hint html code. Support template.
- Host: GitHub
- URL: https://github.com/poppinlp/grunt-htmlhint-plus
- Owner: poppinlp
- License: mit
- Created: 2014-07-22T08:45:54.000Z (over 10 years ago)
- Default Branch: master
- Last Pushed: 2023-02-28T12:38:57.000Z (almost 2 years ago)
- Last Synced: 2024-04-14T19:37:53.815Z (9 months ago)
- Topics: grunt, grunt-htmlhint, grunt-plugins, grunt-task, gruntplugin, hint, html, htmlhint
- Language: JavaScript
- Size: 355 KB
- Stars: 7
- Watchers: 3
- Forks: 3
- Open Issues: 9
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE
Awesome Lists containing this project
README
# Grunt-htmlhint-plus
[![Build Status][ci-img]][ci-url]
[![Code style][lint-img]][lint-url]
[![NPM version][npm-ver-img]][npm-url]
[![NPM downloads][npm-dl-img]][npm-url]
[![NPM license][npm-lc-img]][npm-url]
Grunt task to hint html code.
__LOOKING FOR CONTRIBUTOR TO MAINTAIN THIS REPO!__
## Getting Started
This plugin requires Grunt >=0.4.0
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 i -D grunt-htmlhint-plus
```
Once the plugin has been installed, it may be enabled inside your Gruntfile with this line of JavaScript:
```js
grunt.loadNpmTasks('grunt-htmlhint-plus');
```
## Htmlhintplus Task
_Run this task with the `grunt htmlhintplus` command._
Task targets, files and options may be specified according to the grunt [Configuring tasks](http://gruntjs.com/configuring-tasks) guide.
## Options
### src {String|Array}
Source path. Support file path, glob and globs.
### options.rules {Object}
Htmlhint rules. Default is:
- "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": false,
- "spec-char-escape": true,
- "id-unique": true,
- "src-not-empty": true,
- "head-script-disabled": false,
- "img-alt-require": true,
- "doctype-html5": true,
- "id-class-value": "dash",
- "style-disabled": false,
- "space-tab-mixed-disabled": true,
- "id-class-ad-disabled": true,
- "href-abs-or-rel": true,
- "attr-unsafe-chars": true
For the whole rules list, please see [Rules page](https://github.com/yaniswang/HTMLHint/wiki/Rules).
### options.htmlhintrc {String}
Htmlhintrc file path. Has higher priority than `rules` option.
### options.force {Boolean}
Throw fatal fail or not at the end of this task, when there is hint error. Default `false`.
### options.newer {Boolean}
Only hint changed file and new file. Default `true`.
### options.ignore {Object}
Ignore strings between key and value from this object. Default `{}`.
### options.customRules {Array}
An array of paths to custom rule files to load and use in your HTMLHinting. See [issue #47](https://github.com/yaniswang/HTMLHint/issues/47) on the [HTMLHint project](https://github.com/yaniswang/HTMLHint). For examples of how to write a custom rule.
### options.extendRules {Boolean}
Extend the default rules instead of only running the rules specified. Default `false`.
### options.output {String|Array}
A string or array of output file types for reporting. Multiple types can also be selected separating them with a pipe character (ex: `console|checkstyle|json`). Available output types include `console`, `default` (alias for console), `text`, `json`, and `checkstyle`. Default `console`.
## Usage Examples
### Basic
```js
// Project configuration
htmlhintplus: {
build: {
options: {
rules: {
'tag-pair': true,
'custom-rule': true
},
customRules: [
'rules/custom-rule.js'
],
extendRules: true,
output: [ 'console', 'text', 'json', 'checkstyle' ]
}
src: 'path/to/file'
}
}
```
### Use htmlhintrc file
```js
// Project configuration
htmlhintplus: {
html: {
options: {
htmlhintrc: 'path/to/file'
}
src: [
'path/to/file',
'path/to/file2'
]
}
}
```
### Use global options
```js
// Project configuration
htmlhintplus: {
options: {
htmlhintrc: 'path/to/file',
newer: true
},
build: {
options: {
force: false
},
src: [
'path/1/*.html',
'path/2/**/*.html'
]
}
}
```
## Demo
Run the test demo:
```shell
grunt test
```
[ci-img]:https://img.shields.io/travis/poppinlp/grunt-htmlhint-plus.svg?style=flat-square
[ci-url]:https://travis-ci.org/poppinlp/grunt-htmlhint-plus
[lint-img]:https://img.shields.io/badge/code%20style-handsome-brightgreen.svg?style=flat-square
[lint-url]:https://github.com/poppinlp/eslint-config-handsome
[npm-ver-img]:https://img.shields.io/npm/v/grunt-htmlhint-plus.svg?style=flat-square
[npm-dl-img]:https://img.shields.io/npm/dm/grunt-htmlhint-plus.svg?style=flat-square
[npm-lc-img]:https://img.shields.io/npm/l/grunt-htmlhint-plus.svg?style=flat-square
[npm-url]:https://www.npmjs.com/package/grunt-htmlhint-plus