Skip to content

Commit

Permalink
docs(tag-check): Add example and explain all options
Browse files Browse the repository at this point in the history
  • Loading branch information
hyperupcall committed Nov 27, 2023
1 parent 21022c6 commit e567fe9
Showing 1 changed file with 56 additions and 2 deletions.
58 changes: 56 additions & 2 deletions docs/user-guide/rules/tags-check.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,61 @@ id: tags-check
title: tags-check
---

Allowing specify rules for any tag and validate that
Check if particular tags are self-closing or must include or exclude particular tags.

Level: `error`

## Config value

1. true: enable rule
2. false: disable rule
3. {}: configuration object, mapping values of tags to their respective configuration. Tags configuration can have properties of:

`selfclosing`

If an element is or is not self-closing, when it otherwise should be.

Level: `warn`

`attrsRequired`

If an element is missing an attribute that should exist.

Level: `error`

`redundantAttrs`

If an element has an attribute that is not necessary.

Level: `error`

`attrsOptional`

If an element has an attribute that is not included in the allowable set.

Level: `error`

### Example

```json
{
...
"tags-check": {
"a": {
"selfclosing": true,
"attrsRequired": ["href", "title"],
"redundantAttrs": ["alt"],
}
},
"script": {
"attrsOptional": [
["async", "async"],
["defer", "defer"],
],
},
...
}
```

The following pattern are **not** considered violations:

Expand All @@ -15,7 +69,7 @@ The following pattern are **not** considered violations:
<img src="bbb" title="aaa" alt="asd" />
```

The following pattern is considered violation:
The following pattern is considered a violation:

<!-- prettier-ignore -->
```html
Expand Down

0 comments on commit e567fe9

Please sign in to comment.