@vue/language-core

What is @vue/language-core?

The @vue/language-core package is designed to provide core functionalities for handling Vue.js component files (.vue files) in development tools. It offers APIs for parsing, analyzing, and manipulating Vue component code, making it easier for developers to create or enhance development tools such as IDEs, linters, and compilers that work with Vue.js projects.

What are @vue/language-core's main functionalities?

Parsing Vue Files

This feature allows the parsing of Vue component files, breaking down the structure into an understandable format for further processing. The code sample demonstrates how to parse a simple Vue file to access its descriptor.

import { parse } from '@vue/language-core';
const { descriptor } = parse('<template><div>Hello World</div></template>');

Analyzing Script Setup

Analyzes the script setup block of a Vue component, providing insights such as defined props. The code sample shows how to analyze a script setup block after parsing a Vue file.

import { parse, analyzeScriptSetup } from '@vue/language-core';
const { descriptor } = parse('<script setup>defineProps()</script>');
const analysis = analyzeScriptSetup(descriptor);

Transforming Vue Components

Enables the transformation of Vue component code based on specified options, which can be used for code optimization or to apply custom modifications. The code sample illustrates transforming a parsed Vue component.

import { parse, transform } from '@vue/language-core';
const { descriptor } = parse('<template><div>{{ msg }}</div></template>');
const transformed = transform(descriptor, { /* transformation options */ });

Other packages similar to @vue/language-core

vue-eslint-parser

A parser that converts Vue component files into an AST format that ESLint can understand, enabling linting of Vue files. While it focuses on linting, @vue/language-core offers a broader range of functionalities for analyzing and transforming Vue components.

vuetify-loader

A webpack loader that automatically imports Vuetify components used in a project. It's more specific to Vuetify and webpack, whereas @vue/language-core provides core functionalities applicable to various development tools and environments.

README

The README file is missing

Changelog

2.1.10 ^official, 2.1.11 ^insiders (2024-10-31)

Features

• language-service: auto insert const props = with props completion (#4942) - Thanks to @KazariEX!

Bug Fixes

• language-core: revert #4902
• language-core: inject as assertion of useCssModule into correct location (#4952) - Thanks to @KazariEX!
• language-core: hold prev track id correctly (#4961) - Thanks to @KazariEX!
• language-core: generate style modules type as needed (#4953) - Thanks to @KazariEX!
• language-core: reference global types file with relative path (#4966)

Refactors

• vscode: rewrite with Reactive VSCode (#4945) - Thanks to @KazariEX, @KermanX!