@markuplint/rules
Rules
Conformance checking
| Avaiable | Docs | Docs(ja) | Rule | Fixable |
|---|---|---|---|---|
| ✅ | ✅ | ✅ | attr-duplication | 🚧 |
| ✅ | ✅ | ✅ | character-reference | 🚧 |
| 🚧 | 🚧 | 🚧 | comment | |
| ✅ | ✅ | ✅ | deprecated-attr | |
| ✅ | ✅ | ✅ | deprecated-element | |
| ✅ | ✅ | ✅ | doctype | 🚧 |
| ✅ | ✅ | ✅ | id-duplication | |
| ✅ | ✅ | ✅ | permitted-contents | |
| ✅ | ✅ | ✅ | required-attr |
Accessibility
| Avaiable | Docs | Docs(ja) | Rule | Fixable |
|---|---|---|---|---|
| 🚧 | 🚧 | 🚧 | accessible-text | |
| 🚧 | 🚧 | 🚧 | attr-role | |
| 🚧 | 🚧 | 🚧 | heading-in-sectioning-content | |
| 🚧 | 🚧 | 🚧 | heading-in-sectioning-root | |
| 🚧 | 🚧 | 🚧 | heading-levels-skipping | |
| 🚧 | 🚧 | 🚧 | labeling-controls | |
| ✅ | ✅ | ✅ | landmark-roles | |
| ✅ | ✅ | ✅ | required-h1 |
Usability
| Avaiable | Docs | Docs(ja) | Rule | Fixable |
|---|---|---|---|---|
| 🚧 | 🚧 | 🚧 | external-link | 🚧 |
Structure Design and Naming Convention
| Avaiable | Docs | Docs(ja) | Rule | Fixable |
|---|---|---|---|---|
| ✅ | ✅ | ✅ | class-naming | |
| 🚧 | 🚧 | 🚧 | custom-element-naming | |
| 🚧 | 🚧 | 🚧 | data-attr-naming | |
| 🚧 | 🚧 | 🚧 | required-element |
Style
| Avaiable | Docs | Docs(ja) | Rule | Fixable |
|---|---|---|---|---|
| ✅ | ✅ | ✅ | attr-equal-space-after | ✅ |
| ✅ | ✅ | ✅ | attr-equal-space-before | ✅ |
| ✅ | ✅ | ✅ | attr-spacing | ✅ |
| ✅ | ✅ | ✅ | attr-value-quotes | ✅ |
| ✅ | ✅ | ✅ | case-sensitive-attr-name | ✅ |
| ✅ | ✅ | ✅ | case-sensitive-tag-name | ✅ |
| 🚧 | 🚧 | 🚧 | comment-spasing | 🚧 |
| 🚧 | 🚧 | 🚧 | event-attr | |
| ✅ | ✅ | ✅ | indentation | ✅ |
| 🚧 | 🚧 | 🚧 | indentation-attr | 🚧 |
| 🚧 | 🚧 | 🚧 | path | |
| 🚧 | 🚧 | ✅ | self-closing-tag | 🚧 |
| 🚧 | 🚧 | 🚧 | tag-omission | 🚧 |
Install
This package is default used that dependenced by markuplint.
Prerequisites: Node.js (Version 12.4.0 or later)
$ npm install @markuplint/rules $ yarn add @markuplint/rulesContributing
$ git clone git@github.com:markuplint/markuplint.git -b master
$ yarn
$ yarn build
$ yarn test
Copyright © 2020 markuplint. Under the MIT License.
