markuplint
Version:
An HTML linter for all markup developers
149 lines (106 loc) • 6.06 kB
Markdown
# 
[](https://www.npmjs.com/package/markuplint)
[](https://www.npmjs.com/package/markuplint)
[](https://github.com/markuplint/markuplint/actions?query=workflow%3ATest)
[](https://coveralls.io/github/markuplint/markuplint?branch=main)
[](https://github.com/markuplint/markuplint)
[](https://twitter.com/intent/user?screen_name=markuplint)
**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.
## Instant using
```
$ npx markuplint target.html
```
Supported for _Node.js_ `v18.18.0` or later.
## Usage
### Initialization
Create a [configuration](https://markuplint.dev/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`:
```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.
--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.
--allow-warnings Return status code 0 even if there are warnings.
--allow-empty-input Return status code 1 even if there are no input files.
--show-config Output computed configuration of the target file. Supports "details" and empty. Default: empty.
--verbose Output with detailed information.
--include-node-modules Include files in node_modules directory. Default: false.
--severity-parse-error Specifies the severity level of parse errors. Supports "error", "warning", and "off". Default: "error".
--max-count Limit the number of violations shown. Default: 0 (no limit).
--max-warnings Number of warnings to trigger nonzero exit code. Default: -1 (no limit).
--init Initialize settings interactively.
--search Search lines of codes that include the target element by selectors.
--help, -h Show help.
--version, -v Show version.
Examples
$ markuplint verifyee.html --config path/to/.markuplintrc
$ markuplint "**/*.html" --max-count=10
$ cat verifyee.html | markuplint
```
## Documentation
- [Getting Started](https://markuplint.dev/getting-started)
- [Rules](https://markuplint.dev/rules)
- [Configuration](https://markuplint.dev/configuration)
- [API](https://markuplint.dev/api-docs)
## Playground
- [Playground](https://playground.markuplint.dev/)
## Editor Extensions
- [Visual Studio Code](https://marketplace.visualstudio.com/items?itemName=yusukehirao.vscode-markuplint)
## License
[](https://app.fossa.com/projects/git%2Bgithub.com%2Fmarkuplint%2Fmarkuplint?ref=badge_large)
## Sponsors
### Corporate Sponsors
[<img width="140" src="https://avatars.githubusercontent.com/u/1551649" alt="Velc" />](https://www.velc.co.jp/)
### Personal Supporters
[<img width="36" src="https://avatars.githubusercontent.com/u/91733847" alt="Tokitake" />](https://github.com/Tokitake)
[<img width="36" src="https://avatars.githubusercontent.com/u/1996642" alt="Okuto Oyama" />](https://github.com/yamanoku)
[<img width="36" src="https://avatars.githubusercontent.com/u/6581173" alt="miita" />](https://github.com/mikimhk)
[<img width="36" src="https://avatars.githubusercontent.com/u/111797" alt="Yasuo Fukuda" />](https://github.com/sigwyg)
[<img width="36" src="https://avatars.githubusercontent.com/u/91047157" alt="shamokit" />](https://github.com/shamokit)
[<img width="36" src="https://avatars.githubusercontent.com/u/18516475" alt="takanorip" />](https://github.com/takanorip)
Need [Sponsors❤️🔥](https://github.com/sponsors/markuplint)
## Thanks
This linter is inspired by:
- [HTMLHint](http://htmlhint.com/)
- [ESLint](https://eslint.org/)
- [Stylelint](https://stylelint.io/)
- [textlint](https://textlint.github.io/)