Skip to content

A code quality bookmarklet and command-line tool

License

Notifications You must be signed in to change notification settings

curtisj44/HTML-Lint

Repository files navigation

HTML-Lint

version on NPM weekly downloads on NPM

HTML-Lint is a tool designed to supplement HTML validation by identify coding practices that pass validation, but are less than ideal.

How to Use:

Option 1: Bookmarklet

  1. Copy the code below:
    javascript: (function(){'use strict';var script = document.createElement('script');script.src = 'https://curtisj44.github.io/HTML-Lint/dist/htmlLint.min.js';script.id = 'html-lint-js';document.body.appendChild(script);}());
  2. Create a new bookmark.
  3. Set the name to “HTML-Lint” and paste the above as the URL.

Option 2: CLI

Sample verbose output

Available on NPM: npmjs.com/package/html-lint: npm install html-lint -g.

Usage

html-lint <url> <filename>

Options

--strict     Return a non-zero exit code if lint errors are found
--verbose    Enable verbose output

Examples

html-lint http://www.google.com
html-lint http://www.google.com --verbose
html-lint http://www.google.com foo

Development

Getting Started

  1. Have the following requirements installed: Node, NPM, and PhantomJS
  2. Clone the repo: git clone https://github.com/curtisj44/HTML-Lint.git
  3. Run npm install
  4. Run gulp

Tasks

  • gulp → compiles Sass to CSS, concatenates JS, minifies CSS and JS, and watches
  • gulp watch → runs default gulp task and then watches for changes

Testing the CLI locally

  1. Run node html-lint.js <url>