@volar/language-core 2.3.0-alpha.6 → 2.3.0-alpha.8

package/index.d.ts

@@ -5,4 +5,4 @@ export * from './lib/types';
 export * from './lib/utils';
 import type { Language, LanguagePlugin, SourceScript, VirtualCode } from './lib/types';
 export declare function createLanguage<T>(plugins: LanguagePlugin<T>[], scriptRegistry: Map<T, SourceScript<T>>, sync: (id: T) => void): Language<T>;
-export declare function forEachEmbeddedCode<T>(virtualCode: VirtualCode<T>): Generator<VirtualCode<T>>;
+export declare function forEachEmbeddedCode(virtualCode: VirtualCode): Generator<VirtualCode>;

package/index.js

@@ -34,6 +34,11 @@ function createLanguage(plugins, scriptRegistry, sync) {
             },
             get(id) {
                 sync(id);
+                const result = scriptRegistry.get(id);
+                // The sync function provider may not always call the set function due to caching, so it is necessary to explicitly check isAssociationDirty.
+                if (result?.isAssociationDirty) {
+                    this.set(id, result.snapshot, result.languageId);
+                }
                 return scriptRegistry.get(id);
             },
             set(id, snapshot, languageId, _plugins = plugins) {
@@ -49,13 +54,22 @@ function createLanguage(plugins, scriptRegistry, sync) {
                     console.warn(`languageId not found for ${id}`);
                     return;
                 }
+                let associatedOnly = false;
+                for (const plugin of plugins) {
+                    if (plugin.isAssociatedFileOnly?.(id, languageId)) {
+                        associatedOnly = true;
+                        break;
+                    }
+                }
                 if (scriptRegistry.has(id)) {
                     const sourceScript = scriptRegistry.get(id);
-                    if (sourceScript.languageId !== languageId) {
-                        // languageId changed
+                    if (sourceScript.languageId !== languageId || sourceScript.associatedOnly !== associatedOnly) {
                         this.delete(id);
                         return this.set(id, snapshot, languageId);
                     }
+                    else if (associatedOnly) {
+                        sourceScript.snapshot = snapshot;
+                    }
                     else if (sourceScript.isAssociationDirty || sourceScript.snapshot !== snapshot) {
                         // snapshot updated
                         sourceScript.snapshot = snapshot;
@@ -94,8 +108,12 @@ function createLanguage(plugins, scriptRegistry, sync) {
                         snapshot,
                         associatedIds: new Set(),
                         targetIds: new Set(),
+                        associatedOnly
                     };
                     scriptRegistry.set(id, sourceScript);
+                    if (associatedOnly) {
+                        return sourceScript;
+                    }
                     for (const languagePlugin of _plugins) {
                         const virtualCode = languagePlugin.createVirtualCode?.(id, languageId, snapshot, prepareCreateVirtualCode(sourceScript));
                         if (virtualCode) {

package/lib/types.d.ts

@@ -7,14 +7,14 @@ export interface Language<T = unknown> {
         get(id: T): SourceScript<T> | undefined;
         set(id: T, snapshot: ts.IScriptSnapshot, languageId?: string, plugins?: LanguagePlugin<T>[]): SourceScript<T> | undefined;
         delete(id: T): void;
-        fromVirtualCode(virtualCode: VirtualCode<T>): SourceScript<T>;
+        fromVirtualCode(virtualCode: VirtualCode): SourceScript<T>;
     };
     maps: {
-        get(virtualCode: VirtualCode<T>): SourceMap<CodeInformation>;
-        forEach(virtualCode: VirtualCode<T>): Generator<[id: T, snapshot: ts.IScriptSnapshot, map: SourceMap<CodeInformation>]>;
+        get(virtualCode: VirtualCode): SourceMap<CodeInformation>;
+        forEach(virtualCode: VirtualCode): Generator<[id: T, snapshot: ts.IScriptSnapshot, map: SourceMap<CodeInformation>]>;
     };
     linkedCodeMaps: {
-        get(virtualCode: VirtualCode<T>): LinkedCodeMap | undefined;
+        get(virtualCode: VirtualCode): LinkedCodeMap | undefined;
     };
     typescript?: {
         configFileName: string | undefined;
@@ -23,7 +23,7 @@ export interface Language<T = unknown> {
             sync?(): Promise<number>;
         };
         languageServiceHost: ts.LanguageServiceHost;
-        getExtraServiceScript(fileName: string): TypeScriptExtraServiceScript<T> | undefined;
+        getExtraServiceScript(fileName: string): TypeScriptExtraServiceScript | undefined;
         asScriptId(fileName: string): T;
         asFileName(scriptId: T): string;
     };
@@ -34,21 +34,22 @@ export interface SourceScript<T = unknown> {
     snapshot: ts.IScriptSnapshot;
     targetIds: Set<T>;
     associatedIds: Set<T>;
+    associatedOnly: boolean;
     isAssociationDirty?: boolean;
     generated?: {
-        root: VirtualCode<T>;
+        root: VirtualCode;
         languagePlugin: LanguagePlugin<T>;
-        embeddedCodes: Map<string, VirtualCode<T>>;
+        embeddedCodes: Map<string, VirtualCode>;
     };
 }
 export type CodeMapping = Mapping<CodeInformation>;
-export interface VirtualCode<T = unknown> {
+export interface VirtualCode {
     id: string;
     languageId: string;
     snapshot: ts.IScriptSnapshot;
     mappings: CodeMapping[];
-    associatedScriptMappings?: Map<T, CodeMapping[]>;
-    embeddedCodes?: VirtualCode<T>[];
+    associatedScriptMappings?: Map<unknown, CodeMapping[]>;
+    embeddedCodes?: VirtualCode[];
     linkedCodeMappings?: Mapping[];
 }
 export interface CodeInformation {
@@ -76,17 +77,17 @@ export interface CodeInformation {
     /** virtual code is expected correctly reflect the format information of the source code */
     format?: boolean;
 }
-export interface TypeScriptServiceScript<T = unknown> {
-    code: VirtualCode<T>;
+export interface TypeScriptServiceScript {
+    code: VirtualCode;
     extension: '.ts' | '.js' | '.mts' | '.mjs' | '.cjs' | '.cts' | '.d.ts' | string;
     scriptKind: ts.ScriptKind;
     /** See #188 */
     preventLeadingOffset?: boolean;
 }
-export interface TypeScriptExtraServiceScript<T = unknown> extends TypeScriptServiceScript<T> {
+export interface TypeScriptExtraServiceScript extends TypeScriptServiceScript {
     fileName: string;
 }
-export interface LanguagePlugin<T = unknown, K extends VirtualCode<T> = VirtualCode<T>> {
+export interface LanguagePlugin<T = unknown, K extends VirtualCode = VirtualCode> {
     /**
      * For files that are not opened in the IDE, the language ID will not be synchronized to the language server, so a hook is needed to parse the language ID of files that are known extension but not opened in the IDE.
      */
@@ -103,7 +104,14 @@ export interface LanguagePlugin<T = unknown, K extends VirtualCode<T> = VirtualC
      * Cleanup a virtual code.
      */
     disposeVirtualCode?(scriptId: T, virtualCode: K): void;
-    typescript?: TypeScriptGenericOptions<T, K> & TypeScriptNonTSPluginOptions<T, K>;
+    /**
+     * Some file types should not be parsed or processed as TypeScript files,
+     * as they are used only as sources for generated files.
+     *
+     * This functionality is required only in TS plugin mode.
+     */
+    isAssociatedFileOnly?(scriptId: T, languageId: string): boolean;
+    typescript?: TypeScriptGenericOptions<K> & TypeScriptNonTSPluginOptions<K>;
 }
 export interface CodegenContext<T = unknown> {
     getAssociatedScript(scriptId: T): SourceScript<T> | undefined;
@@ -111,16 +119,16 @@ export interface CodegenContext<T = unknown> {
 /**
  * The following options available to all situations.
  */
-interface TypeScriptGenericOptions<T, K> {
+interface TypeScriptGenericOptions<K> {
     extraFileExtensions: ts.FileExtensionInfo[];
     resolveHiddenExtensions?: boolean;
-    getServiceScript(root: K): TypeScriptServiceScript<T> | undefined;
+    getServiceScript(root: K): TypeScriptServiceScript | undefined;
 }
 /**
  * The following options will not be available in TS plugin.
  */
-interface TypeScriptNonTSPluginOptions<T, K> {
-    getExtraServiceScripts?(fileName: string, rootVirtualCode: K): TypeScriptExtraServiceScript<T>[];
+interface TypeScriptNonTSPluginOptions<K> {
+    getExtraServiceScripts?(fileName: string, rootVirtualCode: K): TypeScriptExtraServiceScript[];
     resolveLanguageServiceHost?(host: ts.LanguageServiceHost): ts.LanguageServiceHost;
 }
 export {};

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "@volar/language-core",
-	"version": "2.3.0-alpha.6",
+	"version": "2.3.0-alpha.8",
 	"license": "MIT",
 	"files": [
 		"**/*.js",
@@ -12,7 +12,7 @@
 		"directory": "packages/language-core"
 	},
 	"dependencies": {
-		"@volar/source-map": "2.3.0-alpha.6"
+		"@volar/source-map": "2.3.0-alpha.8"
 	},
-	"gitHead": "f3103e86be8d80cb36f66be4c054ef9a255c29b1"
+	"gitHead": "377a0083ac697a476509805a6777a2339391dcaf"
 }