Vue

Use @golar/vue to add Vue support to Golar.

Install the Plugin

Make sure vue is installed in your project.

Then install the Golar plugin:

npm

npm i -D @golar/vue

pnpm

pnpm add -D @golar/vue

yarn

yarn add -D @golar/vue

Register the Plugin

Add the plugin import to golar.config.ts:

golar.config.ts

import { defineConfig } from 'golar/unstable'
import '@golar/vue'

export default defineConfig({})

Run Golar

Once the plugin is registered, run Golar in the default mode:

npm

npx golar

pnpm

pnpm golar

yarn

yarn golar

This command loads golar.config.ts, runs linting, and then type-checks your project files.

Declaration Emit

If you need declaration emit for Vue files, use tsc mode:

npm

npx golar tsc --declaration --emitDeclarationOnly

pnpm

pnpm golar tsc --declaration --emitDeclarationOnly

yarn

yarn golar tsc --declaration --emitDeclarationOnly

This emits .vue.d.ts files for Vue components.

Pug Templates

Vue Language Tools supports <template lang="pug"> through @vue/language-plugin-pug.

Install the Pug language plugin:

npm

npm i -D @vue/language-plugin-pug

pnpm

pnpm add -D @vue/language-plugin-pug

yarn

yarn add -D @vue/language-plugin-pug

Then add it to vueCompilerOptions.plugins in tsconfig.json:

tsconfig.json

{
  "vueCompilerOptions": {
    "plugins": ["@vue/language-plugin-pug"]
  }
}

VitePress

Vue Language Tools supports specifying VitePress file extensions via vitePressExtensions in tsconfig.json.

To enable typechecking support for VitePress .md files, it’s required to explicitly configure the Vue plugin:

golar.config.ts

import { defineConfig } from 'golar/unstable'
import * as vue from '@golar/vue'

vue.configure({
  vitePressExtensions: ['.md'],
})

export default defineConfig({})

tsconfig.json

{
  "vueCompilerOptions": {
    "vitePressExtensions": [".md"]
  }
}

Official Tooling Used

Golar’s Vue support is built on the official @vue/language-core package.