HTML linter for Bootstrap projects

bookmarklet bootlint bootstrap html linter

Перейти к файлу

Chris Rebert ff402fac0b v0.1.1		2014-07-22 09:24:20 -07:00
dist/browser	checkin /dist/	2014-07-20 20:08:32 -07:00
src	apply API changes to cli.js too	2014-07-21 21:25:58 -07:00
test	add JSHint global decls to generic-qunit.js	2014-07-20 20:06:25 -07:00
.editorconfig	add editorconfig via yeoman	2014-07-11 01:24:21 -07:00
.gitignore	Initial commit	2014-07-02 07:55:13 -07:00
.jscsrc	fix/integrate JSCS	2014-07-11 03:11:31 -07:00
.jshintrc	get initial browserify'd version working	2014-07-20 16:59:14 -07:00
.travis.yml	fix #36	2014-07-18 16:38:21 -07:00
CONTRIBUTING.md	we're lazy and we're not doing anything exotic and we don't support old browsers	2014-07-11 05:32:05 -07:00
Gruntfile.js	ensure browserified version regenerated before qunit test is performed	2014-07-20 20:04:14 -07:00
LICENSE	Update LICENSE	2014-07-12 21:07:06 -07:00
README.md	add "What's Bootlint?" section to README	2014-07-20 21:13:12 -07:00
package.json	v0.1.1	2014-07-22 09:24:20 -07:00

README.md

Bootlint

An HTML linter for Bootstrap projects

What's Bootlint?

Bootlint is a tool that checks for several common HTML mistakes in webpages that are using Bootstrap in a fairly "vanilla" way. Vanilla Bootstrap's components/widgets require their parts of the DOM to conform to certain structures. Bootlint checks that instances of Bootstrap components have correctly-structured HTML. Optimal usage of Bootstrap also requires that your pages include certain <meta> tags, an HTML5 doctype declaration, etc.; Bootlint checks that these are present.

Caveats

Bootlint assumes that your webpage is already valid HTML5. If you need to check HTML5 validity, we recommend tools like vnu.jar, grunt-html, or grunt-html-validation.

Bootlint assumes that you are using Bootstrap's default class names in your webpage, as opposed to taking advantage of the "mixins" functionality of Less or Sass to map them to custom class names. If you are using mixins, Bootlint may report some false-positive warnings. However, there are some Bootlint checks that are applicable even if you are using mixins pervasively.

Getting Started

On the command line

Install the module with: npm install -g bootlint

Run it on some HTML files:

$ bootlint /path/to/some/webpage.html another_webpage.html [...]

This will output the lint warnings applicable to each file.

In the browser

Download the code.

In your webpage:

<script src="dist/browser/bootlint.js"></script>

Then check the JavaScript console for lint warning messages.

API Documentation

Bootlint is a CommonJS module.

Browser

Bootlint exports a bootlint property on the global window object. In a browser environment, the following public APIs are available:

bootlint.lintCurrentDocument(): Lints the HTML of the current document and returns the linting results.
- Returns an array of lint warning strings
bootlint.showLintReportForCurrentDocument(): Lints the HTML of the current document and reports the linting results to the user.
- If there are any lint warnings, one general notification message will be window.alert()-ed to the user. Each warning will be output individually using console.warn().
- Returns nothing (i.e. undefined)

Node.js

Example:

var bootlint = require('bootlint');
bootlint.lintHtml("<!DOCTYPE html><html>..."); // returns list of lint warning messages

In a Node.js environment, Bootlint exposes the following public API:

bootlint.lintHtml(html): Lints the given HTML for a webpage and returns the linting results.
- Has 1 required parameter: the HTML to lint, as a string
- Returns an array of lint warning strings

Contributing

The project's coding style is laid out in the JSHint and JSCS configurations. Add unit tests for any new or changed functionality. Lint and test your code using Grunt.

Also, please don't edit files in the "dist" subdirectory as they are generated via Grunt. You'll find source code in the "lib" subdirectory!

Release History

(Nothing yet)