Component Data Interfaces for Vue 2?

[douglasg14b]

It's mentioned that we have these here: #418

However, I can't seem to get these working with Vue 2. Do we not get auto-completion & docs with Vue 2 & volar?

Alternatively, for Vue 2, we already have JSON bits that define the APIs we all have. Any reason that cannot be supported for compatibility?

---

The example here: https://github.com/johnsoncodehk/volar/tree/master/extensions/vscode-vue-language-features

Doesn't seem to work in Vue2?

// components.d.ts
declare module '@vue/runtime-core' {
  export interface GlobalComponents {
    RouterLink: typeof import('vue-router')['RouterLink']
    RouterView: typeof import('vue-router')['RouterView']
  }
}

export {}

I still get no autocomplete or API info for router links or views.

Are there more explicit exmaples of defining components this way that we can use? Especially for component libraries that are not using typescript?

[xiaoxiangmoe]

Because vue-router 3(vue 2) has no types for it. It only works in vue-router 4(vue 3).

[douglasg14b]

Thanks for explaining the example!

@johnsoncodehk FYI I have un-marked this as the answer, as that is an good explanation for the example, but not an answer to the question:

Are there more explicit examples of defining components this way that we can use? Especially for component libraries that are not using typescript?

So in this case, Vue Router 3, Vuetify 2....etc

Since Vue 2 projects will be kind of forced to move to Volar to some degree (If they want decent TS support, Pinia...etc), not having any sort of data interfaces for components is going to become a real problem. How can this be done, should this be a feature request?

[xiaoxiangmoe]

@douglasg14b
I'm trying to add types to vue-router 3. You can track it in vuejs/vue-router#3733

If this PR was merged and released, you can use it as vue-router 4.

[douglasg14b]

Oh that's a wonderful example of what is needed!

Thanks

[johnsoncodehk]

We already supported language service plugin: #1027

You can implement most of vetur specific features with plugins such as json base component intellisense, customizable scaffold snippets, ESLint...

I still have a lot of backlog on volar, so I don't plan to do it. If you want to do it, you can contact me on the discord server and I'm happy to help.

[douglasg14b]

json base component intellisense

Wait, so with a plugin I could implement support for the existing Vetur JSON definition bits? If so, then yes! I would love to, but ofc I have absolutely no idea where to even start on that....

When I get a chance I'll swing back around to this (We want Volar), and see about asking some questions to get me starting down that path.