Add rule vue/require-valid-default-prop.
#119
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
armano2
force-pushed
the
patch-24-require-valid-default-prop
branch
from
7e4c894 to
dd69ffc
Compare
armano2
changed the title
vue/require-valid-default-prop.vue/require-valid-default-prop.
armano2
changed the title
vue/require-valid-default-prop.vue/require-valid-default-prop.
armano2
force-pushed
the
patch-24-require-valid-default-prop
branch
from
21e7fc5 to
c4e7cc3
Compare
armano2
changed the title
vue/require-valid-default-prop.vue/require-valid-default-prop.
michalsnik
suggested changes
Aug 4, 2017
| @@ -0,0 +1,64 @@ | |||
| # Enforces prop default values to be valid (require-valid-default-prop) | |||
|
|
|||
| This rule is doing basic type checking between type and default value and inform about missuesed or invalid default values. | |||
There was a problem hiding this comment.
What do you think about:
This rule checks whether the default value of each prop is valid for the given type. It should report an error when default value for type `Array` or `Object` is not returned using function.
| @@ -0,0 +1,64 @@ | |||
| # Enforces prop default values to be valid (require-valid-default-prop) | |||
| } | ||
| } else if (node.type === 'ArrayExpression') { // Array | ||
| return 'Array' | ||
| } else if (node.type === 'ObjectExpression') { // Array |
|
|
||
| context.report({ | ||
| node: def, | ||
| message: "Type of default value prop '{{name}}' must be a {{types}}.", |
There was a problem hiding this comment.
Maybe: Type of the default value for '{{name}}' prop must be a {{types}}. ?
I think it sounds nice: Type of the default value for 'counter' prop must be a number.
| props: { | ||
| foo: { | ||
| type: Array, | ||
| default: [] |
There was a problem hiding this comment.
Did you think about supporting also:
{
type: Array,
default() {
return 100
}
}
? It should also throw an error I think
There was a problem hiding this comment.
for now i'm not checking what function is returning or even if function is returning something
{
type: Number,
default() { }
}
is valid
| props: { | ||
| foo: null, | ||
| foo: Number, | ||
| foo: [String, Number], |
There was a problem hiding this comment.
What if I use it like this:
foo: {
type: [Object, Number],
default: 10
},
bar: {
type: [Object, Number],
default: {}
}
? Will it throw an error?
There was a problem hiding this comment.
I'm missing tests for that, i will add them
|
@michalsnik i added few more tests and i applied you suggestions about doc/message I'm treating function as always valid due to complexity of detecting type returned by it |
michalsnik
approved these changes
Aug 4, 2017
filipalacerda
pushed a commit
to filipalacerda/eslint-plugin-vue
that referenced
this pull request
Aug 5, 2017
* master: Add rule `vue/require-valid-default-prop`. (vuejs#119) 3.10.0 Update readme to 3.10.0 Chore: remove package-lock.json (vuejs#128) Fix: parserService must exist always (fixes vuejs#125) (vuejs#127) Add rule `require-render-return`. (vuejs#114) 3.9.0 Update package-lock Update: options for `no-duplicate-attributes` (fixes vuejs#112)(vuejs#113) New: add rule `attribute-hyphenation`. (fixes vuejs#92)(vuejs#95) Add namespace check of svg & mathML instead of tag names (vuejs#120)⚠️ Add support for deprecated state in update-rules⚠️ (vuejs#121) Add rules: `no-dupe-keys` and `no-reserved-keys`. (vuejs#88) Chore: Improve tests for name-property-casing & improve documentation (vuejs#115) New: add `require-prop-types` rule (fixes vuejs#19)(vuejs#85) Update: upgrade vue-eslint-parser (fixes vuejs#36, fixes vuejs#56, fixes vuejs#96) (vuejs#116)
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
This PR implements rules proposed in #117
TODO:
fixes #117