8000 GitHub - wangzhengbo/volar: ⚡ Fast Vue Language Support Extension · GitHub
[go: up one dir, main page]

Skip to content
wangzhengboPublic

About

⚡ Fast Vue Language Support Extension

Resources

Stars

0 stars

Watchers

0 watching

Forks

 
 

Repository files navigation

Volar

⚡ Fast Vue Language Support Extension

https://marketplace.visualstudio.com/items?itemName=johnsoncodehk.volar

Volar is a Language Support plugin built specifically for Vue 3. It's based on @vue/reactivity to calculate TypeScript on-demand to optimize performance similar to the native TypeScript language service.

🛠️ This project is still in refactoring to make contributing easier.

[Tips] [Discord]

Sponsors

This company is sponsoring this project to improve your DX. 💪

Leniolabs_

Scale your Front-end development with our unique approach

https://www.leniolabs.com/ ・@Leniolabs_ ・info@leniolabs.com

Quick Start

Community's Language Client Implements

By-product

Using

Setup Vue 2
  1. Add @vue/runtime-dom

This extension required Vue 3 types from the @vue/runtime-dom.

Vue 3 in itself includes the package @vue/runtime-dom. For Vue 2 you will have to install this package yourself:

// package.json
{
  "devDependencies": {
    "@vue/runtime-dom": "latest"
  }
}
  1. Remove Vue.extend

Template type-checking do not support with Vue.extend, you can use composition-api, vue-class-component, or export default { ... } instead of export default Vue.extend.

  1. Add tsconfig.json / jsconfig.json if you don't have

  2. Support Vue 2 template

Volar preferentially supports Vue 3. Vue 3 and Vue 2 template has some different. You need to set the experimentalCompatMode option to support Vue 2 template.

// tsconfig.json
{
  "compilerOptions": {
    ...
  },
  "vueCompilerOptions": {
    "experimentalCompatMode": 2
  },
}
Setup Vue 3
  1. Add tsconfig.json / jsconfig.json if you don't have
Define Global Components

PR: vuejs/core#3399

Local components, Built-in components, native HTML elements Type-Checking is available with no configuration.

For Global components, you need to define GlobalComponents interface, for example:

// components.d.ts

// declare module '@vue/runtime-core' works for vue 3
// declare module 'vue' works for vue2 + vue 3
declare module 'vue' {
  export interface GlobalComponents {
    RouterLink: typeof import('vue-router')['RouterLink']
    RouterView: typeof import('vue-router')['RouterView']
  }
}

export {}

Note

You need to disable Vetur to avoid conflicts.

Recommended use css / less / scss as <style> language, because these base on vscode-css-languageservice to provide reliable language support.

If use postcss / stylus / sass, you need to install additional extension for syntax highlighting. I tried these and it works, you can also choose others.

tsconfig.json / jsconfig.json is required.

Also required "strict": true and "moduleResolution": "node".

__VLS_slots is planed to remove in future, see: #40

Volar does not include ESLint and Prettier, but the official ESLint and Prettier extensions support Vue, so you could install these yourself if needed.

If using Vetur's Customizable Scaffold Snippets, recommend use Snippet Generator convert to VSCode Snippets.

About

⚡ Fast Vue Language Support Extension

Resources

Stars

0 stars

Watchers

0 watching

Forks

Releases

Packages

Contributors

Languages

0