Skip to content

Commit 59a6c2e

Browse files
committedJul 25, 2022
doc: mention other HTML plugins in README
1 parent 26a62b8 commit 59a6c2e

File tree

1 file changed

+12
-3
lines changed

1 file changed

+12
-3
lines changed
 

‎README.md

+12-3
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,8 @@
77
</div>
88

99
- [Usage](#usage)
10-
- [Disable ESLint](#disable-eslint)
10+
- [Disabling ESLint](#disabling-eslint)
11+
- [Linting HTML](#linting-html)
1112
- [Multiple scripts tags in a HTML file](#multiple-scripts-tags-in-a-html-file)
1213
- [History](#history)
1314
- [XML support](#xml-support)
@@ -43,7 +44,7 @@ Example:
4344
}
4445
```
4546

46-
## Disable ESLint
47+
## Disabling ESLint
4748

4849
To temporarily disable ESLint, use the `<!-- eslint-disable -->` HTML comment. Re-enable it with
4950
`<!-- eslint enable -->`. Example:
@@ -69,6 +70,14 @@ comment. Example:
6970
Disabled script tags are completely ignored: their content will not be parsed as JavaScript. You can
7071
use this to disable script tags containing template syntax.
7172

73+
## Linting HTML
74+
75+
This plugin focuses on applying ESLint rules on inline scripts contained in HTML. It does not
76+
provide any rule related to HTML. For that, you can use other plugins like
77+
[`@eslint-html`](https://yeonjuan.github.io/html-eslint/) or
78+
[@angular-eslint](https://github.com/angular-eslint/angular-eslint). `eslint-plugin-html` is
79+
compatible with those plugins and can be used along them.
80+
7281
## Multiple scripts tags in a HTML file
7382

7483
When linting a HTML with multiple script tags, this plugin tries to emulate the browser behavior by
@@ -238,7 +247,7 @@ documentation](http://eslint.org/docs/user-guide/command-line-interface#ext).
238247
your script tags, the resulting script may not be valid JavaScript, so `ESLint` will fail to parse
239248
it. Here are some workarounds:
240249

241-
- You can use [HTML comments to disable ESLint](#disable-eslint) for specific script tags.
250+
- You can use [HTML comments to disable ESLint](#disabling-eslint) for specific script tags.
242251

243252
- For PHP, you can use
244253
[`eslint-plugin-php-markup`](https://github.com/tengattack/eslint-plugin-php-markup) to lint php

0 commit comments

Comments
 (0)
Please sign in to comment.