Skip to content

Commit 21f684a

Browse files
committed
Add rules metadata docs
1 parent a566536 commit 21f684a

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

50 files changed

+256
-57
lines changed

lib/rules/display-name.js

Lines changed: 5 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,11 @@ var Components = require('../util/Components');
1212

1313
module.exports = {
1414
meta: {
15-
docs: {},
15+
docs: {
16+
description: 'Prevent missing displayName in a React component definition',
17+
category: 'Best Practices',
18+
recommended: true
19+
},
1620

1721
schema: [{
1822
type: 'object',

lib/rules/forbid-prop-types.js

Lines changed: 5 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -15,7 +15,11 @@ var DEFAULTS = ['any', 'array', 'object'];
1515

1616
module.exports = {
1717
meta: {
18-
docs: {},
18+
docs: {
19+
description: 'Forbid certain propTypes',
20+
category: 'Best Practices',
21+
recommended: false
22+
},
1923

2024
schema: [{
2125
type: 'object',

lib/rules/jsx-boolean-value.js

Lines changed: 5 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,11 @@
1010

1111
module.exports = {
1212
meta: {
13-
docs: {},
13+
docs: {
14+
description: 'Enforce boolean attributes notation in JSX',
15+
category: 'Stylistic Issues',
16+
recommended: false
17+
},
1418
fixable: 'code',
1519

1620
schema: [{

lib/rules/jsx-closing-bracket-location.js

Lines changed: 5 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,11 @@
99
// ------------------------------------------------------------------------------
1010
module.exports = {
1111
meta: {
12-
docs: {},
12+
docs: {
13+
description: 'Validate closing bracket location in JSX',
14+
category: 'Stylistic Issues',
15+
recommended: false
16+
},
1317
fixable: 'code',
1418

1519
schema: [{

lib/rules/jsx-curly-spacing.js

Lines changed: 5 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -22,7 +22,11 @@ var SPACING_VALUES = [SPACING.always, SPACING.never];
2222

2323
module.exports = {
2424
meta: {
25-
docs: {},
25+
docs: {
26+
description: 'Enforce or disallow spaces inside of curly braces in JSX attributes',
27+
category: 'Stylistic Issues',
28+
recommended: false
29+
},
2630
fixable: 'code',
2731

2832
schema: [{

lib/rules/jsx-equals-spacing.js

Lines changed: 5 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,11 @@
1010

1111
module.exports = {
1212
meta: {
13-
docs: {},
13+
docs: {
14+
description: 'Disallow or enforce spaces around equal signs in JSX attributes',
15+
category: 'Stylistic Issues',
16+
recommended: false
17+
},
1418
fixable: 'code',
1519

1620
schema: [{

lib/rules/jsx-filename-extension.js

Lines changed: 5 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -20,7 +20,11 @@ var DEFAULTS = {
2020

2121
module.exports = {
2222
meta: {
23-
docs: {},
23+
docs: {
24+
description: 'Restrict file extensions that may contain JSX',
25+
category: 'Stylistic Issues',
26+
recommended: false
27+
},
2428

2529
schema: [{
2630
type: 'object',

lib/rules/jsx-first-prop-new-line.js

Lines changed: 5 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,11 @@
1010

1111
module.exports = {
1212
meta: {
13-
docs: {},
13+
docs: {
14+
description: 'Ensure proper position of the first property in JSX',
15+
category: 'Stylistic Issues',
16+
recommended: false
17+
},
1418

1519
schema: [{
1620
enum: ['always', 'never', 'multiline']

lib/rules/jsx-handler-names.js

Lines changed: 5 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,11 @@
1010

1111
module.exports = {
1212
meta: {
13-
docs: {},
13+
docs: {
14+
description: 'Enforce event handler naming conventions in JSX',
15+
category: 'Stylistic Issues',
16+
recommended: false
17+
},
1418

1519
schema: [{
1620
type: 'object',

lib/rules/jsx-indent-props.js

Lines changed: 5 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -34,7 +34,11 @@
3434
// ------------------------------------------------------------------------------
3535
module.exports = {
3636
meta: {
37-
docs: {},
37+
docs: {
38+
description: 'Validate props indentation in JSX',
39+
category: 'Stylistic Issues',
40+
recommended: false
41+
},
3842
fixable: 'code',
3943

4044
schema: [{

0 commit comments

Comments
 (0)