Skip to content

Commit d4b6709

Browse files
author
Roy Sutton
committed
Update name of rule
1 parent e05f47a commit d4b6709

File tree

4 files changed

+6
-6
lines changed

4 files changed

+6
-6
lines changed

docs/rules/no-invalid-default-props.md renamed to docs/rules/default-props-match-prop-types.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
# Enforce all defaultProps have a corresponding non-required PropType (no-invalid-default-props)
1+
# Enforce all defaultProps have a corresponding non-required PropType (default-props-match-prop-types)
22

33
This rule aims to ensure that any `defaultProp` has a non-required `PropType` declaration.
44

@@ -154,7 +154,7 @@ NotAComponent.propTypes = {
154154

155155
```js
156156
...
157-
"no-invalid-default-props": [<enabled>, { "allowRequiredDefaults": <boolean> }]
157+
"default-props-match-prop-types": [<enabled>, { "allowRequiredDefaults": <boolean> }]
158158
...
159159
```
160160

index.js

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -28,7 +28,7 @@ var allRules = {
2828
'jsx-no-bind': require('./lib/rules/jsx-no-bind'),
2929
'jsx-no-undef': require('./lib/rules/jsx-no-undef'),
3030
'no-unknown-property': require('./lib/rules/no-unknown-property'),
31-
'no-invalid-default-props': require('./lib/rules/no-invalid-default-props'),
31+
'default-props-match-prop-types': require('./lib/rules/default-props-match-prop-types'),
3232
'jsx-curly-spacing': require('./lib/rules/jsx-curly-spacing'),
3333
'jsx-equals-spacing': require('./lib/rules/jsx-equals-spacing'),
3434
'jsx-sort-props': require('./lib/rules/jsx-sort-props'),

lib/rules/no-invalid-default-props.js renamed to lib/rules/default-props-match-prop-types.js

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -18,7 +18,7 @@ var annotations = require('../util/annotations');
1818
module.exports = {
1919
meta: {
2020
docs: {
21-
description: 'Enforce all defaultProps are defined and not required in propTypes.',
21+
description: 'Enforce all defaultProps are defined and not "required" in propTypes.',
2222
category: 'Best Practices'
2323
},
2424

tests/lib/rules/no-invalid-default-props.js renamed to tests/lib/rules/default-props-match-prop-types.js

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,7 @@
99
// Requirements
1010
// ------------------------------------------------------------------------------
1111

12-
var rule = require('../../../lib/rules/no-invalid-default-props');
12+
var rule = require('../../../lib/rules/default-props-match-prop-types');
1313
var RuleTester = require('eslint').RuleTester;
1414
var assign = require('object.assign');
1515

@@ -29,7 +29,7 @@ var ruleTester = new RuleTester({parserOptions: parserOptions});
2929
// Tests
3030
// ------------------------------------------------------------------------------
3131

32-
ruleTester.run('no-invalid-default-props', rule, {
32+
ruleTester.run('default-props-match-prop-types', rule, {
3333

3434
valid: [
3535
//

0 commit comments

Comments
 (0)