markuplint

4.9.2 • Public • Published

markuplint

npm version Downloads Test Coverage Status GitHub Stars Follow us on Twitter

Peace of mind in your markup - An HTML linter for all markup developers.

Features

  • Conformance checking according to HTML Standard, WAI-ARIA, ARIA in HTML, etc.
  • Supports CSS and SVG values.
  • Supports React, Vue, Svelte, Alpine.js, HTMX, Pug, PHP, and more.
  • Possible to specify the rule for each element if you use CSS Selector.
  • Potential to create a custom rule.

Screenshot: Violation Report CLI output

Instant using

$ npx markuplint target.html

Supported for Node.js v18.18.0 or later.

Usage

Initialization

Create a configuration file and install dependencies.

$ npx markuplint --init
# or
$ yarn run markuplint --init

Answer questions interactively. By doing this, needed modules are installed, including markuplint.

Add a command to the scripts option on package.json:

{
  "scripts": {
    "lint:html": "markuplint **/*.html"
  }
}

If you want to change the target path, you can change it for your project.

Execute the script:

$ npm run lint:html
# or
$ yarn lint:html

Command line options

$ npx markuplint --help

Usage
	$ markuplint <HTML file paths (glob format)>
	$ <stdout> | markuplint

Options
	--config,                -c FILE_PATH  A configuration file path.
	--fix,                                 Fix HTML.
	--format,                -f FORMAT     Output format. Support "JSON", "Simple", "GitHub" and "Standard". Default: "Standard".
	--no-search-config                     No search a configure file automatically.
	--ignore-ext                           Evaluate files that are received even though the type of extension.
	--allow-warnings                       Return status code 0 even if there are warnings.
	--no-import-preset-rules               No import preset rules.
	--locale                               Locale of the message of violation. Default is an OS setting.
	--no-color,                            Output no color.
	--problem-only,          -p            Output only problems, without passeds.
	--verbose                              Output with detailed information.
	--include-node-modules                 Include files in node_modules directory. Default: false.

	--init                                 Initialize settings interactively.

	--help,                  -h            Show help.
	--version,               -v            Show version.

Examples
	$ markuplint verifyee.html --config path/to/.markuplintrc
	$ cat verifyee.html | markuplint

Documentation

Playground

Editor Extensions

License

FOSSA Status

Sponsors

Corporate Sponsors

Velc

Personal Supporters

Tokitake Okuto Oyama miita Yasuo Fukuda Hideyuki Saito shamokit

Need Sponsors❤️‍🔥

Thanks

This linter is inspired by:

Readme

Keywords

none

Package Sidebar

Install

npm i markuplint

Weekly Downloads

23,503

Version

4.9.2

License

MIT

Unpacked Size

68.1 kB

Total Files

61

Last publish

Collaborators

  • yusukehirao