Skip to content

Latest commit

 

History

History
114 lines (71 loc) · 2.29 KB

README.md

File metadata and controls

114 lines (71 loc) · 2.29 KB
Raw

vile-htmllint

A Vile plugin for identifying common style and maintainability issues in your HTML files (via htmllint).

NOTICE

This project is not actively maintained. If you want to help maintain the project, or if you have a better alternative to switch to, please open an issue and ask!

Requirements

Installation

npm i -D vile vile-htmllint

Config File

By default, config uses .htmllintrc.

You can specify a custom one, instead:

htmllint:
  config: htmllint.json

Or, you can specify inline rules:

htmllint:
  config:
    doctype-html5: true

Ignoring Files

vile.ignore is used as a base, but you can add onto it:

htmllint:
  ignore: [
    "some/path/**"
    "file",
    "dir"
  ]

Plugins

This will pass these values to htmllint.use.

htmllint:
  config:
    plugins: [ "a_plugin" ]

Versioning

This project uses Semver.

Licensing

This project is licensed under the MPL-2.0 license.

Any contributions made to this project are made under the current license.

Contributions

Current list of Contributors.

Any contributions are welcome and appreciated!

All you need to do is submit a Pull Request.

  1. Please consider tests and code quality before submitting.
  2. Please try to keep commits clean, atomic and well explained (for others).

Issues

Current issue tracker is on GitHub.

Even if you are uncomfortable with code, an issue or question is welcome.

Code Of Conduct

By participating in this project you agree to our Code of Conduct.

Developing

cd vile-htmllint
npm install
npm test

To run compile task with file watch in the background:

npm run dev

To run tests with coverage:

npm run test-cov

See package.json for other available scripts.

Architecture

  • src is es6+ syntax compiled with Babel
  • lib generated js library
  • test is any test code, written in CoffeeScript
  • .test where coffeescript is generated to