# grunt-html-dev-master
> Grunt plugin for html validation, using vnu.jar from the master branch for the actual validation
Latest version **18.4.28** (published 2018-04-27) · MIT license · 0 weekly downloads
## Install
```sh
npm install grunt-html-dev-master
pnpm add grunt-html-dev-master
yarn add grunt-html-dev-master
bun add grunt-html-dev-master
```
## Health
**Score 15/100 (F)** — status: abandoned.
Positive: no vulnerabilities.
Warnings: low downloads; no types; no esm support.
Negative: abandoned; low maintenance score.
## Facts
| | |
|---|---|
| Version | 18.4.28 |
| Published | 2018-04-27 |
| First published | 2018-02-09 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | CommonJS |
| Node | >=6 |
| Dependencies | 3 |
| Unpacked size | 21.3 KB |
| Known vulnerabilities | 0 (+1 in 1 direct dependencies) |
| Install scripts | no |
| GitHub stars | 1 |
| Author | Jörn Zaefferer |
| Maintainers | prantlf |
| Keywords | gruntplugin |
## Links
- npm: https://www.npmjs.com/package/grunt-html-dev-master
- Repository: https://github.com/prantlf/grunt-html
- Issues: https://github.com/prantlf/grunt-html/issues
- npm.io page: https://npm.io/package/grunt-html-dev-master
## Dependencies (3)
- [async](https://npm.io/package/async.md) 2.6.0
- [chalk](https://npm.io/package/chalk.md) 2.4.1
- [vnu-jar-master](https://npm.io/package/vnu-jar-master.md) 18.4.8
## Recent versions
- 18.4.28 (latest) — 2018-04-27
- 18.4.27 — 2018-04-27
- 18.4.8 — 2018-04-08
- 18.2.9 — 2018-02-09
## README
# grunt-html-dev-master
[](https://travis-ci.org/jzaefferer/grunt-html)
[](https://ci.appveyor.com/project/jzaefferer/grunt-html/branch/master)
[](https://codeclimate.com/github/jzaefferer/grunt-html)
[](https://david-dm.org/jzaefferer/grunt-html)
[](https://david-dm.org/jzaefferer/grunt-html#info=devDependencies)
[Grunt][grunt] plugin for HTML validation, using the [vnu.jar markup checker][vnujar].
This fork publishes a new `grunt-html-dev-master` NPM module, which depends on `vnu-jar-master` instead of the latest release of `vnu-jar`. The [W3C Markup Validation Service](https://validator.w3.org/) uses the *development version* - `vnu-jar@dev` too. If you want to get consistent results from on-line and off-line testing, you should use `grunt-html-master` or `grunt-html-dev` instead of `grunt-html` in your project.
## Getting Started
Install this grunt plugin next to your project's [Gruntfile.js][getting_started] with:
```bash
npm install grunt-html-dev-master --save-dev
```
Then add this line to your project's `Gruntfile.js`:
```js
grunt.loadNpmTasks('grunt-html-dev-master');
```
Then specify what files to validate in your config:
```js
grunt.initConfig({
htmllint: {
all: ['demos/**/*.html', 'tests/**/*.html']
}
});
```
For fast validation, keep that in a single group, as the validator initialization takes a few seconds.
When combined with a watching task (such as [grunt-contrib-watch][watch]), even faster validation can be achieved by starting the validator in client mode and connecting to an already-running instance of the validator in server mode. This removes the time required by repeated initializations. See the `server` option below.
## Options
### `ignore`
* Type: `Array`, `String`, or `RegExp`
* Default: `null`
Use this to specify the error message(s) to ignore. For example:
```js
all: {
options: {
ignore: 'The “clear” attribute on the “br” element is obsolete. Use CSS instead.'
},
src: 'html4.html'
}
```
The `ignore` option also supports regular expressions. For example, to ignore AngularJS directive attributes:
```js
all: {
options: {
ignore: /attribute “ng-[a-z-]+” not allowed/
},
src: 'app.html'
}
```
### `server`
* Type: `Object`, or a falsy value
* Default: `false`
When `server` is set to a falsy value, the validator is invoked using `java -jar`, which can be considered normal operation.
Set `server` to an object to start the validator in client mode and connect to an already-running instance of the validator in server mode.
To start the validator in server mode, use `java -cp "path/to/vnu.jar" nu.validator.servlet.Main `.
```js
all: {
options: {
// connect to a validator instance running in server mode on localhost:8888
server: {}
},
src: 'app.html'
}
```
The `server` object also accepts the `host` and `port` keys, specifying the location of the server.
```js
all: {
options: {
server: {
// your team's local dev tool machine, for example
host: '192.168.0.5',
port: 8877
}
},
src: 'app.html'
}
```
The following configuration in Gruntfile.js uses [grunt-vnuserver][vnuserver] to start the validator in server mode and sets up a watch task to run `htmllint` every time the source file changes.
By starting the validator in server mode once using the `vnuserver` task, validations by `htmllint` can be performed much faster by simply connecting to this already-running server.
```js
module.exports = function (grunt) {
grunt.initConfig({
vnuserver: {
},
htmllint: {
all: {
options: {
server: {}
},
src: 'app.html'
}
},
watch: {
all: {
tasks: ['htmllint'],
files: 'app.html'
}
}
});
grunt.loadNpmTasks('grunt-vnuserver');
grunt.loadNpmTasks('grunt-html-dev-master');
grunt.loadNpmTasks('grunt-contrib-watch');
grunt.registerTask('default', ['vnuserver', 'watch']);
};
```
### `errorlevels`
* Type: `Array`
* Default: `'info','warning','error'`
Set `errorlevels` to control which error types are returned from the validator. Ignores all other returned types.
### `force`
* Type: `Boolean`
* Default: `false`
Set `force` to `true` to report errors but not fail the `grunt` task.
### `reporter`
* Type: `String`
* Default: `null`
Allows you to modify the output format. By default, this plugin will use a built-in Grunt reporter. Set the path to your own custom reporter or to one of the provided reporters: `checkstyle`, `junit` or `json`.
### `reporterOutput`
* Type: `String`
* Default: `null`
Specify a filepath to output the results of a reporter. If `reporterOutput` is specified then all output will be written to the given filepath rather than printed to `stdout`.
### `absoluteFilePathsForReporter`
* Type: `Boolean`
* Default: `false`
Set `absoluteFilePathsForReporter` to `true` to use absolute file paths in generated reports.
## Travis CI potential pitfalls
Since vnu.jar requires Java 9 environment, you might have trouble setting Travis CI to work with grunt-html.
In that case see [this patch](https://github.com/jquery/jquery-ui/commit/ff3769272bb5530b224297fa5d2add1865acbb7f)
and the [Travis CI doc page](https://docs.travis-ci.com/user/trusty-ci-environment/).
## License
Copyright Jörn Zaefferer.
Licensed under the MIT license.
[grunt]: http://gruntjs.com/
[getting_started]: http://gruntjs.com/getting-started
[vnujar]: https://validator.github.io/validator/
[watch]: https://github.com/gruntjs/grunt-contrib-watch
[vnuserver]: https://www.npmjs.com/package/grunt-vnuserver
---
_Source: https://npm.io/package/grunt-html-dev-master · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._