https://github.com/htmlhint/grunt-htmlhint

Validate html files with htmlhint.
https://github.com/htmlhint/grunt-htmlhint

grunt grunt-htmlhint grunt-plugins gruntfile hint htmlhint javascript

Last synced: about 2 months ago
JSON representation

Validate html files with htmlhint.

• Host: GitHub
• URL: https://github.com/htmlhint/grunt-htmlhint
• Owner: htmlhint
• License: mit
• Created: 2013-04-06T01:00:11.000Z (over 11 years ago)
• Default Branch: master
• Last Pushed: 2022-12-11T13:47:46.000Z (about 2 years ago)
• Last Synced: 2024-11-02T06:48:04.460Z (2 months ago)
• Topics: grunt, grunt-htmlhint, grunt-plugins, gruntfile, hint, htmlhint, javascript
• Language: JavaScript
• Homepage:
• Size: 304 KB
• Stars: 61
• Watchers: 5
• Forks: 13
• Open Issues: 12
• Metadata Files:
  • Readme: README.md
  • Contributing: CONTRIBUTING.md
  • License: LICENSE.md
  • Code of conduct: CODE_OF_CONDUCT.md

Awesome Lists containing this project

README

        


  


  Grunt HTMLHint

  




Lint HTML files with HTMLHint




  

    

  

  

    

  

  

    

  

  

  

    

  

  

    

  





  How To Use • Contributing • Roadmap • Website



## Table of Contents

- **[Getting Started](#getting-started)**

- **[Usage](#usage)**

- **[Options](#options)**

## Getting Started

This plugin requires Grunt `~0.4.1`

If you haven't used [Grunt](https://gruntjs.com/) before, be sure to check out the [Getting Started](https://gruntjs.com/getting-started) guide, as it explains how to create a [Gruntfile](https://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 --save-dev

```

One the plugin has been installed, it may be enabled inside your Gruntfile with this line of JavaScript:

```js

grunt.loadNpmTasks('grunt-htmlhint');

```

## Usage

### Overview

In your project's Gruntfile, add a section named `htmlhint` to the data object passed into `grunt.initConfig()`.

### Options

See all rules here: [https://github.com/htmlhint/HTMLHint/wiki/Rules](https://github.com/htmlhint/HTMLHint/wiki/Rules)

If options is empty, task will scan nothing.

#### options.htmlhintrc

Type: `String`

Default value: `null`

If this filename is specified, options and globals defined therein will be used. Task and target options override the options within the `htmlhintrc` file. The `htmlhintrc` file must be valid JSON and looks something like this:

```json

{

  "tag-pair": true,

}

```

#### options.force

Type: `Boolean`

Default value: `false`

Report HTMLHint errors but dont fail the task

### Usage Examples

#### Direct options

```js

htmlhint: {

  html1: {

    options: {

      'tag-pair': true

    },

    src: ['path/to/**/*.html']

  },

  html2: {

    options: {

      'tag-pair': true

    },

    src: ['path/to/**/*.html']

  }

}

```

#### Config file

```js

htmlhint: {

  options: {

    htmlhintrc: '.htmlhintrc'

  },

  html1: {

    src: ['path/to/**/*.html']

  },

  html2: {

    src: ['path/to/**/*.html']

  }

}

```

## Licence

Project initially created by [@yaniswang](https://github.com/yaniswang) and transferred to the [HTMLHint](https://github.com/htmlhint) organization.



[MIT License](./LICENSE)