fix(types): make compatible with Vue 2.5 and TypeScript 2.6 #317
Conversation
|
I'm not sure why the unit test failed 😕 |
types/index.d.ts
Outdated
| import Vue, { VNodeData, Component, ComponentOptions, FunctionalComponentOptions } from 'vue' | ||
| import Vue, { VNodeData, ComponentOptions, FunctionalComponentOptions } from 'vue' | ||
|
|
||
| export type Component = |
There was a problem hiding this comment.
If Component type from vue package fails, it probably means we need to fix it in the main repo. Would you like to point out the failing usage?
There was a problem hiding this comment.
Indeed. I found the Component type always has the base Vue type for this type of Data and Method in default. That fails type checking if ComponentOptions has different type: https://github.com/vuejs/vue-test-utils/blob/dev/types/test/resources.ts#L9
Maybe we should change the default type parameters of Component (and AsyncComponent) to {}?
There was a problem hiding this comment.
Shall we merge this now and update the Component type here later when it's fixed in the main repo?
There was a problem hiding this comment.
Let's merge it now. We can change it later after new Vue is released.
There was a problem hiding this comment.
@ktsn The problem is that Component isn't correctly setting up type bound.
ComponentOption<V> is contravariant, that is, ComponentOption<Normal> isn't a sub type of ComponentOption<Vue>, but of ComponentOption<never>.
beforeCreate in componentOption would also break assignment here if contravariant method was checked. But currently it is not https://github.com/Microsoft/TypeScript/wiki/What%27s-new-in-TypeScript#note
There was a problem hiding this comment.
@HerringtonDarkholme Thanks for clarify the problem! I didn't realize we can use never for the default generic type.
I'll change the ComponentOptions's 1st type parameter to never for now before this PR is merged.
fix #272
There are two reasons that the types test is broken:
ComponentOptionsis no longer specify thethistype of lifecycle hooks because Vue 2.5 uses the intersection type withThisTypeto do that.Componenttype cannot pass the type checking.I've added
ThisTyped version ofMountOptionsandShallowOptionsto solve 1. Also added a newComponenttype to solve 2.