Skip to content

Commit d02a506

Browse files
author
Jordan Gensler
committed
Adding links to react rules for quick reference.
1 parent e9b1ef9 commit d02a506

File tree

1 file changed

+23
-0
lines changed
  • packages/eslint-config-airbnb/rules

1 file changed

+23
-0
lines changed

packages/eslint-config-airbnb/rules/react.js

Lines changed: 23 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -7,48 +7,70 @@ module.exports = {
77
},
88
'rules': {
99
// Prevent missing displayName in a React component definition
10+
// https://github.com/yannickcr/eslint-plugin-react/blob/master/docs/rules/display-name.md
1011
'react/display-name': 0,
1112
// Enforce boolean attributes notation in JSX
13+
// https://github.com/yannickcr/eslint-plugin-react/blob/master/docs/rules/jsx-boolean-value.md
1214
'react/jsx-boolean-value': [2, 'never'],
1315
// Validate closing bracket location in JSX
16+
// https://github.com/yannickcr/eslint-plugin-react/blob/master/docs/rules/jsx-closing-bracket-location.md
1417
'react/jsx-closing-bracket-location': [2, 'line-aligned'],
1518
// Enforce or disallow spaces inside of curly braces in JSX attributes
19+
// https://github.com/yannickcr/eslint-plugin-react/blob/master/docs/rules/jsx-curly-spacing.md
1620
'react/jsx-curly-spacing': 0,
1721
// Validate props indentation in JSX
22+
// https://github.com/yannickcr/eslint-plugin-react/blob/master/docs/rules/jsx-indent-props.md
1823
'react/jsx-indent-props': [2, 2],
1924
// Prevent duplicate props in JSX
25+
// https://github.com/yannickcr/eslint-plugin-react/blob/master/docs/rules/jsx-no-duplicate-props.md
2026
'react/jsx-no-duplicate-props': 0,
2127
// Disallow undeclared variables in JSX
28+
// https://github.com/yannickcr/eslint-plugin-react/blob/master/docs/rules/jsx-no-undef.md
2229
'react/jsx-no-undef': 2,
2330
// Enforce quote style for JSX attributes
31+
// https://github.com/yannickcr/eslint-plugin-react/blob/master/docs/rules/jsx-quote.md
2432
'react/jsx-quotes': [2, 'double'],
2533
// Enforce propTypes declarations alphabetical sorting
34+
// https://github.com/yannickcr/eslint-plugin-react/blob/master/docs/rules/jsx-sort-prop-types.md
2635
'react/jsx-sort-prop-types': 0,
2736
// Enforce props alphabetical sorting
37+
// https://github.com/yannickcr/eslint-plugin-react/blob/master/docs/rules/jsx-sort-props.md
2838
'react/jsx-sort-props': 0,
2939
// Prevent React to be incorrectly marked as unused
40+
// https://github.com/yannickcr/eslint-plugin-react/blob/master/docs/rules/jsx-uses-react.md
3041
'react/jsx-uses-react': 2,
3142
// Prevent variables used in JSX to be incorrectly marked as unused
43+
// https://github.com/yannickcr/eslint-plugin-react/blob/master/docs/rules/jsx-uses-vars.md
3244
'react/jsx-uses-vars': 2,
3345
// Prevent usage of dangerous JSX properties
46+
// https://github.com/yannickcr/eslint-plugin-react/blob/master/docs/rules/no-danger.md
3447
'react/no-danger': 0,
3548
// Prevent usage of setState in componentDidMount
49+
// https://github.com/yannickcr/eslint-plugin-react/blob/master/docs/rules/no-did-mount-set-state.md
3650
'react/no-did-mount-set-state': [2, 'allow-in-func'],
3751
// Prevent usage of setState in componentDidUpdate
52+
// https://github.com/yannickcr/eslint-plugin-react/blob/master/docs/rules/no-did-update-set-state.md
3853
'react/no-did-update-set-state': [2, 'allow-in-func'],
3954
// Prevent multiple component definition per file
55+
// https://github.com/yannickcr/eslint-plugin-react/blob/master/docs/rules/no-multi-comp.md
4056
'react/no-multi-comp': 2,
4157
// Prevent usage of unknown DOM property
58+
// https://github.com/yannickcr/eslint-plugin-react/blob/master/docs/rules/no-unknown-property.md
4259
'react/no-unknown-property': 2,
4360
// Prevent missing props validation in a React component definition
61+
// https://github.com/yannickcr/eslint-plugin-react/blob/master/docs/rules/prop-types.md
4462
'react/prop-types': 2,
4563
// Prevent missing React when using JSX
64+
// https://github.com/yannickcr/eslint-plugin-react/blob/master/docs/rules/react-in-jsx-scope.md
4665
'react/react-in-jsx-scope': 2,
4766
// Restrict file extensions that may be required
67+
// https://github.com/yannickcr/eslint-plugin-react/blob/master/docs/rules/require-extension.md
4868
'react/require-extension': 0,
4969
// Prevent extra closing tags for components without children
70+
// https://github.com/yannickcr/eslint-plugin-react/blob/master/docs/rules/self-closing-comp.md
5071
'react/self-closing-comp': 2,
5172
// Enforce component methods order
73+
// https://github.com/yannickcr/eslint-plugin-react/blob/master/docs/rules/sort-comp.md
5274
'react/sort-comp': [2, {
5375
'order': [
5476
'lifecycle',
@@ -60,6 +82,7 @@ module.exports = {
6082
]
6183
}],
6284
// Prevent missing parentheses around multilines JSX
85+
// https://github.com/yannickcr/eslint-plugin-react/blob/master/docs/rules/wrap-multilines.md
6386
'react/wrap-multilines': [2, {
6487
declaration: true,
6588
assignment: true,

0 commit comments

Comments
 (0)