Skip to content

Commit 8ee322f

Browse files
Rel1cxRel1cx
committed
docs: add experimental status to rules overview
1 parent b7020a0 commit 8ee322f

File tree

1 file changed

+13
-12
lines changed

1 file changed

+13
-12
lines changed

‎apps/website/content/docs/rules/overview.mdx‎

Lines changed: 13 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -11,6 +11,7 @@ Linter rules can have false positives, false negatives, and some rules are depen
1111

1212
- 🌟 - Feature
1313
- ⚙️ - Configurable
14+
- 🧪 - Experimental
1415
- 🐞 - Debug
1516
- 💭 - Type Chcking
1617
- 🔧 - Fixable
@@ -37,7 +38,7 @@ Linter rules can have false positives, false negatives, and some rules are depen
3738
| [`no-class-component`](./no-class-component) | 0️⃣ | | Disallow class component | |
3839
| [`no-clone-element`](./no-clone-element) | 1️⃣ | | Disallow `cloneElement` | |
3940
| [`no-comment-textnodes`](./no-comment-textnodes) | 1️⃣ | | Prevents comments from being inserted as text nodes | |
40-
| [`no-complex-conditional-rendering`](./no-complex-conditional-rendering) | 0️⃣ | | Disallow complex conditional rendering in JSX expressions | |
41+
| [`no-complex-conditional-rendering`](./no-complex-conditional-rendering) | 0️⃣ | `🧪` | Disallow complex conditional rendering in JSX expressions | |
4142
| [`no-component-will-mount`](./no-component-will-mount) | 2️⃣ | `🔄` | Replaces usages of `componentWillMount` with `UNSAFE_componentWillMount` | >=16.3.0 |
4243
| [`no-component-will-receive-props`](./no-component-will-receive-props) | 2️⃣ | `🔄` | Replaces usages of `componentWillReceiveProps` with `UNSAFE_componentWillReceiveProps` | >=16.3.0 |
4344
| [`no-component-will-update`](./no-component-will-update) | 2️⃣ | `🔄` | Replaces usages of `componentWillUpdate` with `UNSAFE_componentWillUpdate` | >=16.3.0 |
@@ -48,7 +49,7 @@ Linter rules can have false positives, false negatives, and some rules are depen
4849
| [`no-duplicate-jsx-props`](./no-duplicate-jsx-props) | 1️⃣ | | Disallow duplicate props in JSX elements | |
4950
| [`no-duplicate-key`](./no-duplicate-key) | 2️⃣ | | Disallow duplicate `key` on elements in the same array or a list of `children` | |
5051
| [`no-forward-ref`](./no-forward-ref) | 1️⃣ | `🔄` | Replaces usages of `forwardRef` with passing `ref` as a prop | >=19.0.0 |
51-
| [`no-implicit-key`](./no-implicit-key) | 1️⃣ | | Prevents `key` from not being explicitly specified (e.g. spreading `key` from objects) | |
52+
| [`no-implicit-key`](./no-implicit-key) | 1️⃣ | `🧪` | Prevents `key` from not being explicitly specified (e.g. spreading `key` from objects) | |
5253
| [`no-leaked-conditional-rendering`](./no-leaked-conditional-rendering) | 1️⃣ | `💭` | Prevents problematic leaked values from being rendered | |
5354
| [`no-missing-component-display-name`](./no-missing-component-display-name) | 0️⃣ | | Enforces that all components have a `displayName` which can be used in devtools | |
5455
| [`no-missing-context-display-name`](./no-missing-context-display-name) | 0️⃣ | | Enforces that all contexts have a `displayName` which can be used in devtools | |
@@ -71,8 +72,8 @@ Linter rules can have false positives, false negatives, and some rules are depen
7172
| [`no-useless-forward-ref`](./no-useless-forward-ref) | 1️⃣ | | Disallow useless `forwardRef` calls on components that don't use `ref`s | |
7273
| [`no-useless-fragment`](./no-useless-fragment) | 0️⃣ | `🔧` `⚙️` | Disallow useless fragment elements | |
7374
| [`prefer-destructuring-assignment`](./prefer-destructuring-assignment) | 0️⃣ | | Enforces destructuring assignment for component props and context | |
74-
| [`prefer-react-namespace-import`](./prefer-react-namespace-import) | 0️⃣ | `🔧` | Enforces React is imported via a namespace import | |
75-
| [`prefer-read-only-props`](./prefer-read-only-props) | 0️⃣ | `💭` | Enforces read-only props in components | |
75+
| [`prefer-react-namespace-import`](./prefer-react-namespace-import) | 0️⃣ | `🧪` `🔧` | Enforces React is imported via a namespace import | |
76+
| [`prefer-read-only-props`](./prefer-read-only-props) | 0️⃣ | `🧪` `💭` | Enforces read-only props in components | |
7677
| [`prefer-shorthand-boolean`](./prefer-shorthand-boolean) | 0️⃣ | `🔧` | Enforces shorthand syntax for boolean attributes | |
7778
| [`prefer-shorthand-fragment`](./prefer-shorthand-fragment) | 0️⃣ | `🔧` | Enforces shorthand syntax for fragments | |
7879
| [`use-jsx-vars`](./use-jsx-vars) | 1️⃣ | | Marks variables used in JSX as used | |
@@ -109,14 +110,14 @@ Linter rules can have false positives, false negatives, and some rules are depen
109110

110111
## Hooks Extra Rules
111112

112-
| Rule | ✅ | Description |
113-
| :--------------------------------------------------------------------------------------------------- | :- | :----------------------------------------------------------------------------------------- |
114-
| [`no-direct-set-state-in-use-effect`](./hooks-extra-no-direct-set-state-in-use-effect) | 1️⃣ | Disallow direct calls to the `set` function of `useState` in `useEffect` |
115-
| [`no-direct-set-state-in-use-layout-effect`](./hooks-extra-no-direct-set-state-in-use-layout-effect) | 0️⃣ | Disallow direct calls to the `set` function of `useState` in `useLayoutEffect` |
116-
| [`no-unnecessary-use-callback`](./hooks-extra-no-unnecessary-use-callback) | 0️⃣ | Disallow unnecessary usage of `useCallback` |
117-
| [`no-unnecessary-use-memo`](./hooks-extra-no-unnecessary-use-memo) | 0️⃣ | Disallow unnecessary usage of `useMemo` |
118-
| [`no-unnecessary-use-prefix`](./hooks-extra-no-unnecessary-use-prefix) | 1️⃣ | Enforces that a function with the `use` prefix should use at least one Hook inside of it |
119-
| [`prefer-use-state-lazy-initialization`](./hooks-extra-prefer-use-state-lazy-initialization) | 0️⃣ | Enforces function calls made inside `useState` to be wrapped in an `initializer function` |
113+
| Rule | ✅ | 🌟 | Description |
114+
| :--------------------------------------------------------------------------------------------------- | :- | :------: | :----------------------------------------------------------------------------------------- |
115+
| [`no-direct-set-state-in-use-effect`](./hooks-extra-no-direct-set-state-in-use-effect) | 1️⃣ | `🧪` | Disallow direct calls to the `set` function of `useState` in `useEffect` |
116+
| [`no-direct-set-state-in-use-layout-effect`](./hooks-extra-no-direct-set-state-in-use-layout-effect) | 0️⃣ | `🧪` | Disallow direct calls to the `set` function of `useState` in `useLayoutEffect` |
117+
| [`no-unnecessary-use-callback`](./hooks-extra-no-unnecessary-use-callback) | 0️⃣ | `🧪` | Disallow unnecessary usage of `useCallback` |
118+
| [`no-unnecessary-use-memo`](./hooks-extra-no-unnecessary-use-memo) | 0️⃣ | `🧪` | Disallow unnecessary usage of `useMemo` |
119+
| [`no-unnecessary-use-prefix`](./hooks-extra-no-unnecessary-use-prefix) | 1️⃣ | | Enforces that a function with the `use` prefix should use at least one Hook inside of it |
120+
| [`prefer-use-state-lazy-initialization`](./hooks-extra-prefer-use-state-lazy-initialization) | 0️⃣ | `🧪` | Enforces function calls made inside `useState` to be wrapped in an `initializer function` |
120121

121122
## Naming Convention Rules
122123

0 commit comments

Comments
 (0)