Skip to content

Commit 731a39d

Browse files
Rel1cxRel1cx
committed
docs: update rules section in mono-plugin readmes to use eslint-react.xyz links
1 parent 9c6b2a3 commit 731a39d

File tree

6 files changed

+9
-87
lines changed

6 files changed

+9
-87
lines changed

‎packages/plugins/eslint-plugin-react-debug/README.md

Lines changed: 1 addition & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -39,9 +39,4 @@ export default [
3939

4040
## Rules
4141

42-
| Rule | Description | 💭 | |
43-
| :------------------- | :------------------------------------------------------- | :-: | :-: |
44-
| `class-component` | Reports all class components. | | |
45-
| `function-component` | Reports all function components. | | |
46-
| `hook` | Reports all react hooks. | | |
47-
| `is-from-react` | Reports all identifiers that are initialized from React. | | |
42+
<https://eslint-react.xyz/docs/rules/overview#debug-rules>

‎packages/plugins/eslint-plugin-react-dom/README.md

Lines changed: 1 addition & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -48,17 +48,4 @@ export default [
4848

4949
## Rules
5050

51-
| Rule | Description | 💭 | |
52-
| :------------------------------------------- | :-------------------------------------------------------------------------------------- | :-: | :-: |
53-
| `no-children-in-void-dom-elements` | Prevents usage of `children` in void `DOM elements`. | | |
54-
| `no-dangerously-set-innerhtml-with-children` | Prevents `DOM element` using `dangerouslySetInnerHTML` and `children` at the same time. | | |
55-
| `no-dangerously-set-innerhtml` | Prevents `DOM element` using `dangerouslySetInnerHTML`. | | |
56-
| `no-find-dom-node` | Prevents usage of `findDOMNode`. | | |
57-
| `no-missing-button-type` | Enforces explicit `type` attribute for `<button>` elements. | | |
58-
| `no-missing-iframe-sandbox` | Enforces explicit `sandbox` attribute for `iframe` elements. | | |
59-
| `no-namespace` | Enforces the absence of a `namespace` in React elements. | | |
60-
| `no-render-return-value` | Prevents usage of the return value of `ReactDOM.render`. | | |
61-
| `no-script-url` | Prevents usage of `javascript:` URLs as the value of certain attributes. | | |
62-
| `no-unknown-property` | Prevents usage of unknown DOM property. | | 🔧 |
63-
| `no-unsafe-iframe-sandbox` | Enforces `sandbox` attribute for `iframe` elements is not set to unsafe combinations. | | |
64-
| `no-unsafe-target-blank` | Prevents usage of `target="_blank"` without `rel="noreferrer noopener"`. | | |
51+
<https://eslint-react.xyz/docs/rules/overview#dom-rules>

‎packages/plugins/eslint-plugin-react-hooks-extra/README.md

Lines changed: 1 addition & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -39,10 +39,4 @@ export default [
3939

4040
## Rules
4141

42-
| Rule | Description | 💭 | |
43-
| :------------------------------------- | :------------------------------------------------------------------------ | :-: | :-: |
44-
| `no-direct-set-state-in-use-effect` | Disallow direct calls to the `set` function of `useState` in `useEffect`. | | |
45-
| `no-redundant-custom-hook` | Warns when custom Hooks that don't use other Hooks. | | |
46-
| `no-unnecessary-use-callback` | Disallow unnecessary usage of `useCallback`. | | |
47-
| `no-unnecessary-use-memo` | Disallow unnecessary usage of `useMemo`. | | |
48-
| `prefer-use-state-lazy-initialization` | Warns function calls made inside `useState` calls. | | |
42+
<https://eslint-react.xyz/docs/rules/overview#hooks-extra-rules>

‎packages/plugins/eslint-plugin-react-naming-convention/README.md

Lines changed: 1 addition & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -38,9 +38,4 @@ export default [
3838

3939
## Rules
4040

41-
| Rule | Description | 💭 | |
42-
| :------------------- | :----------------------------------------------------------------------------------------- | :-: | :-: |
43-
| `component-name` | Enforces naming conventions for components. | | |
44-
| `filename` | Enforces naming convention for JSX files. | | |
45-
| `filename-extension` | Enforces consistent use of the JSX file extension. | | |
46-
| `use-state` | Enforces destructuring and symmetric naming of `useState` hook value and setter variables. | | |
41+
<https://eslint-react.xyz/docs/rules/overview#naming-convention-rules>

‎packages/plugins/eslint-plugin-react-web-api/README.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -37,15 +37,15 @@ export default [
3737

3838
## Rules
3939

40+
<https://eslint-react.xyz/docs/rules/overview#web-api-rules>
41+
42+
## Rules to be implemented
43+
4044
| Rule | Description | 💭 | |
4145
| :-------------------------------------- | :-------------------------------------------- | :-: | :-: |
42-
| `no-leaked-timeout` | Prevents leaked `setTimeout` | | |
43-
| `no-leaked-interval` | Prevents leaked `setInterval` | | |
4446
| `no-leaked-idle-callback` | Prevents leaked `requestIdleCallback` | | 🚧 |
4547
| `no-leaked-animation-frame` | Prevents leaked `requestAnimationFrame` | | 🚧 |
4648
| `no-leaked-event-source` | Prevents leaked `EventSource` | | 🚧 |
47-
| `no-leaked-event-listener` | Prevents leaked `addEventListener` | | |
48-
| `no-leaked-resize-observer` | Prevents leaked `ResizeObserver` | | |
4949
| `no-leaked-intersection-observer` | Prevents leaked `IntersectionObserver` | | 🚧 |
5050
| `no-leaked-mutation-observer` | Prevents leaked `MutationObserver` | | 🚧 |
5151
| `no-leaked-performance-observer` | Prevents leaked `PerformanceObserver` | | 🚧 |

‎packages/plugins/eslint-plugin-react-x/README.md

Lines changed: 1 addition & 50 deletions
Original file line numberDiff line numberDiff line change
@@ -73,53 +73,4 @@ export default [
7373

7474
## Rules
7575

76-
| Rule | Description | 💭 | |
77-
| :--------------------------------------- | :--------------------------------------------------------------------------------------------------- | :-: | :-: |
78-
| `ensure-forward-ref-using-ref` | Requires that components wrapped with `forwardRef` must have a `ref` parameter. | | |
79-
| `jsx-no-duplicate-props` | Prevents duplicate props in JSX. | | |
80-
| `jsx-uses-vars` | Prevents variables used in JSX to be marked as unused. | | |
81-
| `no-access-state-in-setstate` | Prevents accessing `this.state` inside `setState` calls. | | |
82-
| `no-array-index-key` | Prevents using array `index` as `key`. | | |
83-
| `no-children-count` | Prevents using `Children.count`. | | |
84-
| `no-children-for-each` | Prevents using `Children.forEach`. | | |
85-
| `no-children-map` | Prevents using `Children.map`. | | |
86-
| `no-children-only` | Prevents using `Children.only`. | | |
87-
| `no-children-prop` | Prevents using `children` as a prop. | | |
88-
| `no-children-to-array` | Prevents using `Children.toArray`. | | |
89-
| `no-class-component` | Prevents using class component. | | |
90-
| `no-clone-element` | Prevents using `cloneElement`. | | |
91-
| `no-comment-textnodes` | Prevents comments from being inserted as text nodes. | | |
92-
| `no-complex-conditional-rendering` | Prevents complex conditional rendering in JSX. | | |
93-
| `no-component-will-mount` | Prevents using `componentWillMount`. | | |
94-
| `no-component-will-receive-props` | Prevents using `componentWillReceiveProps`. | | |
95-
| `no-component-will-update` | Prevents using `componentWillUpdate`. | | |
96-
| `no-context-provider` | Prevents using `<Context.Provider>`. | | 🔧 |
97-
| `no-create-ref` | Prevents using `createRef`. | | |
98-
| `no-default-props` | Prevents using `defaultProps` property in favor of ES6 default parameters. | | |
99-
| `no-direct-mutation-state` | Prevents direct mutation of `this.state`. | | |
100-
| `no-duplicate-key` | Prevents duplicate `key` on elements in the same array or a list of `children`. | | |
101-
| `no-forward-ref` | Prevents using `forwardRef`. | | 🔧 |
102-
| `no-implicit-key` | Prevents `key` from not being explicitly specified (e.g. spreading `key` from objects). | | |
103-
| `no-leaked-conditional-rendering` | Prevents problematic leaked values from being rendered. | 💭 | |
104-
| `no-missing-component-display-name` | Enforces that all components have a `displayName` which can be used in devtools. | | |
105-
| `no-missing-key` | Prevents missing `key` on items in list rendering. | | |
106-
| `no-nested-components` | Prevents nesting component definitions inside other components. | | |
107-
| `no-prop-types` | Prevents using `propTypes` in favor of TypeScript or another type-checking solution. | | |
108-
| `no-redundant-should-component-update` | Prevents using `shouldComponentUpdate` when extending `React.PureComponent`. | | |
109-
| `no-set-state-in-component-did-mount` | Prevents calling `this.setState` in `componentDidMount` outside of functions, such as callbacks. | | |
110-
| `no-set-state-in-component-did-update` | Prevents calling `this.setState` in `componentDidUpdate` outside of functions, such as callbacks. | | |
111-
| `no-set-state-in-component-will-update` | Prevents calling `this.setState` in `componentWillUpdate` outside of functions, such as callbacks. | | |
112-
| `no-string-refs` | Prevents using deprecated string `refs`. | | |
113-
| `no-unsafe-component-will-mount` | Warns the usage of `UNSAFE_componentWillMount` in class components. | | |
114-
| `no-unsafe-component-will-receive-props` | Warns the usage of `UNSAFE_componentWillReceiveProps` in class components. | | |
115-
| `no-unsafe-component-will-update` | Warns the usage of `UNSAFE_componentWillUpdate` in class components. | | |
116-
| `no-unstable-context-value` | Prevents non-stable values (i.e. object literals) from being used as a value for `Context.Provider`. | | |
117-
| `no-unstable-default-props` | Prevents using referential-type values as default props in object destructuring. | | |
118-
| `no-unused-class-component-members` | Warns unused class component methods and properties. | | |
119-
| `no-unused-state` | Warns unused class component state. | | |
120-
| `no-useless-fragment` | Prevents using useless `fragment` components or `<>` syntax. | | |
121-
| `prefer-destructuring-assignment` | Enforces using destructuring assignment over property assignment. | | |
122-
| `prefer-react-namespace-import` | Enforces using `React` namespace import over default import. | | 🔧 |
123-
| `prefer-read-only-props` | Enforce read-only props in components. | 💭 | |
124-
| `prefer-shorthand-boolean` | Enforces using shorthand syntax for boolean attributes. | | 🔧 |
125-
| `prefer-shorthand-fragment` | Enforces using shorthand syntax for fragments. | | |
76+
<https://eslint-react.xyz/docs/rules/overview#core-rules>

0 commit comments

Comments
 (0)