@webgal/language-service 0.0.2-alpha.4 → 0.0.2-alpha.6

package/README.en.md

@@ -0,0 +1,15 @@
+# @webgal/language-service
+
+English | [中文](./README.md) 
+
+WebGAL language service integration package, providing capabilities such as Monaco initialization, syntax and theme resources, VFS, and client processors.
+
+## Install
+
+```bash
+npm i @webgal/language-service
+```
+
+## Repository
+
+https://github.com/xiaoxustudio/webgal-language-tools/tree/main/packages/language-service

package/README.md

@@ -0,0 +1,15 @@
+# @webgal/language-service
+
+[English](./README.en.md) | 中文
+
+WebGAL 语言服务集成包，提供 Monaco 初始化、语法与主题资源、VFS 与客户端处理器等能力。
+
+## 安装
+
+```bash
+npm i @webgal/language-service
+```
+
+## 仓库
+
+https://github.com/xiaoxustudio/webgal-language-tools/tree/main/packages/language-service

package/build/{client-handlers-CrU8stw6.mjs → client-handlers-B6JBICcy.mjs}

@@ -1,3 +1,4 @@
+import { t as getState } from "./providerState-_ZvKXErw.mjs";
 import { FileType } from "@volar/language-service";
 import { URI } from "vscode-uri";
 
@@ -32,6 +33,12 @@ const toVfsPath = (value) => value.startsWith("file://") ? uriToPath(value) : va
 
 //#endregion
 //#region src/vfs/adapter.ts
+/**
+* 创建虚拟文件系统适配器
+* 将Volar可写文件系统封装为统一的虚拟文件系统接口
+* @param fs - Volar可写文件系统实例
+* @returns 返回虚拟文件系统实例，提供文件读写、目录操作等功能
+*/
 function createVirtualFileSystem(fs) {
 	const root = fs.root;
 	return {
@@ -115,6 +122,14 @@ function createVirtualFileSystem(fs) {
 		onDidChange: (listener) => fs.onDidChange(listener)
 	};
 }
+/**
+* 创建Volar文件系统适配器
+* 将虚拟文件系统封装为Volar语言服务所需的FileSystem接口
+* @param vfs - 虚拟文件系统实例
+* @param options - 配置选项
+* @param options.uriToPath - 可选的URI到路径的转换函数，默认使用内置的转换函数
+* @returns 返回符合Volar FileSystem接口的文件系统实例
+*/
 function createVolarFileSystem(vfs, options) {
 	const uriToPathImpl = options?.uriToPath ?? ((uri) => uriToPath(uri));
 	return {
@@ -144,6 +159,14 @@ function createVolarFileSystem(vfs, options) {
 
 //#endregion
 //#region src/vfs/memory.ts
+/**
+* 创建基于内存的Volar可写文件系统
+* 该文件系统将所有文件和目录存储在内存中，不持久化到磁盘
+* @param options - 配置选项
+* @param options.root - 根目录路径，默认为"/"
+* @param options.tree - 可选的初始虚拟文件树结构
+* @returns 返回Volar可写文件系统实例，支持文件读写、目录操作和变更监听
+*/
 function createMemoryVolarFileSystem(options) {
 	const root = normalizePath(toVfsPath(options?.root ?? "/"));
 	let rootEntry = options?.tree && options.tree.type === "dir" ? options.tree : {
@@ -297,6 +320,12 @@ function createMemoryVolarFileSystem(options) {
 
 //#endregion
 //#region src/client-handlers.ts
+/**
+* 创建Webgal客户端处理器
+*
+* @param options - 创建处理器的配置选项
+* @returns 返回一个包含各种客户端处理器方法的对象
+*/
 function createWebgalClientHandlers(options) {
 	const normalizeChange = (change) => {
 		if (change.type === "writeFile") return {
@@ -326,7 +355,7 @@ function createWebgalClientHandlers(options) {
 		"client/FJoin": (args) => options.vfs.join(...Array.isArray(args) ? args : [args]),
 		"client/FStat": (path) => options.vfs.stat(toVfsPath(path)),
 		"client/findFile": ([startPath, targetName]) => options.vfs.findFile(toVfsPath(startPath), targetName),
-		"client/goPropertyDoc": options.goPropertyDoc ?? (() => null),
+		"client/goPropertyDoc": options.goPropertyDoc ?? ((path) => getState(path)),
 		"client/readDirectory": (uriString) => options.vfs.readDirectory(uriToPath(uriString)),
 		"client/getAllTextWithScene": () => options.vfs.getAllTextWithScene(),
 		"client/getResourceDirectory": (urls) => options.vfs.getResourceDirectory(urls),
@@ -341,6 +370,12 @@ function createWebgalClientHandlers(options) {
 		...options.overrides ?? {}
 	};
 }
+/**
+* 注册WebGal客户端处理器
+*
+* @param client - 语言客户端实例，实现了LanguageClientLike接口
+* @param handlers - WebGal客户端处理器的可选映射对象，包含要注册的各种处理器方法
+*/
 function registerWebgalClientHandlers(client, handlers) {
 	for (const [method, handler] of Object.entries(handlers)) client.onRequest(method, handler);
 }

package/build/{client-handlers-DVUjG46C.cjs → client-handlers-BOZETgwF.cjs}

@@ -1,4 +1,5 @@
 const require_chunk = require('./chunk-C0xms8kb.cjs');
+const require_providerState = require('./providerState-Dip2XHx4.cjs');
 let _volar_language_service = require("@volar/language-service");
 let vscode_uri = require("vscode-uri");
 
@@ -33,6 +34,12 @@ const toVfsPath = (value) => value.startsWith("file://") ? uriToPath(value) : va
 
 //#endregion
 //#region src/vfs/adapter.ts
+/**
+* 创建虚拟文件系统适配器
+* 将Volar可写文件系统封装为统一的虚拟文件系统接口
+* @param fs - Volar可写文件系统实例
+* @returns 返回虚拟文件系统实例，提供文件读写、目录操作等功能
+*/
 function createVirtualFileSystem(fs) {
 	const root = fs.root;
 	return {
@@ -116,6 +123,14 @@ function createVirtualFileSystem(fs) {
 		onDidChange: (listener) => fs.onDidChange(listener)
 	};
 }
+/**
+* 创建Volar文件系统适配器
+* 将虚拟文件系统封装为Volar语言服务所需的FileSystem接口
+* @param vfs - 虚拟文件系统实例
+* @param options - 配置选项
+* @param options.uriToPath - 可选的URI到路径的转换函数，默认使用内置的转换函数
+* @returns 返回符合Volar FileSystem接口的文件系统实例
+*/
 function createVolarFileSystem(vfs, options) {
 	const uriToPathImpl = options?.uriToPath ?? ((uri) => uriToPath(uri));
 	return {
@@ -145,6 +160,14 @@ function createVolarFileSystem(vfs, options) {
 
 //#endregion
 //#region src/vfs/memory.ts
+/**
+* 创建基于内存的Volar可写文件系统
+* 该文件系统将所有文件和目录存储在内存中，不持久化到磁盘
+* @param options - 配置选项
+* @param options.root - 根目录路径，默认为"/"
+* @param options.tree - 可选的初始虚拟文件树结构
+* @returns 返回Volar可写文件系统实例，支持文件读写、目录操作和变更监听
+*/
 function createMemoryVolarFileSystem(options) {
 	const root = normalizePath(toVfsPath(options?.root ?? "/"));
 	let rootEntry = options?.tree && options.tree.type === "dir" ? options.tree : {
@@ -298,6 +321,12 @@ function createMemoryVolarFileSystem(options) {
 
 //#endregion
 //#region src/client-handlers.ts
+/**
+* 创建Webgal客户端处理器
+*
+* @param options - 创建处理器的配置选项
+* @returns 返回一个包含各种客户端处理器方法的对象
+*/
 function createWebgalClientHandlers(options) {
 	const normalizeChange = (change) => {
 		if (change.type === "writeFile") return {
@@ -327,7 +356,7 @@ function createWebgalClientHandlers(options) {
 		"client/FJoin": (args) => options.vfs.join(...Array.isArray(args) ? args : [args]),
 		"client/FStat": (path) => options.vfs.stat(toVfsPath(path)),
 		"client/findFile": ([startPath, targetName]) => options.vfs.findFile(toVfsPath(startPath), targetName),
-		"client/goPropertyDoc": options.goPropertyDoc ?? (() => null),
+		"client/goPropertyDoc": options.goPropertyDoc ?? ((path) => require_providerState.getState(path)),
 		"client/readDirectory": (uriString) => options.vfs.readDirectory(uriToPath(uriString)),
 		"client/getAllTextWithScene": () => options.vfs.getAllTextWithScene(),
 		"client/getResourceDirectory": (urls) => options.vfs.getResourceDirectory(urls),
@@ -342,6 +371,12 @@ function createWebgalClientHandlers(options) {
 		...options.overrides ?? {}
 	};
 }
+/**
+* 注册WebGal客户端处理器
+*
+* @param client - 语言客户端实例，实现了LanguageClientLike接口
+* @param handlers - WebGal客户端处理器的可选映射对象，包含要注册的各种处理器方法
+*/
 function registerWebgalClientHandlers(client, handlers) {
 	for (const [method, handler] of Object.entries(handlers)) client.onRequest(method, handler);
 }

package/build/index-Bbu_H5AG.d.mts

@@ -0,0 +1,46 @@
+import { c as VirtualFileSystem, d as VolarWritableFileSystem, o as VirtualEntry } from "./types-B7zc-Eke.mjs";
+import { FileSystem } from "@volar/language-service";
+import { URI } from "vscode-uri";
+
+//#region src/vfs/adapter.d.ts
+/**
+ * 创建虚拟文件系统适配器
+ * 将Volar可写文件系统封装为统一的虚拟文件系统接口
+ * @param fs - Volar可写文件系统实例
+ * @returns 返回虚拟文件系统实例，提供文件读写、目录操作等功能
+ */
+declare function createVirtualFileSystem(fs: VolarWritableFileSystem): VirtualFileSystem;
+/**
+ * 创建Volar文件系统适配器
+ * 将虚拟文件系统封装为Volar语言服务所需的FileSystem接口
+ * @param vfs - 虚拟文件系统实例
+ * @param options - 配置选项
+ * @param options.uriToPath - 可选的URI到路径的转换函数，默认使用内置的转换函数
+ * @returns 返回符合Volar FileSystem接口的文件系统实例
+ */
+declare function createVolarFileSystem(vfs: VirtualFileSystem, options?: {
+  uriToPath?: (uri: URI) => string;
+}): FileSystem;
+//#endregion
+//#region src/vfs/memory.d.ts
+/**
+ * 创建基于内存的Volar可写文件系统
+ * 该文件系统将所有文件和目录存储在内存中，不持久化到磁盘
+ * @param options - 配置选项
+ * @param options.root - 根目录路径，默认为"/"
+ * @param options.tree - 可选的初始虚拟文件树结构
+ * @returns 返回Volar可写文件系统实例，支持文件读写、目录操作和变更监听
+ */
+declare function createMemoryVolarFileSystem(options?: {
+  root?: string;
+  tree?: VirtualEntry;
+}): VolarWritableFileSystem;
+//#endregion
+//#region src/vfs/utils.d.ts
+declare const normalizePath: (input: string) => string;
+declare const joinPaths: (...parts: string[]) => string;
+declare const uriToPath: (value: string | URI) => string;
+declare const pathToUri: (path: string) => URI;
+declare const toVfsPath: (value: string) => string;
+//#endregion
+export { uriToPath as a, createVolarFileSystem as c, toVfsPath as i, normalizePath as n, createMemoryVolarFileSystem as o, pathToUri as r, createVirtualFileSystem as s, joinPaths as t };

package/build/index.cjs

@@ -1,5 +1,5 @@
 Object.defineProperty(exports, Symbol.toStringTag, { value: 'Module' });
-const require_client_handlers = require('./client-handlers-DVUjG46C.cjs');
+const require_client_handlers = require('./client-handlers-BOZETgwF.cjs');
 
 exports.createMemoryVolarFileSystem = require_client_handlers.createMemoryVolarFileSystem;
 exports.createVirtualFileSystem = require_client_handlers.createVirtualFileSystem;

package/build/index.d.cts

@@ -1,14 +1,36 @@
-import { a as VirtualDirectoryEntry, c as VirtualFileSystem, d as VolarWritableFileSystem, f as WebgalClientHandlers, i as MaybePromise, l as VirtualFileSystemChange, n as DirectoryEntry, o as VirtualEntry, r as LanguageClientLike, s as VirtualFileEntry, t as CreateWebgalClientHandlersOptions, u as VirtualFileSystemChangeListener } from "./types-BPQnQEAd.cjs";
+import { a as VirtualDirectoryEntry, c as VirtualFileSystem, d as VolarWritableFileSystem, f as WebgalClientHandlers, i as MaybePromise, l as VirtualFileSystemChange, n as DirectoryEntry, o as VirtualEntry, r as LanguageClientLike, s as VirtualFileEntry, t as CreateWebgalClientHandlersOptions, u as VirtualFileSystemChangeListener } from "./types-DwRo8Zlp.cjs";
 import { FileSystem } from "@volar/language-service";
 import { URI } from "vscode-uri";
 
 //#region src/vfs/adapter.d.ts
+/**
+ * 创建虚拟文件系统适配器
+ * 将Volar可写文件系统封装为统一的虚拟文件系统接口
+ * @param fs - Volar可写文件系统实例
+ * @returns 返回虚拟文件系统实例，提供文件读写、目录操作等功能
+ */
 declare function createVirtualFileSystem(fs: VolarWritableFileSystem): VirtualFileSystem;
+/**
+ * 创建Volar文件系统适配器
+ * 将虚拟文件系统封装为Volar语言服务所需的FileSystem接口
+ * @param vfs - 虚拟文件系统实例
+ * @param options - 配置选项
+ * @param options.uriToPath - 可选的URI到路径的转换函数，默认使用内置的转换函数
+ * @returns 返回符合Volar FileSystem接口的文件系统实例
+ */
 declare function createVolarFileSystem(vfs: VirtualFileSystem, options?: {
   uriToPath?: (uri: URI) => string;
 }): FileSystem;
 //#endregion
 //#region src/vfs/memory.d.ts
+/**
+ * 创建基于内存的Volar可写文件系统
+ * 该文件系统将所有文件和目录存储在内存中，不持久化到磁盘
+ * @param options - 配置选项
+ * @param options.root - 根目录路径，默认为"/"
+ * @param options.tree - 可选的初始虚拟文件树结构
+ * @returns 返回Volar可写文件系统实例，支持文件读写、目录操作和变更监听
+ */
 declare function createMemoryVolarFileSystem(options?: {
   root?: string;
   tree?: VirtualEntry;
@@ -22,7 +44,19 @@ declare const pathToUri: (path: string) => URI;
 declare const toVfsPath: (value: string) => string;
 //#endregion
 //#region src/client-handlers.d.ts
+/**
+ * 创建Webgal客户端处理器
+ *
+ * @param options - 创建处理器的配置选项
+ * @returns 返回一个包含各种客户端处理器方法的对象
+ */
 declare function createWebgalClientHandlers(options: CreateWebgalClientHandlersOptions): WebgalClientHandlers;
+/**
+ * 注册WebGal客户端处理器
+ *
+ * @param client - 语言客户端实例，实现了LanguageClientLike接口
+ * @param handlers - WebGal客户端处理器的可选映射对象，包含要注册的各种处理器方法
+ */
 declare function registerWebgalClientHandlers(client: LanguageClientLike, handlers: Partial<WebgalClientHandlers>): void;
 //#endregion
 export { CreateWebgalClientHandlersOptions, DirectoryEntry, LanguageClientLike, MaybePromise, VirtualDirectoryEntry, VirtualEntry, VirtualFileEntry, VirtualFileSystem, VirtualFileSystemChange, VirtualFileSystemChangeListener, VolarWritableFileSystem, WebgalClientHandlers, createMemoryVolarFileSystem, createVirtualFileSystem, createVolarFileSystem, createWebgalClientHandlers, joinPaths, normalizePath, pathToUri, registerWebgalClientHandlers, toVfsPath, uriToPath };

package/build/index.d.mts

@@ -1,8 +1,20 @@
-import { a as VirtualDirectoryEntry, c as VirtualFileSystem, d as VolarWritableFileSystem, f as WebgalClientHandlers, i as MaybePromise, l as VirtualFileSystemChange, n as DirectoryEntry, o as VirtualEntry, r as LanguageClientLike, s as VirtualFileEntry, t as CreateWebgalClientHandlersOptions, u as VirtualFileSystemChangeListener } from "./types-FltMUZDB.mjs";
-import { a as uriToPath, c as createVolarFileSystem, i as toVfsPath, n as normalizePath, o as createMemoryVolarFileSystem, r as pathToUri, s as createVirtualFileSystem, t as joinPaths } from "./index-75hRTxvB.mjs";
+import { a as VirtualDirectoryEntry, c as VirtualFileSystem, d as VolarWritableFileSystem, f as WebgalClientHandlers, i as MaybePromise, l as VirtualFileSystemChange, n as DirectoryEntry, o as VirtualEntry, r as LanguageClientLike, s as VirtualFileEntry, t as CreateWebgalClientHandlersOptions, u as VirtualFileSystemChangeListener } from "./types-B7zc-Eke.mjs";
+import { a as uriToPath, c as createVolarFileSystem, i as toVfsPath, n as normalizePath, o as createMemoryVolarFileSystem, r as pathToUri, s as createVirtualFileSystem, t as joinPaths } from "./index-Bbu_H5AG.mjs";
 
 //#region src/client-handlers.d.ts
+/**
+ * 创建Webgal客户端处理器
+ *
+ * @param options - 创建处理器的配置选项
+ * @returns 返回一个包含各种客户端处理器方法的对象
+ */
 declare function createWebgalClientHandlers(options: CreateWebgalClientHandlersOptions): WebgalClientHandlers;
+/**
+ * 注册WebGal客户端处理器
+ *
+ * @param client - 语言客户端实例，实现了LanguageClientLike接口
+ * @param handlers - WebGal客户端处理器的可选映射对象，包含要注册的各种处理器方法
+ */
 declare function registerWebgalClientHandlers(client: LanguageClientLike, handlers: Partial<WebgalClientHandlers>): void;
 //#endregion
 export { CreateWebgalClientHandlersOptions, DirectoryEntry, LanguageClientLike, MaybePromise, VirtualDirectoryEntry, VirtualEntry, VirtualFileEntry, VirtualFileSystem, VirtualFileSystemChange, VirtualFileSystemChangeListener, VolarWritableFileSystem, WebgalClientHandlers, createMemoryVolarFileSystem, createVirtualFileSystem, createVolarFileSystem, createWebgalClientHandlers, joinPaths, normalizePath, pathToUri, registerWebgalClientHandlers, toVfsPath, uriToPath };

package/build/index.mjs

@@ -1,3 +1,3 @@
-import { a as createVolarFileSystem, c as pathToUri, i as createVirtualFileSystem, l as toVfsPath, n as registerWebgalClientHandlers, o as joinPaths, r as createMemoryVolarFileSystem, s as normalizePath, t as createWebgalClientHandlers, u as uriToPath } from "./client-handlers-CrU8stw6.mjs";
+import { a as createVolarFileSystem, c as pathToUri, i as createVirtualFileSystem, l as toVfsPath, n as registerWebgalClientHandlers, o as joinPaths, r as createMemoryVolarFileSystem, s as normalizePath, t as createWebgalClientHandlers, u as uriToPath } from "./client-handlers-B6JBICcy.mjs";
 
 export { createMemoryVolarFileSystem, createVirtualFileSystem, createVolarFileSystem, createWebgalClientHandlers, joinPaths, normalizePath, pathToUri, registerWebgalClientHandlers, toVfsPath, uriToPath };

package/build/monaco/index.cjs

@@ -1,6 +1,6 @@
 Object.defineProperty(exports, Symbol.toStringTag, { value: 'Module' });
 const require_chunk = require('../chunk-C0xms8kb.cjs');
-const require_client_handlers = require('../client-handlers-DVUjG46C.cjs');
+const require_client_handlers = require('../client-handlers-BOZETgwF.cjs');
 const require_syntaxes = require('../syntaxes.cjs');
 const require_themes = require('../themes.cjs');
 let vscode_ws_jsonrpc = require("vscode-ws-jsonrpc");
@@ -17,9 +17,24 @@ _codingame_monaco_vscode_textmate_service_override = require_chunk.__toESM(_codi
 require("vscode/localExtensionHost");
 
 //#region src/monaco/monaco.ts
+/**
+* 创建虚拟文件系统
+* @param options - 配置选项
+* @param options.root - 根目录路径，默认为 "file:///"
+* @param options.tree - 可选的虚拟文件树结构
+* @returns 返回一个虚拟文件系统实例
+*/
 function createMemoryFileSystem(options) {
 	return require_client_handlers.createVirtualFileSystem(require_client_handlers.createMemoryVolarFileSystem(options));
 }
+/**
+* 创建WebGAL Monaco语言客户端（WebSocket连接模式）
+* @param options - 配置选项
+* @param options.languageServerUrl - 语言服务器WebSocket URL
+* @param options.editor - Monaco编辑器实例
+* @param options.virtualFileSystem - 可选的虚拟文件系统，未提供时将创建默认的内存文件系统
+* @returns 返回包含WebSocket连接和虚拟文件系统的对象
+*/
 const createWebgalMonacoLanguageClient = (options) => {
 	const { languageServerUrl, editor } = options;
 	const editorInstance = editor;
@@ -47,6 +62,14 @@ const createWebgalMonacoLanguageClient = (options) => {
 		vfs
 	};
 };
+/**
+* 创建WebGAL Monaco语言客户端（Worker模式）
+* @param options - 配置选项
+* @param options.editor - Monaco编辑器实例
+* @param options.worker - Web Worker实例
+* @param options.virtualFileSystem - 可选的虚拟文件系统，未提供时将创建默认的内存文件系统
+* @returns 返回包含Worker实例和虚拟文件系统的对象
+*/
 const createWebgalMonacoLanguageClientWithWorker = (options) => {
 	const { worker, editor } = options;
 	const editorInstance = editor;
@@ -138,6 +161,10 @@ const createLanguageClient = (messageTransports, options) => {
 //#endregion
 //#region src/monaco/monaco-init.ts
 let initPromise = null;
+/**
+* 初始化资源映射对象
+* 包含WebGAL语言服务所需的语法高亮、语言配置和主题等资源
+*/
 const initResources = {
 	"./webgal.tmLanguage.json": require_syntaxes.webgalGrammar,
 	"./webgal-config.tmLanguage.json": require_syntaxes.webgalConfigGrammar,
@@ -145,6 +172,12 @@ const initResources = {
 	"./dark.json": require_themes.webgalDarkTheme,
 	"./white.json": require_themes.webgalWhiteTheme
 };
+/**
+* 初始化WebGAL Monaco编辑器环境
+* 该函数会注册WebGAL语言扩展、语法高亮、主题配置等，并初始化Monaco编辑器的服务
+* 使用单例模式，多次调用只会执行一次初始化
+* @returns Promise<void> 初始化完成的Promise
+*/
 async function initWebgalMonaco() {
 	if (initPromise) return initPromise;
 	initPromise = (async () => {

package/build/monaco/index.d.cts

@@ -1,4 +1,4 @@
-import { c as VirtualFileSystem, o as VirtualEntry } from "../types-BPQnQEAd.cjs";
+import { c as VirtualFileSystem, o as VirtualEntry } from "../types-DwRo8Zlp.cjs";
 
 //#region src/monaco/monaco.d.ts
 interface CreateWebgalMonacoLanguageClientOptions {
@@ -6,10 +6,25 @@ interface CreateWebgalMonacoLanguageClientOptions {
   editor: any;
   virtualFileSystem?: VirtualFileSystem;
 }
+/**
+ * 创建虚拟文件系统
+ * @param options - 配置选项
+ * @param options.root - 根目录路径，默认为 "file:///"
+ * @param options.tree - 可选的虚拟文件树结构
+ * @returns 返回一个虚拟文件系统实例
+ */
 declare function createMemoryFileSystem(options?: {
   root?: string;
   tree?: VirtualEntry;
 }): VirtualFileSystem;
+/**
+ * 创建WebGAL Monaco语言客户端（WebSocket连接模式）
+ * @param options - 配置选项
+ * @param options.languageServerUrl - 语言服务器WebSocket URL
+ * @param options.editor - Monaco编辑器实例
+ * @param options.virtualFileSystem - 可选的虚拟文件系统，未提供时将创建默认的内存文件系统
+ * @returns 返回包含WebSocket连接和虚拟文件系统的对象
+ */
 declare const createWebgalMonacoLanguageClient: (options: CreateWebgalMonacoLanguageClientOptions) => {
   webSocket: WebSocket;
   vfs: VirtualFileSystem;
@@ -19,12 +34,24 @@ interface CreateWebgalMonacoLanguageClientWorkerOptions {
   worker: Worker;
   virtualFileSystem?: VirtualFileSystem;
 }
+/**
+ * 创建WebGAL Monaco语言客户端（Worker模式）
+ * @param options - 配置选项
+ * @param options.editor - Monaco编辑器实例
+ * @param options.worker - Web Worker实例
+ * @param options.virtualFileSystem - 可选的虚拟文件系统，未提供时将创建默认的内存文件系统
+ * @returns 返回包含Worker实例和虚拟文件系统的对象
+ */
 declare const createWebgalMonacoLanguageClientWithWorker: (options: CreateWebgalMonacoLanguageClientWorkerOptions) => {
   worker: Worker;
   vfs: VirtualFileSystem;
 };
 //#endregion
 //#region src/monaco/monaco-init.d.ts
+/**
+ * 初始化资源映射对象
+ * 包含WebGAL语言服务所需的语法高亮、语言配置和主题等资源
+ */
 declare const initResources: {
   "./webgal.tmLanguage.json": {
     $schema: string;
@@ -600,6 +627,12 @@ declare const initResources: {
     encodedTokensColors: never[];
   };
 };
+/**
+ * 初始化WebGAL Monaco编辑器环境
+ * 该函数会注册WebGAL语言扩展、语法高亮、主题配置等，并初始化Monaco编辑器的服务
+ * 使用单例模式，多次调用只会执行一次初始化
+ * @returns Promise<void> 初始化完成的Promise
+ */
 declare function initWebgalMonaco(): Promise<void>;
 //#endregion
 export { CreateWebgalMonacoLanguageClientOptions, CreateWebgalMonacoLanguageClientWorkerOptions, createMemoryFileSystem, createWebgalMonacoLanguageClient, createWebgalMonacoLanguageClientWithWorker, initResources, initWebgalMonaco };

package/build/monaco/index.d.mts

@@ -1,5 +1,5 @@
-import { c as VirtualFileSystem, o as VirtualEntry } from "../types-FltMUZDB.mjs";
-import "../index-75hRTxvB.mjs";
+import { c as VirtualFileSystem, o as VirtualEntry } from "../types-B7zc-Eke.mjs";
+import "../index-Bbu_H5AG.mjs";
 import "vscode/localExtensionHost";
 
 //#region src/monaco/monaco.d.ts
@@ -8,10 +8,25 @@ interface CreateWebgalMonacoLanguageClientOptions {
   editor: any;
   virtualFileSystem?: VirtualFileSystem;
 }
+/**
+ * 创建虚拟文件系统
+ * @param options - 配置选项
+ * @param options.root - 根目录路径，默认为 "file:///"
+ * @param options.tree - 可选的虚拟文件树结构
+ * @returns 返回一个虚拟文件系统实例
+ */
 declare function createMemoryFileSystem(options?: {
   root?: string;
   tree?: VirtualEntry;
 }): VirtualFileSystem;
+/**
+ * 创建WebGAL Monaco语言客户端（WebSocket连接模式）
+ * @param options - 配置选项
+ * @param options.languageServerUrl - 语言服务器WebSocket URL
+ * @param options.editor - Monaco编辑器实例
+ * @param options.virtualFileSystem - 可选的虚拟文件系统，未提供时将创建默认的内存文件系统
+ * @returns 返回包含WebSocket连接和虚拟文件系统的对象
+ */
 declare const createWebgalMonacoLanguageClient: (options: CreateWebgalMonacoLanguageClientOptions) => {
   webSocket: WebSocket;
   vfs: VirtualFileSystem;
@@ -21,12 +36,24 @@ interface CreateWebgalMonacoLanguageClientWorkerOptions {
   worker: Worker;
   virtualFileSystem?: VirtualFileSystem;
 }
+/**
+ * 创建WebGAL Monaco语言客户端（Worker模式）
+ * @param options - 配置选项
+ * @param options.editor - Monaco编辑器实例
+ * @param options.worker - Web Worker实例
+ * @param options.virtualFileSystem - 可选的虚拟文件系统，未提供时将创建默认的内存文件系统
+ * @returns 返回包含Worker实例和虚拟文件系统的对象
+ */
 declare const createWebgalMonacoLanguageClientWithWorker: (options: CreateWebgalMonacoLanguageClientWorkerOptions) => {
   worker: Worker;
   vfs: VirtualFileSystem;
 };
 //#endregion
 //#region src/monaco/monaco-init.d.ts
+/**
+ * 初始化资源映射对象
+ * 包含WebGAL语言服务所需的语法高亮、语言配置和主题等资源
+ */
 declare const initResources: {
   "./webgal.tmLanguage.json": {
     $schema: string;
@@ -602,6 +629,12 @@ declare const initResources: {
     encodedTokensColors: never[];
   };
 };
+/**
+ * 初始化WebGAL Monaco编辑器环境
+ * 该函数会注册WebGAL语言扩展、语法高亮、主题配置等，并初始化Monaco编辑器的服务
+ * 使用单例模式，多次调用只会执行一次初始化
+ * @returns Promise<void> 初始化完成的Promise
+ */
 declare function initWebgalMonaco(): Promise<void>;
 //#endregion
 export { CreateWebgalMonacoLanguageClientOptions, CreateWebgalMonacoLanguageClientWorkerOptions, createMemoryFileSystem, createWebgalMonacoLanguageClient, createWebgalMonacoLanguageClientWithWorker, initResources, initWebgalMonaco };

package/build/monaco/index.mjs

@@ -1,4 +1,4 @@
-import { i as createVirtualFileSystem, n as registerWebgalClientHandlers, r as createMemoryVolarFileSystem, t as createWebgalClientHandlers } from "../client-handlers-CrU8stw6.mjs";
+import { i as createVirtualFileSystem, n as registerWebgalClientHandlers, r as createMemoryVolarFileSystem, t as createWebgalClientHandlers } from "../client-handlers-B6JBICcy.mjs";
 import { webgalConfigGrammar, webgalGrammar, webgalLanguageConfiguration } from "../syntaxes.mjs";
 import { webgalDarkTheme, webgalWhiteTheme } from "../themes.mjs";
 import { WebSocketMessageReader, WebSocketMessageWriter, toSocket } from "vscode-ws-jsonrpc";
@@ -12,9 +12,24 @@ import getTextMateServiceOverride from "@codingame/monaco-vscode-textmate-servic
 import "vscode/localExtensionHost";
 
 //#region src/monaco/monaco.ts
+/**
+* 创建虚拟文件系统
+* @param options - 配置选项
+* @param options.root - 根目录路径，默认为 "file:///"
+* @param options.tree - 可选的虚拟文件树结构
+* @returns 返回一个虚拟文件系统实例
+*/
 function createMemoryFileSystem(options) {
 	return createVirtualFileSystem(createMemoryVolarFileSystem(options));
 }
+/**
+* 创建WebGAL Monaco语言客户端（WebSocket连接模式）
+* @param options - 配置选项
+* @param options.languageServerUrl - 语言服务器WebSocket URL
+* @param options.editor - Monaco编辑器实例
+* @param options.virtualFileSystem - 可选的虚拟文件系统，未提供时将创建默认的内存文件系统
+* @returns 返回包含WebSocket连接和虚拟文件系统的对象
+*/
 const createWebgalMonacoLanguageClient = (options) => {
 	const { languageServerUrl, editor } = options;
 	const editorInstance = editor;
@@ -42,6 +57,14 @@ const createWebgalMonacoLanguageClient = (options) => {
 		vfs
 	};
 };
+/**
+* 创建WebGAL Monaco语言客户端（Worker模式）
+* @param options - 配置选项
+* @param options.editor - Monaco编辑器实例
+* @param options.worker - Web Worker实例
+* @param options.virtualFileSystem - 可选的虚拟文件系统，未提供时将创建默认的内存文件系统
+* @returns 返回包含Worker实例和虚拟文件系统的对象
+*/
 const createWebgalMonacoLanguageClientWithWorker = (options) => {
 	const { worker, editor } = options;
 	const editorInstance = editor;
@@ -133,6 +156,10 @@ const createLanguageClient = (messageTransports, options) => {
 //#endregion
 //#region src/monaco/monaco-init.ts
 let initPromise = null;
+/**
+* 初始化资源映射对象
+* 包含WebGAL语言服务所需的语法高亮、语言配置和主题等资源
+*/
 const initResources = {
 	"./webgal.tmLanguage.json": webgalGrammar,
 	"./webgal-config.tmLanguage.json": webgalConfigGrammar,
@@ -140,6 +167,12 @@ const initResources = {
 	"./dark.json": webgalDarkTheme,
 	"./white.json": webgalWhiteTheme
 };
+/**
+* 初始化WebGAL Monaco编辑器环境
+* 该函数会注册WebGAL语言扩展、语法高亮、主题配置等，并初始化Monaco编辑器的服务
+* 使用单例模式，多次调用只会执行一次初始化
+* @returns Promise<void> 初始化完成的Promise
+*/
 async function initWebgalMonaco() {
 	if (initPromise) return initPromise;
 	initPromise = (async () => {

package/build/node.d.cts

@@ -1,4 +1,4 @@
-import { c as VirtualFileSystem } from "./types-BPQnQEAd.cjs";
+import { c as VirtualFileSystem } from "./types-DwRo8Zlp.cjs";
 
 //#region src/node.d.ts
 type NodeFileSystemOptions = {

package/build/node.d.mts

@@ -1,4 +1,4 @@
-import { c as VirtualFileSystem } from "./types-FltMUZDB.mjs";
+import { c as VirtualFileSystem } from "./types-B7zc-Eke.mjs";
 
 //#region src/node.d.ts
 type NodeFileSystemOptions = {