Get unlimited public & private packages + package-based permissions with npm Pro.Get started »

grunt-html-val

0.1.0 • Public • Published

grunt-html-val

Validate HTML5 the simple way

Getting Started

This plugin requires Grunt ~0.4.2

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:

npm install grunt-html-val --save-dev

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

grunt.loadNpmTasks('grunt-html-val');

The "html_val" task

Overview

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

grunt.initConfig({
  html_val: {
    default: {
      src: ['**/*.html']
    },
  },
})

Options

options.imageAlt

Type: Boolean Default value: true

Validates the alt attribute of img tags

options.imageHeight

Type: Boolean Default value: true

Validates the height attribute of img tags

options.imageWidth

Type: Boolean Default value: true

Validates the width attribute of img tags

options.anchorTitle

Type: Boolean Default value: true

Validates the title attribute of anchors

options.singleQuotes

Type: Boolean Default value: true

Validates the single quotes attributes

options.scriptUnessaryAttr

Type: Boolean Default value: true

Validates the type and the language attribute of script tags

options.htmlLang

Type: Boolean Default value: true

Validates the lang attribute of the html tag

options.attrUppercase

Type: Boolean Default value: true

Validates all attributes uppercase'ness

Custom Options

In this example, custom options are used to prevent the validator from validating the lang attribute of the <html> tag and the warnings when using uppercase attributes such as HREF="".

grunt.initConfig({
  html_val: {
    options: {
      attrUppercase: false,
      htmlLang: false,
    },
    src: ['**/*.html']
  },
})

Contributing

In lieu of a formal styleguide, take care to maintain the existing coding style. Add unit tests for any new or changed functionality. Lint and test your code using Grunt.

Release History

(Nothing yet)

Keywords

none

Install

npm i grunt-html-val

DownloadsWeekly Downloads

0

Version

0.1.0

License

none

Last publish

Collaborators

  • avatar