@vue/language-core 3.2.3 → 3.2.5

package/README.md

@@ -0,0 +1,160 @@
+# @vue/language-core
+
+<p>
+  <a href="https://www.npmjs.com/package/@vue/language-core"><img src="https://img.shields.io/npm/v/@vue/language-core.svg?labelColor=18181B&color=1584FC" alt="NPM version"></a>
+  <a href="https://github.com/vuejs/language-tools/blob/master/LICENSE"><img src="https://img.shields.io/github/license/vuejs/language-tools.svg?labelColor=18181B&color=1584FC" alt="License"></a>
+</p>
+
+The core module for Vue Language Tools, responsible for parsing Vue Single File Components (SFCs) and transforming them into virtual code structures that TypeScript can understand. This package is a low-level dependency for `@vue/language-server` and `vue-tsc`.
+
+## Installation
+
+```bash
+npm install @vue/language-core
+```
+
+## Core API
+
+### `createVueLanguagePlugin`
+
+Creates a Vue language plugin for integration with Volar language services.
+
+```typescript
+import { createVueLanguagePlugin } from '@vue/language-core';
+import type { LanguagePlugin } from '@volar/language-core';
+import ts from 'typescript';
+
+const plugin: LanguagePlugin<string> = createVueLanguagePlugin(
+  ts,
+  compilerOptions,    // ts.CompilerOptions
+  vueCompilerOptions, // VueCompilerOptions
+  (scriptId) => scriptId  // asFileName: Converts scriptId to a file name
+);
+```
+
+### `createParsedCommandLine`
+
+Parses TypeScript and Vue compiler options from `tsconfig.json`.
+
+```typescript
+import { createParsedCommandLine } from '@vue/language-core';
+import ts from 'typescript';
+
+const parsed = createParsedCommandLine(ts, ts.sys, '/path/to/tsconfig.json');
+// parsed.options: ts.CompilerOptions
+// parsed.vueOptions: VueCompilerOptions
+```
+
+### `parse`
+
+Parses Vue SFC source code and returns an `SFCParseResult`.
+
+```typescript
+import { parse } from '@vue/language-core';
+
+const result = parse(`
+<template>
+  <div>{{ msg }}</div>
+</template>
+<script setup lang="ts">
+const msg = 'Hello'
+</script>
+`);
+
+// result.descriptor.template
+// result.descriptor.scriptSetup
+// result.descriptor.styles
+// result.errors
+```
+
+## `vueCompilerOptions`
+
+Configure Vue compiler behavior through the `vueCompilerOptions` field in `tsconfig.json`:
+
+```jsonc
+{
+  "compilerOptions": { /* ... */ },
+  "vueCompilerOptions": {
+    "target": 3.5,
+    "strictTemplates": true,
+    "plugins": ["@vue/language-plugin-pug"]
+  }
+}
+```
+
+### File Handling Options
+
+| Option | Type | Default | Description |
+| :--- | :--- | :--- | :--- |
+| `target` | `number \| 'auto'` | `'auto'` | Vue version. `'auto'` reads from `node_modules/vue/package.json`. |
+| `extensions` | `string[]` | `['.vue']` | File extensions to be treated as Vue SFCs. |
+| `vitePressExtensions` | `string[]` | `[]` | File extensions to be treated as VitePress Markdown. |
+| `petiteVueExtensions` | `string[]` | `[]` | File extensions to be treated as Petite Vue HTML. |
+| `plugins` | `string[]` | `[]` | Custom language plugins, e.g., [`@vue/language-plugin-pug`](../language-plugin-pug). |
+
+### Type Checking Options
+
+| Option | Type | Default | Description |
+| :--- | :--- | :--- | :--- |
+| `strictTemplates` | `boolean` | `false` | A convenience option that enables the four `check*` options below and `strictVModel`. |
+| `checkUnknownProps` | `boolean` | `false` | Check for unknown props. |
+| `checkUnknownEvents` | `boolean` | `false` | Check for unknown events. |
+| `checkUnknownComponents` | `boolean` | `false` | Check for unknown components. |
+| `checkUnknownDirectives` | `boolean` | `false` | Check for unknown directives. |
+| `strictVModel` | `boolean` | `false` | Strictly check v-model bindings. |
+| `strictCssModules` | `boolean` | `false` | Strictly check CSS Modules class names (not affected by `strictTemplates`). |
+
+### Advanced Options
+
+| Option | Type | Default | Description |
+| :--- | :--- | :--- | :--- |
+| `lib` | `string` | `'vue'` | Vue package name, used for generating import statements. |
+| `skipTemplateCodegen` | `boolean` | `false` | Skip virtual code generation for templates. |
+| `fallthroughAttributes` | `boolean` | `false` | Enable type inference for fallthrough attributes. |
+| `jsxSlots` | `boolean` | `false` | Use JSX-style slots types. |
+| `dataAttributes` | `string[]` | `[]` | Allowed data-* attribute patterns. |
+| `htmlAttributes` | `string[]` | `['aria-*']` | Allowed HTML attribute patterns. |
+| `resolveStyleImports` | `boolean` | `false` | Resolve import statements in styles. |
+| `resolveStyleClassNames` | `boolean \| 'scoped'` | `'scoped'` | Resolve class names in styles. |
+
+## Built-in Plugins
+
+This package includes the following built-in plugins to handle different file types and blocks:
+
+### File Parsing Plugins
+
+| Plugin | Function | Controlled By |
+| :--- | :--- | :--- |
+| `file-vue` | Parses `.vue` files into an SFC structure. | `extensions` |
+| `file-md` | Parses Markdown files into an SFC structure. | `vitePressExtensions` |
+| `file-html` | Parses HTML files into an SFC structure. | `petiteVueExtensions` |
+
+### Virtual Code Generation Plugins
+
+| Plugin | Function |
+| :--- | :--- |
+| `vue-tsx` | Generates TypeScript virtual code from an SFC. |
+| `vue-template-html` | Compiles HTML templates. |
+| `vue-template-inline-ts` | Handles TypeScript expressions in templates. |
+| `vue-template-inline-css` | Handles inline styles in templates. |
+| `vue-style-css` | Compiles CSS styles. |
+| `vue-script-js` | Handles JavaScript script blocks. |
+
+### Embedded Code Extraction Plugins
+
+| Plugin | Function |
+| :--- | :--- |
+| `vue-sfc-template` | Extracts the `<template>` block. |
+| `vue-sfc-styles` | Extracts `<style>` blocks. |
+| `vue-sfc-scripts` | Extracts `<script>` blocks (for formatting). |
+| `vue-sfc-customblocks` | Extracts custom blocks. |
+
+## Related Packages
+
+- [`@vue/language-server`](../language-server) - Language Server
+- [`@vue/language-service`](../language-service) - Language Service
+- [`vue-tsc`](../tsc) - Command-line Type Checker
+
+## License
+
+[MIT](https://github.com/vuejs/language-tools/blob/master/LICENSE) License

package/lib/languagePlugin.js

@@ -64,6 +64,7 @@ function createVueLanguagePlugin(ts, compilerOptions, vueCompilerOptions, asFile
         },
         compilerOptions,
         vueCompilerOptions,
+        config: {},
     };
     const plugins = (0, plugins_1.createPlugins)(pluginContext);
     const fileRegistry = getVueFileRegistry(compilerOptions, vueCompilerOptions, plugins);

package/lib/plugins/vue-template-html.js

@@ -152,6 +152,12 @@ const plugin = ({ modules }) => {
                         if (!tryUpdateNode(node.content)) {
                             return false;
                         }
+                        if (node.content.type === CompilerDOM.NodeTypes.SIMPLE_EXPRESSION) {
+                            const { content } = node.content;
+                            if (content.includes('{{') || content.includes('}}')) {
+                                return false;
+                            }
+                        }
                     }
                     else if (node.type === CompilerDOM.NodeTypes.SIMPLE_EXPRESSION) {
                         if (withinChangeRange(node.loc)) { // TODO: review this (slot name?)

package/lib/plugins.js

@@ -56,7 +56,7 @@ function createPlugins(pluginContext) {
         .flatMap(plugin => {
         try {
             const moduleConfig = plugin.__moduleConfig ?? {};
-            const instance = plugin({ ...pluginContext, ...moduleConfig });
+            const instance = plugin({ ...pluginContext, config: moduleConfig });
             if (Array.isArray(instance)) {
                 for (let i = 0; i < instance.length; i++) {
                     instance[i].name ??= `${moduleConfig.name} (${i})`;

package/lib/types.d.ts

@@ -97,13 +97,14 @@ export interface VueLanguagePluginReturn {
     }[];
     resolveEmbeddedCode?(fileName: string, sfc: Sfc, embeddedFile: VueEmbeddedCode): void;
 }
-export type VueLanguagePlugin = (ctx: Record<string, any> & {
+export type VueLanguagePlugin<T extends Record<string, any> = {}> = (ctx: {
     modules: {
         typescript: typeof ts;
         '@vue/compiler-dom': typeof CompilerDOM;
     };
     compilerOptions: ts.CompilerOptions;
     vueCompilerOptions: VueCompilerOptions;
+    config: T;
 }) => VueLanguagePluginReturn | VueLanguagePluginReturn[];
 export interface SfcBlock {
     name: string;

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "@vue/language-core",
-	"version": "3.2.3",
+	"version": "3.2.5",
 	"license": "MIT",
 	"files": [
 		"**/*.js",
@@ -13,7 +13,7 @@
 		"directory": "packages/language-core"
 	},
 	"dependencies": {
-		"@volar/language-core": "2.4.27",
+		"@volar/language-core": "2.4.28",
 		"@vue/compiler-dom": "^3.5.0",
 		"@vue/shared": "^3.5.0",
 		"alien-signals": "^3.0.0",
@@ -25,8 +25,8 @@
 		"@types/node": "^22.10.4",
 		"@types/path-browserify": "^1.0.1",
 		"@types/picomatch": "^4.0.0",
-		"@volar/typescript": "2.4.27",
+		"@volar/typescript": "2.4.28",
 		"@vue/compiler-sfc": "^3.5.0"
 	},
-	"gitHead": "efc6882ab62a518b41ab5c8dc1d762c41c862ebc"
+	"gitHead": "ee5041d27940cf6f9a5150635d3b13140a9dff54"
 }