Skip to content

waldronmatt/html-validate-webpack-plugin

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

15 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

html-validate-webpack-plugin

An html-validate.org plugin for webpack

About plugin

This plugin is a simple wrapper around the html-validate.org cli for automatic validation after each webpack compilation.

Install

npm install html-validate-webpack-plugin --save-dev

Note: Install html-validate and create a .htmlvalidate.json at the project root with your configurations.

npm install html-validate --save-dev

Usage

In your webpack configuration (development builds):

const HtmlValidatePlugin = require('html-validate-webpack-plugin');

module.exports = {
  // ...
  plugins: [
    // ...
    new HtmlValidatePlugin(),
    // ...
  ],
  // ...
};

Options

You can pass select html-validate.org cli options.

path

  • Type: String
  • Default: 'src/**/*'

Specifies the directories/files for html-validate to search.

extensions

  • Type: array
  • Default: ['html']

Specifies the file extensions to use when searching for files in directories.

config

  • Type: String
  • Default: '.htmlvalidate.json'

Specify a different configuration file.

Note: For your custom configuration omit the .json extension and supply the name only.

global

  • Type: boolean
  • Default: false

Specify the run context of html-validate.

Note: If you installed html-validate globally, set the value to true.

Features

  • html-validate performs all validation locally which means you can use html-validate and html-validate-webpack-plugin offline.
  • html-validate-webpack-plugin contains minimal dependencies.

Contributing

Pull requests are welcome! For major changes, please open an issue first to discuss what you would like to change.

License

MIT

About

An HTML-validate.org plugin for webpack

Topics

Resources

License

Code of conduct

Security policy

Stars

Watchers

Forks

Sponsor this project