# textlint-plugin-html

> textlint HTML plugin.

Latest version **1.0.1** (published 2024-08-09) · MIT license · 0 weekly downloads

## Install

```sh
npm install textlint-plugin-html
pnpm add textlint-plugin-html
yarn add textlint-plugin-html
bun add textlint-plugin-html
```

## Health

**Score 30/100 (F)** — status: abandoned.

Positive: has types; esm support; no vulnerabilities; high quality score.

Warnings: low downloads.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 1.0.1 |
| Published | 2024-08-09 |
| First published | 2015-10-29 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | bundled |
| Module format | ESM + CommonJS |
| Dependencies | 5 |
| Unpacked size | 29.4 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 26 |
| Author | azu |
| Maintainers | textlint-user, azu, 0x6b, taniguchi, kn1cht, pddg |
| Keywords | textlint, plugin, html, lint |

## Links

- npm: https://www.npmjs.com/package/textlint-plugin-html
- Repository: https://github.com/textlint/textlint-plugin-html
- Issues: https://github.com/textlint/textlint-plugin-html/issues
- npm.io page: https://npm.io/package/textlint-plugin-html

## Dependencies (5)

- [unified](https://npm.io/package/unified.md) ^10.1.2
- [neotraverse](https://npm.io/package/neotraverse.md) ^0.6.15
- [rehype-parse](https://npm.io/package/rehype-parse.md) ^8.0.4
- [structured-source](https://npm.io/package/structured-source.md) ^4.0.0
- [@textlint/ast-node-types](https://npm.io/package/@textlint/ast-node-types.md) ^13.0.5

## Alternatives

- [eslint-plugin-sonarjs](https://npm.io/package/eslint-plugin-sonarjs.md) — 2.9M weekly downloads
- [eslint-config-expo](https://npm.io/package/eslint-config-expo.md) — 1.5M weekly downloads
- [@matter/protocol](https://npm.io/package/@matter/protocol.md) — 63.5K weekly downloads
- [@eventcatalog/linter](https://npm.io/package/@eventcatalog/linter.md) — 24.8K weekly downloads
- [@pandacss/eslint-plugin](https://npm.io/package/@pandacss/eslint-plugin.md) — 18.7K weekly downloads

## Recent versions

- 1.0.1 (latest) — 2024-08-09
- 1.0.0 — 2023-01-29
- 0.3.0 — 2021-12-22
- 0.2.0 — 2018-08-08
- 0.1.7 — 2017-11-19
- 0.1.6 — 2017-11-18
- 0.1.5 — 2017-02-22
- 0.1.4 — 2016-05-09
- 0.1.3 — 2016-05-09
- 0.1.2 — 2015-10-29
- 0.1.1 — 2015-10-29

## README

# textlint-plugin-html [![Actions Status: test](https://github.com/textlint/textlint-plugin-html/workflows/test/badge.svg)](https://github.com/textlint/textlint-plugin-html/actions?query=workflow%3A"test")

Add HTML support for [textlint](https://github.com/textlint/textlint "textlint").

What is textlint plugin? Please see <https://github.com/textlint/textlint/blob/master/docs/plugin.md>

## Installation

    npm install textlint-plugin-html

Requirements:

- textlint v13+

## Default supported extensions

- `.html`
- `.htm`

## Usage

Manually add text plugin to do following:

```
{
    "plugins": [
        "html"
    ]
}
```

Lint HTML file with textlint

```
$ textlint index.html
```

### Options
 - `extensions`: `string[]`
    - Additional file extensions for html

For example, if you want to treat `.custom-ext` as html, put following config to `.textlintrc`

 ```json
{
    "plugins": {
        "html": {
            "extensions": [".custom-ext"]
        }
    }
}
```

## Tests

    npm test

## Development

If you update snapshot, please run `npm run updateSnapshot`.

### Add new test case

1. add new fixture file to `test/ast-test-case/<test-case-name>/index.html`
2. npm run updateSnapshot
3. check outputs

## Contributing

1. Fork it!
2. Create your feature branch: `git checkout -b my-new-feature`
3. Commit your changes: `git commit -am 'Add some feature'`
4. Push to the branch: `git push origin my-new-feature`
5. Submit a pull request :D

## License

MIT

---
_Source: https://npm.io/package/textlint-plugin-html · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._