Skip to content

Commit 6b3d46e

Browse files
Rel1cxRel1cx
committed
docs: document configurable rules
1 parent b20f0e7 commit 6b3d46e

File tree

5 files changed

+24
-22
lines changed

5 files changed

+24
-22
lines changed

‎website/pages/docs/rules/dom-no-unknown-property.mdx‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -14,7 +14,7 @@ react-dom/no-unknown-property
1414

1515
**Features**
1616

17-
`🔍` `🔧`
17+
`🔍` `🔧` `⚙️`
1818

1919
**Presets**
2020

‎website/pages/docs/rules/naming-convention-filename-extension.mdx‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -14,7 +14,7 @@ react-naming-convention/filename-extension
1414

1515
**Features**
1616

17-
`🔍`
17+
`🔍` `⚙️`
1818

1919
## What it does
2020

‎website/pages/docs/rules/naming-convention-filename.mdx‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -14,7 +14,7 @@ react-naming-convention/filename
1414

1515
**Features**
1616

17-
`🔍`
17+
`🔍` `⚙️`
1818

1919
## What it does
2020

‎website/pages/docs/rules/no-useless-fragment.mdx‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -14,7 +14,7 @@ react-x/no-useless-fragment
1414

1515
**Features**
1616

17-
`🔍`
17+
`🔍` `⚙️`
1818

1919
**Presets**
2020

‎website/pages/docs/rules/overview.md‎

Lines changed: 20 additions & 18 deletions
Original file line numberDiff line numberDiff line change
@@ -5,6 +5,8 @@
55
- 💭 - Requires Type Information
66
- 🔍 - Diagnostic
77
- 🔧 - Fixable
8+
- ⚙️ - Configurable
9+
- 🐞 - Debug
810
- 🗑️ - Deprecated
911

1012
## Core Rules
@@ -53,7 +55,7 @@
5355
| [`no-unstable-default-props`](no-unstable-default-props) | `🔍` | Prevents using referential-type values as default props in object destructuring. |
5456
| [`no-unused-class-component-members`](no-unused-class-component-members) | `🔍` | Warns unused class component methods and properties. |
5557
| [`no-unused-state`](no-unused-state) | `🔍` | Warns unused class component state. |
56-
| [`no-useless-fragment`](no-useless-fragment) | `🔍` | Prevents using useless `fragment` components or `<>` syntax. |
58+
| [`no-useless-fragment`](no-useless-fragment) | `🔍` `⚙️` | Prevents using useless `fragment` components or `<>` syntax. |
5759
| [`prefer-destructuring-assignment`](prefer-destructuring-assignment) | `🔍` | Enforces using destructuring assignment over property assignment. |
5860
| [`prefer-react-namespace-import`](prefer-react-namespace-import) | `🔍` `🔧` | Enforce React is imported via a namespace import |
5961
| [`prefer-read-only-props`](prefer-read-only-props) | `🔍` `💭` | Enforces read-only props in components. |
@@ -62,20 +64,20 @@
6264

6365
## DOM Rules
6466

65-
| Rule | Features | Description |
66-
| :--------------------------------------------------------------------------------------------- | :-------- | :-------------------------------------------------------------------------------------- |
67-
| [`no-children-in-void-dom-elements`](dom-no-children-in-void-dom-elements) | `🔍` | Prevents using `children` in void `DOM elements`. |
68-
| [`no-dangerously-set-innerhtml-with-children`](dom-no-dangerously-set-innerhtml-with-children) | `🔍` | Prevents `DOM element` using `dangerouslySetInnerHTML` and `children` at the same time. |
69-
| [`no-dangerously-set-innerhtml`](dom-no-dangerously-set-innerhtml) | `🔍` | Prevents `DOM element` using `dangerouslySetInnerHTML`. |
70-
| [`no-find-dom-node`](dom-no-find-dom-node) | `🔍` | Prevents using `findDOMNode`. |
71-
| [`no-missing-button-type`](dom-no-missing-button-type) | `🔍` | Enforces explicit `type` attribute for `<button>` elements. |
72-
| [`no-missing-iframe-sandbox`](dom-no-missing-iframe-sandbox) | `🔍` | Enforces explicit `sandbox` attribute for `iframe` elements. |
73-
| [`no-namespace`](dom-no-namespace) | `🔍` | Enforces the absence of a `namespace` in React elements. |
74-
| [`no-render-return-value`](dom-no-render-return-value) | `🔍` | Prevents using the return value of `ReactDOM.render`. |
75-
| [`no-script-url`](dom-no-script-url) | `🔍` | Prevents using `javascript:` URLs as the value of certain attributes. |
76-
| [`no-unknown-property`](dom-no-unknown-property) | `🔍` `🔧` | Prevents using unknown `DOM` property |
77-
| [`no-unsafe-iframe-sandbox`](dom-no-unsafe-iframe-sandbox) | `🔍` | Enforces `sandbox` attribute for `iframe` elements is not set to unsafe combinations. |
78-
| [`no-unsafe-target-blank`](dom-no-unsafe-target-blank) | `🔍` | Prevents using `target="_blank"` without `rel="noreferrer noopener"`. |
67+
| Rule | Features | Description |
68+
| :--------------------------------------------------------------------------------------------- | :------------ | :-------------------------------------------------------------------------------------- |
69+
| [`no-children-in-void-dom-elements`](dom-no-children-in-void-dom-elements) | `🔍` | Prevents using `children` in void `DOM elements`. |
70+
| [`no-dangerously-set-innerhtml-with-children`](dom-no-dangerously-set-innerhtml-with-children) | `🔍` | Prevents `DOM element` using `dangerouslySetInnerHTML` and `children` at the same time. |
71+
| [`no-dangerously-set-innerhtml`](dom-no-dangerously-set-innerhtml) | `🔍` | Prevents `DOM element` using `dangerouslySetInnerHTML`. |
72+
| [`no-find-dom-node`](dom-no-find-dom-node) | `🔍` | Prevents using `findDOMNode`. |
73+
| [`no-missing-button-type`](dom-no-missing-button-type) | `🔍` | Enforces explicit `type` attribute for `<button>` elements. |
74+
| [`no-missing-iframe-sandbox`](dom-no-missing-iframe-sandbox) | `🔍` | Enforces explicit `sandbox` attribute for `iframe` elements. |
75+
| [`no-namespace`](dom-no-namespace) | `🔍` | Enforces the absence of a `namespace` in React elements. |
76+
| [`no-render-return-value`](dom-no-render-return-value) | `🔍` | Prevents using the return value of `ReactDOM.render`. |
77+
| [`no-script-url`](dom-no-script-url) | `🔍` | Prevents using `javascript:` URLs as the value of certain attributes. |
78+
| [`no-unknown-property`](dom-no-unknown-property) | `🔍` `🔧` `⚙️` | Prevents using unknown `DOM` property |
79+
| [`no-unsafe-iframe-sandbox`](dom-no-unsafe-iframe-sandbox) | `🔍` | Enforces `sandbox` attribute for `iframe` elements is not set to unsafe combinations. |
80+
| [`no-unsafe-target-blank`](dom-no-unsafe-target-blank) | `🔍` | Prevents using `target="_blank"` without `rel="noreferrer noopener"`. |
7981

8082
## Web API Rules
8183

@@ -101,9 +103,9 @@
101103

102104
| Rule | Features | Description |
103105
| :----------------------------------------------------------- | :------- | :----------------------------------------------------------------------------------------- |
104-
| [`component-name`](naming-convention-component-name) | `🔍` | Enforces naming conventions for components. |
105-
| [`filename`](naming-convention-filename) | `🔍` | Enforces naming convention for JSX files. |
106-
| [`filename-extension`](naming-convention-filename-extension) | `🔍` | Enforces consistent use of the JSX file extension. |
106+
| [`component-name`](naming-convention-component-name) | `🔍` `⚙️` | Enforces naming conventions for components. |
107+
| [`filename`](naming-convention-filename) | `🔍` `⚙️` | Enforces naming convention for JSX files. |
108+
| [`filename-extension`](naming-convention-filename-extension) | `🔍` `⚙️` | Enforces consistent use of the JSX file extension. |
107109
| [`use-state`](naming-convention-use-state) | `🔍` | Enforces destructuring and symmetric naming of `useState` hook value and setter variables. |
108110

109111
## Debug Rules

0 commit comments

Comments
 (0)