@volar/typescript

What is @volar/typescript?

The @volar/typescript package is an enhanced version of TypeScript designed to work with the Volar tooling for Vue.js projects. It provides improved TypeScript support specifically tailored for Vue components, offering features like enhanced type checking and IntelliSense in template expressions.

What are @volar/typescript's main functionalities?

Enhanced Type Checking for Vue Templates

This feature allows developers to perform advanced type checking within Vue component templates, ensuring that expressions used in templates adhere to the expected types defined in the script part of the component.

import { createTypeChecker } from '@volar/typescript';
const checker = createTypeChecker(ts, service, program);
checker.checkTemplate(template);

Improved IntelliSense in Templates

This functionality enhances the IntelliSense capabilities within Vue templates, providing auto-completion suggestions that are contextually relevant to the Vue component's data and methods.

import { createTypeChecker } from '@volar/typescript';
const checker = createTypeChecker(ts, service, program);
checker.getTemplateCompletionsAtPosition(position);

Other packages similar to @volar/typescript

typescript-vue-plugin

This package also enhances TypeScript support for Vue.js applications by providing additional type checking and IntelliSense features within Vue components. It is similar to @volar/typescript but is generally used with older versions of Vue and may not have as tight integration with the latest Vue features.

vetur

Vetur is a popular Visual Studio Code extension that provides a rich Vue tooling experience. It includes features like syntax-highlighting, IntelliSense, linting, and snippet support. While Vetur uses its own TypeScript enhancements, @volar/typescript is more focused and optimized specifically for type checking and IntelliSense in templates.

README

The README file is missing

Changelog

2.0.4 (2024-02-13)

Features

• ci: integrate with https://github.com/volarjs/ecosystem-ci

Bug Fixes

• language-service: transform markdown links in completion items #133
• typescript: typescript plugin module resolve behavior inconsistent with language server
• typescript: typescript plugin breaks semantic highlighting for .ts files (https://github.com/withastro/language-tools/issues/788)