Skip to content

Commit 1ebfd21

Browse files
committed
docs: update rules overview page
1 parent 8e5dbf3 commit 1ebfd21

File tree

1 file changed

+61
-61
lines changed

1 file changed

+61
-61
lines changed

website/pages/rules/overview.md

Lines changed: 61 additions & 61 deletions
Original file line numberDiff line numberDiff line change
@@ -2,76 +2,76 @@
22

33
## JSX
44

5-
- [`jsx/max-depth`](jsx-max-depth) - enforce a maximum depth that JSX can be nested.
6-
- [`jsx/no-array-index-key`](jsx-no-array-index-key) - disallow using Array index as `key`.
7-
- [`jsx/no-comment-textnodes`](jsx-no-comment-textnodes) - disallow comments from being inserted as text nodes.
8-
- [`jsx/no-complicated-conditional-rendering`](jsx-no-complicated-conditional-rendering) - disallow complicated conditional rendering.
9-
- [`jsx/no-duplicate-key`](jsx-no-duplicate-key) - disallow duplicate keys in `key` prop when rendering list.
10-
- [`jsx/no-leaked-conditional-rendering`](jsx-no-leaked-conditional-rendering) - disallow problematic leaked values from being rendered.
11-
- [`jsx/no-missing-key`](jsx-no-missing-key) - require `key` prop when rendering list.
12-
- [`jsx/no-spreading-key`](jsx-no-spreading-key) - disallow spreading `key` from objects.
13-
- [`jsx/no-useless-fragment`](jsx-no-useless-fragment) - disallow unnecessary fragments.
14-
- [`jsx/prefer-shorthand-boolean`](jsx-prefer-shorthand-boolean) - enforce `boolean` attributes notation in JSX.
15-
- [`jsx/prefer-shorthand-fragment`](jsx-prefer-shorthand-fragment) - enforce using fragment syntax instead of `Fragment` component.
5+
- [`jsx/max-depth`](jsx-max-depth)
6+
- [`jsx/no-array-index-key`](jsx-no-array-index-key)
7+
- [`jsx/no-comment-textnodes`](jsx-no-comment-textnodes)
8+
- [`jsx/no-complicated-conditional-rendering`](jsx-no-complicated-conditional-rendering)
9+
- [`jsx/no-duplicate-key`](jsx-no-duplicate-key)
10+
- [`jsx/no-leaked-conditional-rendering`](jsx-no-leaked-conditional-rendering)
11+
- [`jsx/no-missing-key`](jsx-no-missing-key)
12+
- [`jsx/no-spreading-key`](jsx-no-spreading-key)
13+
- [`jsx/no-useless-fragment`](jsx-no-useless-fragment)
14+
- [`jsx/prefer-shorthand-boolean`](jsx-prefer-shorthand-boolean)
15+
- [`jsx/prefer-shorthand-fragment`](jsx-prefer-shorthand-fragment)
1616

1717
## React
1818

19-
- [`react/ensure-forward-ref-using-ref`](react-ensure-forward-ref-using-ref) - requires that components wrapped with `forwardRef` must have a `ref` parameter.
20-
- [`react/no-children-count`](react-no-children-count) - disallow `Children.count`.
21-
- [`react/no-children-for-each`](react-no-children-for-each) - disallow `Children.forEach`.
22-
- [`react/no-children-in-void-dom-elements`](react-no-children-in-void-dom-elements) - disallow passing `children` to void DOM elements.
23-
- [`react/no-children-map`](react-no-children-map) - disallow `Children.map`.
24-
- [`react/no-children-only`](react-no-children-only) - disallow `Children.only`.
25-
- [`react/no-children-prop`](react-no-children-prop) - disallow passing of `children` as props.
26-
- [`react/no-children-to-array`](react-no-children-to-array) - disallow `Children.toArray`.
27-
- [`react/no-class-component`](react-no-class-component) - disallow `class component`.
28-
- [`react/no-clone-element`](react-no-clone-element) - disallow `cloneElement`.
29-
- [`react/no-component-will-mount`](react-no-component-will-mount) - disallow `componentWillMount`.
30-
- [`react/no-component-will-receive-props`](react-no-component-will-receive-props) - disallow `componentWillReceiveProps`.
31-
- [`react/no-component-will-update`](react-no-component-will-update) - disallow `componentWillUpdate`.
32-
- [`react/no-constructed-context-value`](react-no-constructed-context-value) - disallow passing constructed values to context providers.
33-
- [`react/no-create-ref`](react-no-create-ref) - disallow `createRef` in function components.
34-
- [`react/no-dangerously-set-innerhtml`](react-no-dangerously-set-innerhtml) - disallow when a DOM element is using `dangerouslySetInnerHTML`.
35-
- [`react/no-dangerously-set-innerhtml-with-children`](react-no-dangerously-set-innerhtml-with-children) - disallow when a DOM element is using both `children` and `dangerouslySetInnerHTML`.
36-
- [`react/no-direct-mutation-state`](react-no-direct-mutation-state) - disallow direct mutation of `this.state`.
37-
- [`react/no-find-dom-node`](react-no-find-dom-node) - disallow `findDOMNode`.
38-
- [`react/no-missing-button-type`](react-no-missing-button-type) - enforce that `button` elements have an explicit `type` attribute.
39-
- [`react/no-missing-component-display-name`](react-no-missing-component-display-name) - enforce `displayName` for `memo` and `forwardRef` components.
40-
- [`react/no-missing-iframe-sandbox`](react-no-missing-iframe-sandbox) - enforce that `iframe` elements explicitly specify a `sandbox` attribute.
41-
- [`react/no-namespace`](react-no-namespace) - enforce that namespaces are not used in React elements.
42-
- [`react/no-redundant-should-component-update`](react-no-redundant-should-component-update) - disallow usage of `shouldComponentUpdate` in class component extends `React.PureComponent`.
43-
- [`react/no-render-return-value`](react-no-render-return-value) - disallow usage of the return value of `ReactDOM.render`.
44-
- [`react/no-script-url`](react-no-script-url) - disallow `javascript:` URLs as JSX event handler prop's value.
45-
- [`react/no-set-state-in-component-did-mount`](react-no-set-state-in-component-did-mount) - disallow usage of `this.setState` in `componentDidMount`.
46-
- [`react/no-set-state-in-component-did-update`](react-no-set-state-in-component-did-update) - disallow usage of `this.setState` in `componentDidUpdate`.
47-
- [`react/no-set-state-in-component-will-update`](react-no-set-state-in-component-will-update) - disallow usage of `this.setState` in `componentWillUpdate`.
48-
- [`react/no-string-refs`](react-no-string-refs) - disallow using deprecated string refs.
49-
- [`react/no-unsafe-component-will-mount`](react-no-unsafe-component-will-mount) - disallow usage of `UNSAFE_componentWillMount` in class components.
50-
- [`react/no-unsafe-component-will-receive-props`](react-no-unsafe-component-will-receive-props) - disallow usage of `UNSAFE_componentWillReceiveProps` in class components.
51-
- [`react/no-unsafe-component-will-update`](react-no-unsafe-component-will-update) - disallow usage of `UNSAFE_componentWillUpdate` in class components.
52-
- [`react/no-unsafe-iframe-sandbox`](react-no-unsafe-iframe-sandbox) - disallow unsafe `iframe` `sandbox` attribute combinations.
53-
- [`react/no-unsafe-target-blank`](react-no-unsafe-target-blank) - disallow `target="_blank"` without `rel="noreferrer noopener"`.
54-
- [`react/no-unstable-default-props`](react-no-unstable-default-props) - disallow usage of unstable value as default param in function component.
55-
- [`react/no-unstable-nested-components`](react-no-unstable-nested-components) - disallow usage of unstable nested components.
56-
- [`react/no-unused-class-component-members`](react-no-unused-class-component-members) - disallow unused class component methods and properties.
57-
- [`react/prefer-destructuring-assignment`](react-prefer-destructuring-assignment) - enforce using destructuring assignment in component props and context.
19+
- [`react/ensure-forward-ref-using-ref`](react-ensure-forward-ref-using-ref)
20+
- [`react/no-children-count`](react-no-children-count)
21+
- [`react/no-children-for-each`](react-no-children-for-each)
22+
- [`react/no-children-in-void-dom-elements`](react-no-children-in-void-dom-elements)
23+
- [`react/no-children-map`](react-no-children-map)
24+
- [`react/no-children-only`](react-no-children-only)
25+
- [`react/no-children-prop`](react-no-children-prop)
26+
- [`react/no-children-to-array`](react-no-children-to-array)
27+
- [`react/no-class-component`](react-no-class-component)
28+
- [`react/no-clone-element`](react-no-clone-element)
29+
- [`react/no-component-will-mount`](react-no-component-will-mount)
30+
- [`react/no-component-will-receive-props`](react-no-component-will-receive-props)
31+
- [`react/no-component-will-update`](react-no-component-will-update)
32+
- [`react/no-constructed-context-value`](react-no-constructed-context-value)
33+
- [`react/no-create-ref`](react-no-create-ref)
34+
- [`react/no-dangerously-set-innerhtml`](react-no-dangerously-set-innerhtml)
35+
- [`react/no-dangerously-set-innerhtml-with-children`](react-no-dangerously-set-innerhtml-with-children)
36+
- [`react/no-direct-mutation-state`](react-no-direct-mutation-state)
37+
- [`react/no-find-dom-node`](react-no-find-dom-node)
38+
- [`react/no-missing-button-type`](react-no-missing-button-type)
39+
- [`react/no-missing-component-display-name`](react-no-missing-component-display-name)
40+
- [`react/no-missing-iframe-sandbox`](react-no-missing-iframe-sandbox)
41+
- [`react/no-namespace`](react-no-namespace)
42+
- [`react/no-redundant-should-component-update`](react-no-redundant-should-component-update)
43+
- [`react/no-render-return-value`](react-no-render-return-value)
44+
- [`react/no-script-url`](react-no-script-url)
45+
- [`react/no-set-state-in-component-did-mount`](react-no-set-state-in-component-did-mount)
46+
- [`react/no-set-state-in-component-did-update`](react-no-set-state-in-component-did-update)
47+
- [`react/no-set-state-in-component-will-update`](react-no-set-state-in-component-will-update)
48+
- [`react/no-string-refs`](react-no-string-refs)
49+
- [`react/no-unsafe-component-will-mount`](react-no-unsafe-component-will-mount)
50+
- [`react/no-unsafe-component-will-receive-props`](react-no-unsafe-component-will-receive-props)
51+
- [`react/no-unsafe-component-will-update`](react-no-unsafe-component-will-update)
52+
- [`react/no-unsafe-iframe-sandbox`](react-no-unsafe-iframe-sandbox)
53+
- [`react/no-unsafe-target-blank`](react-no-unsafe-target-blank)
54+
- [`react/no-unstable-default-props`](react-no-unstable-default-props)
55+
- [`react/no-unstable-nested-components`](react-no-unstable-nested-components)
56+
- [`react/no-unused-class-component-members`](react-no-unused-class-component-members)
57+
- [`react/prefer-destructuring-assignment`](react-prefer-destructuring-assignment)
5858

5959
## React Hooks
6060

61-
- [`react-hooks/ensure-custom-hooks-using-other-hooks`](react-hooks-ensure-custom-hooks-using-other-hooks) - enforce custom hooks using other hooks.
62-
- [`react-hooks/ensure-use-callback-has-non-empty-deps`](react-hooks-ensure-use-callback-has-non-empty-deps) - enforce `useCallback` has non-empty dependencies array.
63-
- [`react-hooks/ensure-use-memo-has-non-empty-deps`](react-hooks-ensure-use-memo-has-non-empty-deps) - enforce `useMemo` has non-empty dependencies array.
64-
- [`react-hooks/prefer-use-state-lazy-initialization`](react-hooks-prefer-use-state-lazy-initialization) - disallow function calls in `useState` that aren't wrapped in an initializer.
61+
- [`react-hooks/ensure-custom-hooks-using-other-hooks`](react-hooks-ensure-custom-hooks-using-other-hooks)
62+
- [`react-hooks/ensure-use-callback-has-non-empty-deps`](react-hooks-ensure-use-callback-has-non-empty-deps)
63+
- [`react-hooks/ensure-use-memo-has-non-empty-deps`](react-hooks-ensure-use-memo-has-non-empty-deps)
64+
- [`react-hooks/prefer-use-state-lazy-initialization`](react-hooks-prefer-use-state-lazy-initialization)
6565

6666
## Naming Convention
6767

68-
- [`naming-convention/component-name`](naming-convention-component-name) - enforce component naming convention to `PascalCase` or `CONSTANT_CASE`.
69-
- [`naming-convention/filename`](naming-convention-filename) - enforce naming convention for JSX file names.
70-
- [`naming-convention/filename-extension`](naming-convention-filename-extension) - enforce naming convention for JSX file extensions.
71-
- [`naming-convention/use-state`](naming-convention-use-state) - enforce destructuring and symmetric naming of `useState` hook value and setter variables.
68+
- [`naming-convention/component-name`](naming-convention-component-name)
69+
- [`naming-convention/filename`](naming-convention-filename)
70+
- [`naming-convention/filename-extension`](naming-convention-filename-extension)
71+
- [`naming-convention/use-state`](naming-convention-use-state)
7272

7373
## Debug
7474

75-
- [`debug/class-component`](debug-class-component) - report all class components, including anonymous ones.
76-
- [`debug/function-component`](debug-function-component) - report all function components, including anonymous ones.
77-
- [`debug/react-hooks`](debug-react-hooks) - report all React Hooks.
75+
- [`debug/class-component`](debug-class-component)
76+
- [`debug/function-component`](debug-function-component)
77+
- [`debug/react-hooks`](debug-react-hooks)

0 commit comments

Comments
 (0)