|
1 | 1 | # grunt-html-html-reporter |
2 | 2 |
|
3 | | -[](http://badge.fury.io/js/grunt-html-html-reporter) |
4 | | -[](https://travis-ci.org/prantlf/grunt-html-html-reporter) |
5 | | -[](https://david-dm.org/prantlf/grunt-html-html-reporter) |
6 | | -[](https://david-dm.org/prantlf/grunt-html-html-reporter#info=devDependencies) |
7 | | -[](https://github.com/semantic-release/semantic-release) |
8 | | - |
9 | | -[](https://www.npmjs.com/package/grunt-html-html-reporter) |
| 3 | +[ |
| 4 | +  |
| 5 | +](https://www.npmjs.com/package/grunt-html-html-reporter) |
| 6 | +[](https://codecov.io/gh/prantlf/grunt-html-html-reporter) |
10 | 7 |
|
11 | 8 | A custom reporter for [grunt-html] - the HTML validation task - which formats the validation results to HTML. There is a [Grunt] task available for converting already written report files, which uses this reporter - [grunt-html-html-report-converter]. |
12 | 9 |
|
13 | 10 | ## Installation |
14 | 11 |
|
15 | 12 | You can use the reporter programmatically. In that case you do not need [Grunt] as stated below. You can also use the reporter directly with the [grunt-html] task. The reporter is usually installed and used together with other development tasks. |
16 | 13 |
|
17 | | -You need [node >= 6][node], [npm] and [grunt >= 0.4][Grunt] installed and your project build managed by a [Gruntfile] with the necessary modules listed in [package.json], including [grunt-html]. If you haven't used Grunt before, be sure to check out the [Getting Started] guide, as it explains how to create a Gruntfile as well as install and use Grunt plugins. Once you're familiar with that process, you may install this plugin with this command: |
| 14 | +You need [node >= 6][node] and [grunt >= 0.4][Grunt] installed and your project build managed by a [Gruntfile] with the necessary modules listed in [package.json], including [grunt-html]. If you haven't used Grunt before, be sure to check out the [Getting Started] guide, as it explains how to create a Gruntfile as well as install and use Grunt plugins. Once you're familiar with that process, you may install this plugin with your favourite package manager: |
18 | 15 |
|
19 | 16 | ```sh |
20 | | -$ npm install grunt-html-html-reporter --save-dev |
| 17 | +npm i -D grunt-html-html-reporter |
| 18 | +pnpm i -D grunt-html-html-reporter |
| 19 | +yarn add -D grunt-html-html-reporter |
21 | 20 | ``` |
22 | 21 |
|
23 | 22 | ## Programmatic Usage |
@@ -69,29 +68,13 @@ htmllint: { |
69 | 68 |
|
70 | 69 | In lieu of a formal styleguide, take care to maintain the existing coding style. |
71 | 70 |
|
72 | | -## Release History |
73 | | - |
74 | | - * 2018-05-14 v3.1.0 Allow cutting the same initial part of the path from tested HTML files for displaying purposes |
75 | | - * 2018-04-27 v3.0.0 Dropped support of Node.js 4 |
76 | | - * 2018-03-05 v2.2.0 Allow generating page titles from file names without directory |
77 | | - * 2018-03-04 v2.1.0 Add filtering and accessibility to the reports |
78 | | - * 2018-03-01 v2.0.0 Change the HTML format to look like Koa11y reports |
79 | | - * 2018-03-01 v1.0.0 Release a stable version using a simple HTML format |
80 | | - * 2018-02-28 v0.2.4 Add \<meta charset="utf-8"\> to the HTML page |
81 | | - * 2018-01-27 v0.2.2 Do not report unknown messqge types as notices |
82 | | - * 2017-11-25 v0.2.1 Support Node.js < 7 |
83 | | - * 2017-11-24 v0.2.0 Fix recognition of warnings, |
84 | | - say "notices" instead of "notes" |
85 | | - * 2017-11-24 v0.0.1 Initial release |
86 | | - |
87 | 71 | ## License |
88 | 72 |
|
89 | 73 | Copyright (c) 2017-2022 Ferdinand Prantl |
90 | 74 |
|
91 | 75 | Licensed under the MIT license. |
92 | 76 |
|
93 | 77 | [node]: http://nodejs.org |
94 | | -[npm]: http://npmjs.org |
95 | 78 | [package.json]: https://docs.npmjs.com/files/package.json |
96 | 79 | [Grunt]: https://gruntjs.com |
97 | 80 | [Gruntfile]: http://gruntjs.com/sample-gruntfile |
|
0 commit comments