Skip to content

Commit 93aead2

Browse files
committed
[readme] Move JSX-specific rules to their own section
Now that this list has grown considerably, I think it would be helpful to people to break it up a bit. A natural break is JSX-specific rules and non-JSX-specific rules.
1 parent 442d20b commit 93aead2

File tree

1 file changed

+39
-35
lines changed

1 file changed

+39
-35
lines changed

README.md

Lines changed: 39 additions & 35 deletions
Original file line numberDiff line numberDiff line change
@@ -74,6 +74,24 @@ Finally, enable all of the rules that you would like to use.
7474
"rules": {
7575
"react/display-name": 1,
7676
"react/forbid-prop-types": 1,
77+
"react/no-danger": 1,
78+
"react/no-deprecated": 1,
79+
"react/no-did-mount-set-state": 1,
80+
"react/no-did-update-set-state": 1,
81+
"react/no-direct-mutation-state": 1,
82+
"react/no-is-mounted": 1,
83+
"react/no-multi-comp": 1,
84+
"react/no-set-state": 1,
85+
"react/no-string-refs": 1,
86+
"react/no-unknown-property": 1,
87+
"react/prefer-es6-class": 1,
88+
"react/prop-types": 1,
89+
"react/react-in-jsx-scope": 1,
90+
"react/require-extension": 1,
91+
"react/self-closing-comp": 1,
92+
"react/sort-comp": 1,
93+
"react/wrap-multilines": 1,
94+
7795
"react/jsx-boolean-value": 1,
7896
"react/jsx-closing-bracket-location": 1,
7997
"react/jsx-curly-spacing": 1,
@@ -93,24 +111,7 @@ Finally, enable all of the rules that you would like to use.
93111
"react/jsx-sort-props": 1,
94112
"react/jsx-space-before-closing": 1,
95113
"react/jsx-uses-react": 1,
96-
"react/jsx-uses-vars": 1,
97-
"react/no-danger": 1,
98-
"react/no-deprecated": 1,
99-
"react/no-did-mount-set-state": 1,
100-
"react/no-did-update-set-state": 1,
101-
"react/no-direct-mutation-state": 1,
102-
"react/no-is-mounted": 1,
103-
"react/no-multi-comp": 1,
104-
"react/no-set-state": 1,
105-
"react/no-string-refs": 1,
106-
"react/no-unknown-property": 1,
107-
"react/prefer-es6-class": 1,
108-
"react/prop-types": 1,
109-
"react/react-in-jsx-scope": 1,
110-
"react/require-extension": 1,
111-
"react/self-closing-comp": 1,
112-
"react/sort-comp": 1,
113-
"react/wrap-multilines": 1
114+
"react/jsx-uses-vars": 1
114115
}
115116
}
116117
```
@@ -119,6 +120,26 @@ Finally, enable all of the rules that you would like to use.
119120

120121
* [display-name](docs/rules/display-name.md): Prevent missing `displayName` in a React component definition
121122
* [forbid-prop-types](docs/rules/forbid-prop-types.md): Forbid certain propTypes
123+
* [no-danger](docs/rules/no-danger.md): Prevent usage of dangerous JSX properties
124+
* [no-deprecated](docs/rules/no-deprecated.md): Prevent usage of deprecated methods
125+
* [no-did-mount-set-state](docs/rules/no-did-mount-set-state.md): Prevent usage of `setState` in `componentDidMount`
126+
* [no-did-update-set-state](docs/rules/no-did-update-set-state.md): Prevent usage of `setState` in `componentDidUpdate`
127+
* [no-direct-mutation-state](docs/rules/no-direct-mutation-state.md): Prevent direct mutation of `this.state`
128+
* [no-is-mounted](docs/rules/no-is-mounted.md): Prevent usage of `isMounted`
129+
* [no-multi-comp](docs/rules/no-multi-comp.md): Prevent multiple component definition per file
130+
* [no-set-state](docs/rules/no-set-state.md): Prevent usage of `setState`
131+
* [no-string-refs](docs/rules/no-string-refs.md): Prevent using string references in `ref` attribute.
132+
* [no-unknown-property](docs/rules/no-unknown-property.md): Prevent usage of unknown DOM property (fixable)
133+
* [prefer-es6-class](docs/rules/prefer-es6-class.md): Enforce ES5 or ES6 class for React Components
134+
* [prop-types](docs/rules/prop-types.md): Prevent missing props validation in a React component definition
135+
* [react-in-jsx-scope](docs/rules/react-in-jsx-scope.md): Prevent missing `React` when using JSX
136+
* [require-extension](docs/rules/require-extension.md): Restrict file extensions that may be required
137+
* [self-closing-comp](docs/rules/self-closing-comp.md): Prevent extra closing tags for components without children
138+
* [sort-comp](docs/rules/sort-comp.md): Enforce component methods order
139+
* [wrap-multilines](docs/rules/wrap-multilines.md): Prevent missing parentheses around multilines JSX (fixable)
140+
141+
### JSX-specific rules
142+
122143
* [jsx-boolean-value](docs/rules/jsx-boolean-value.md): Enforce boolean attributes notation in JSX (fixable)
123144
* [jsx-closing-bracket-location](docs/rules/jsx-closing-bracket-location.md): Validate closing bracket location in JSX
124145
* [jsx-curly-spacing](docs/rules/jsx-curly-spacing.md): Enforce or disallow spaces inside of curly braces in JSX attributes (fixable)
@@ -139,23 +160,6 @@ Finally, enable all of the rules that you would like to use.
139160
* [jsx-space-before-closing](docs/rules/jsx-space-before-closing.md): Validate spacing before closing bracket in JSX (fixable)
140161
* [jsx-uses-react](docs/rules/jsx-uses-react.md): Prevent React to be incorrectly marked as unused
141162
* [jsx-uses-vars](docs/rules/jsx-uses-vars.md): Prevent variables used in JSX to be incorrectly marked as unused
142-
* [no-danger](docs/rules/no-danger.md): Prevent usage of dangerous JSX properties
143-
* [no-deprecated](docs/rules/no-deprecated.md): Prevent usage of deprecated methods
144-
* [no-did-mount-set-state](docs/rules/no-did-mount-set-state.md): Prevent usage of `setState` in `componentDidMount`
145-
* [no-did-update-set-state](docs/rules/no-did-update-set-state.md): Prevent usage of `setState` in `componentDidUpdate`
146-
* [no-direct-mutation-state](docs/rules/no-direct-mutation-state.md): Prevent direct mutation of `this.state`
147-
* [no-is-mounted](docs/rules/no-is-mounted.md): Prevent usage of `isMounted`
148-
* [no-multi-comp](docs/rules/no-multi-comp.md): Prevent multiple component definition per file
149-
* [no-set-state](docs/rules/no-set-state.md): Prevent usage of `setState`
150-
* [no-string-refs](docs/rules/no-string-refs.md): Prevent using string references in `ref` attribute.
151-
* [no-unknown-property](docs/rules/no-unknown-property.md): Prevent usage of unknown DOM property (fixable)
152-
* [prefer-es6-class](docs/rules/prefer-es6-class.md): Enforce ES5 or ES6 class for React Components
153-
* [prop-types](docs/rules/prop-types.md): Prevent missing props validation in a React component definition
154-
* [react-in-jsx-scope](docs/rules/react-in-jsx-scope.md): Prevent missing `React` when using JSX
155-
* [require-extension](docs/rules/require-extension.md): Restrict file extensions that may be required
156-
* [self-closing-comp](docs/rules/self-closing-comp.md): Prevent extra closing tags for components without children
157-
* [sort-comp](docs/rules/sort-comp.md): Enforce component methods order
158-
* [wrap-multilines](docs/rules/wrap-multilines.md): Prevent missing parentheses around multilines JSX (fixable)
159163

160164
## React Native
161165

0 commit comments

Comments
 (0)