@gi-tcg/gts-transpiler 0.5.0 → 0.6.1

package/dist/index.js

@@ -1198,11 +1198,20 @@ function applyReplacements(state, code, mappings) {
         let ${payload.typingId} = ${typingIdLhs}.as();
         type ${payload.typingId} = typeof ${payload.typingId};
       `;
-		} else if (payload.type === "exitAttr") replacement = dedent`
+		} else if (payload.type === "exitAttr") {
+			const rewrittenMeta = `${payload.oldMetaType}_rewritten`;
+			const mergeFn = `${payload.oldMetaType}_mergeFn`;
+			const mergeFnRet = `${payload.oldMetaType}_mergeFnRet`;
+			replacement = dedent`
         type ${payload.returnType} = typeof ${payload.returnType};
-        type ${payload.newMetaType} = ${payload.returnType} extends { rewriteMeta: infer NewMeta extends {} } ? NewMeta : ${payload.oldMetaType}
+        type ${rewrittenMeta} = ${payload.returnType} extends { rewriteMeta: infer NewMeta extends {} } ? NewMeta : ${payload.oldMetaType};
+        let ${mergeFn}!: ${payload.defType} extends {
+          [${payload.attrName}]: { mergeMeta: infer M }
+       } ? M : null;
+        let ${mergeFnRet} = ${mergeFn}?.(null! as ${rewrittenMeta}, null! as ${payload.innerMetaType});
+        type ${payload.newMetaType} = [typeof ${mergeFn}] extends [null] ? ${rewrittenMeta} : typeof ${mergeFnRet};
       `;
-		else replacement = "";
+		} else replacement = "";
 		matchInfos.push({
 			sourceEnd: offset + match.length,
 			lengthOffset: replacement.length - match.length
@@ -1282,6 +1291,7 @@ const exitVM = (state, errorRange) => {
 		collectedAttrs: collectedAttrNames,
 		errorRange
 	}));
+	return { finalMetaId };
 };
 const enterAttr = (state, attrName) => {
 	const defTypeId = state.vmDefTypeIdStack.at(-1);
@@ -1317,7 +1327,7 @@ const genBindingTyping = (state, info) => {
 		typingId: info.typingId.name
 	}));
 };
-const exitAttr = (state, returningId) => {
+const exitAttr = (state, attrName, innerVMFinalMetaId, returningId) => {
 	const currentDefId = state.vmDefTypeIdStack.at(-1);
 	if (!currentDefId) return;
 	const newMetaTypeId = {
@@ -1328,6 +1338,8 @@ const exitAttr = (state, returningId) => {
 	state.typingPendingStatements.push(createReplacementHolder(state, {
 		type: "exitAttr",
 		defType: currentDefId.name,
+		attrName,
+		innerMetaType: innerVMFinalMetaId.name,
 		oldMetaType: oldMetaTypeId.name,
 		newMetaType: newMetaTypeId.name,
 		returnType: returningId.name
@@ -1508,10 +1520,11 @@ const gtsToTypingsWalker = {
 			}]
 		});
 		enterVMFromAttr(state, returnValue);
+		let exitVMResult;
 		if (body.namedAttributes) {
 			visit(body.namedAttributes);
-			exitVM(state, body.namedAttributes.range);
-		} else exitVM(state, name.range);
+			exitVMResult = exitVM(state, body.namedAttributes.range);
+		} else exitVMResult = exitVM(state, name.range);
 		if (bindingName) {
 			const export_ = node.bindingAccessModifier !== "private";
 			const typingId = {
@@ -1538,7 +1551,7 @@ const gtsToTypingsWalker = {
 				leadingComments: state.defineLeadingComments
 			});
 		}
-		exitAttr(state, returnValue);
+		exitAttr(state, attrName, exitVMResult.finalMetaId, returnValue);
 		return EMPTY;
 	},
 	GTSNamedAttributeBlock(node, { state, visit }) {
@@ -1620,7 +1633,6 @@ const DEFAULT_VOLAR_MAPPING_DATA = {
 	completion: true,
 	format: true,
 	navigation: true,
-	semantic: true,
 	structure: true,
 	verification: true
 };
@@ -1633,7 +1645,7 @@ const LITERAL_FROM_ID_MAPPING_DATA = {
 	literalFromId: true
 };
 const DIRECT_ACTION_STUB_MAPPING_DATA = {
-	...DEFAULT_VOLAR_MAPPING_DATA,
+	semantic: true,
 	directActionStub: true
 };
 const VERIFICATION_ONLY_MAPPING_DATA = { verification: true };
@@ -1653,13 +1665,22 @@ function getPrintOptions(source, state) {
 		getLeadingComments: (node) => node.leadingComments,
 		getTrailingComments: (node) => node.trailingComments,
 		getMappingData: () => DEFAULT_VOLAR_MAPPING_DATA,
-		beforeWriteNode: ({ range, isUntouched, context }) => {
-			if (isUntouched || !range) return;
+		beforeWriteNode: ({ range, node, isUntouched, context }) => {
+			if (isUntouched || !range || node.type === "ImportDeclaration") return;
 			context.writeMapped("", range.start, range.start, VERIFICATION_ONLY_MAPPING_DATA);
 		},
-		afterWriteNode: ({ range, isUntouched, context }) => {
-			if (isUntouched || !range) return;
-			context.writeMapped("", range.end, range.end, VERIFICATION_ONLY_MAPPING_DATA);
+		afterWriteNode: ({ range, node, isUntouched, context }) => {
+			const [lastImportDecl, lastImportGenerated] = state.lastImportDeclaration ?? [];
+			if (node.type === "ImportDeclaration" && lastImportDecl === node) {
+				context.write("\n");
+				let sourceOffsetBaseBase = lastImportGenerated ? state.contentStartOffset : node.range?.[1] ?? 0;
+				const sourceOffset = sourceOffsetBaseBase + Math.max(0, context.source.slice(sourceOffsetBaseBase).search(/\n/));
+				context.createExtraMapping({
+					start: sourceOffset + 1,
+					end: sourceOffset + 1
+				}, context.generatedOffset, context.generatedOffset, DEFAULT_VOLAR_MAPPING_DATA);
+			} else if (isUntouched || !range) return;
+			else context.writeMapped("", range.end, range.end, VERIFICATION_ONLY_MAPPING_DATA);
 		},
 		printers: {
 			Identifier(node, context) {
@@ -1713,16 +1734,6 @@ function getPrintOptions(source, state) {
 					}, generatedStart, generatedEnd, VERIFICATION_ONLY_MAPPING_DATA);
 				}
 			},
-			ImportDeclaration(node, context) {
-				defaultPrinters.ImportDeclaration(node, context);
-				if (state.lastImportDeclarationIfGen === node) {
-					context.write("\n");
-					context.createExtraMapping({
-						start: state.contentStartOffset,
-						end: state.contentStartOffset + 1
-					}, context.generatedOffset, context.generatedOffset + 1, DEFAULT_VOLAR_MAPPING_DATA);
-				}
-			},
 			GTSAttributeNameHintStatement(node, context) {
 				context.writeNode(node.object);
 				context.write(".");
@@ -1834,7 +1845,7 @@ function transformForVolar(ast, option, sourceInfo) {
 		directActionStubRange: /* @__PURE__ */ new WeakMap(),
 		literalFromIdentifier: /* @__PURE__ */ new WeakSet(),
 		lastArgNodes: /* @__PURE__ */ new WeakSet(),
-		lastImportDeclarationIfGen: null,
+		lastImportDeclaration: null,
 		diagnosticsOnTopNodes: /* @__PURE__ */ new WeakSet(),
 		extraMappings: [],
 		contentStartOffset: getContentStartOffset(sourceInfo.content)
@@ -1850,9 +1861,16 @@ function transformForVolar(ast, option, sourceInfo) {
 			if (lastArg) state.lastArgNodes.add(lastArg);
 		},
 		ImportDeclaration(node, { state }) {
-			if (!state.sourceNodes.has(node)) state.lastImportDeclarationIfGen = node;
+			state.lastImportDeclaration = [node, !state.sourceNodes.has(node)];
 		}
 	});
+	walk(newAst, state, { Program(node, { state }) {
+		const lastImportDeclarationNode = state.lastImportDeclaration?.[0];
+		if (lastImportDeclarationNode) {
+			const index = node.body.indexOf(lastImportDeclarationNode);
+			if (index >= 0) node.body.splice(index + 1, 0, { type: "EmptyStatement" });
+		}
+	} });
 	let { code, mappings } = print$1(newAst, getPrintOptions(sourceInfo.content, state));
 	code = applyReplacements(state, code, mappings);
 	for (const extraMapping of state.extraMappings) {
@@ -1865,12 +1883,6 @@ function transformForVolar(ast, option, sourceInfo) {
 			data: VERIFICATION_ONLY_MAPPING_DATA
 		});
 	}
-	walk(newAst, null, { ImportDeclaration(node) {
-		if (!node.range) return;
-		const endOffset = node.range[1];
-		const mappingEndsWithThisImport = mappings.find((m) => m.sourceOffsets[0] + m.lengths[0] === endOffset);
-		if (mappingEndsWithThisImport?.lengths[0]) mappingEndsWithThisImport.lengths[0] += 1;
-	} });
 	return {
 		code,
 		mappings

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@gi-tcg/gts-transpiler",
-  "version": "0.5.0",
+  "version": "0.6.1",
   "repository": {
     "type": "git",
     "url": "https://github.com/piovium/gts.git"

package/src/transform/volar/index.ts

@@ -46,7 +46,7 @@ export function transformForVolar(
     directActionStubRange: new WeakMap(),
     literalFromIdentifier: new WeakSet(),
     lastArgNodes: new WeakSet(),
-    lastImportDeclarationIfGen: null,
+    lastImportDeclaration: null,
     diagnosticsOnTopNodes: new WeakSet(),
     extraMappings: [],
     contentStartOffset: getContentStartOffset(sourceInfo.content),
@@ -61,7 +61,7 @@ export function transformForVolar(
     },
   });
   const newAst = walk(ast as AST.Node, state, gtsToTypingsWalker);
-  // mark lastArgNodes
+  // mark lastArgNodes and lastImportDeclaration
   walk(newAst as AST.Node, state, {
     CallExpression(node, { state }) {
       const lastArg = node.arguments.at(-1);
@@ -70,11 +70,22 @@ export function transformForVolar(
       }
     },
     ImportDeclaration(node, { state }) {
-      if (!state.sourceNodes.has(node)) {
-        state.lastImportDeclarationIfGen = node;
+      state.lastImportDeclaration = [node, !state.sourceNodes.has(node)];
+    },
+  });
+  walk(newAst, state, {
+    Program(node, { state }) {
+      const lastImportDeclarationNode = state.lastImportDeclaration?.[0];
+      // break continuous gap between last import declaration and its next node
+      if (lastImportDeclarationNode) {
+        const index = node.body.indexOf(lastImportDeclarationNode);
+        if (index >= 0) {
+          node.body.splice(index + 1, 0, { type: "EmptyStatement" });
+        }
       }
     },
   });
+
   const printOptions = getPrintOptions(sourceInfo.content, state);
   let { code, mappings } = print(newAst, printOptions);
   code = applyReplacements(state, code, mappings);
@@ -88,20 +99,6 @@ export function transformForVolar(
       data: VERIFICATION_ONLY_MAPPING_DATA,
     });
   }
-  walk(newAst, null, {
-    ImportDeclaration(node) {
-      if (!node.range) {
-        return;
-      }
-      const endOffset = node.range[1];
-      const mappingEndsWithThisImport = mappings.find(
-        (m) => m.sourceOffsets[0] + m.lengths[0] === endOffset,
-      );
-      if (mappingEndsWithThisImport?.lengths[0]) {
-        mappingEndsWithThisImport.lengths[0] += 1; // include the newline after the import
-      }
-    },
-  });
   return {
     code,
     mappings,

package/src/transform/volar/mappings.ts

@@ -17,7 +17,6 @@ export const DEFAULT_VOLAR_MAPPING_DATA: CodeInformation = {
   completion: true,
   format: true,
   navigation: true,
-  semantic: true,
   structure: true,
   verification: true,
 };
@@ -30,7 +29,7 @@ export const LITERAL_FROM_ID_MAPPING_DATA: CodeInformation = {
   literalFromId: true,
 }
 export const DIRECT_ACTION_STUB_MAPPING_DATA: CodeInformation = {
-  ...DEFAULT_VOLAR_MAPPING_DATA,
+  semantic: true,
   directActionStub: true,
 }
 export const VERIFICATION_ONLY_MAPPING_DATA: CodeInformation = {

package/src/transform/volar/printer.ts

@@ -20,7 +20,10 @@ import {
   LITERAL_FROM_ID_MAPPING_DATA,
   VERIFICATION_ONLY_MAPPING_DATA,
 } from "./mappings.ts";
-import type { TypingTranspileState, GTSAttributeNameHintStatement } from "./walker.ts";
+import type {
+  TypingTranspileState,
+  GTSAttributeNameHintStatement,
+} from "./walker.ts";
 
 export function getPrintOptions(
   source: string,
@@ -37,23 +40,61 @@ export function getPrintOptions(
       }
       return state.sourceNodes.has(node as Node);
     },
+    
     printCommentsOnUntouchedNodes: true,
     getLeadingComments: (node) => (node as Node).leadingComments,
     getTrailingComments: (node) => (node as Node).trailingComments,
     getMappingData: () => DEFAULT_VOLAR_MAPPING_DATA,
     // Add a 0-length mapping before and after each touched node with verification only,
     // so that error squiggles start/ends at those positions can be reflected.
-    beforeWriteNode: ({ range, isUntouched, context }) => {
-      if (isUntouched || !range) {
+    beforeWriteNode: ({ range, node, isUntouched, context }) => {
+      if (isUntouched || !range || node.type === "ImportDeclaration") {
+        // Don't do that for ImportDeclaration -- it mess up auto-import insertion point
         return;
       }
-      context.writeMapped("", range.start, range.start, VERIFICATION_ONLY_MAPPING_DATA);
+      context.writeMapped(
+        "",
+        range.start,
+        range.start,
+        VERIFICATION_ONLY_MAPPING_DATA,
+      );
     },
-    afterWriteNode: ({ range, isUntouched, context }) => {
-      if (isUntouched || !range) {
+    afterWriteNode: ({ range, node, isUntouched, context }) => {
+      const [lastImportDecl, lastImportGenerated] =
+        state.lastImportDeclaration ?? [];
+      if (node.type === "ImportDeclaration" && lastImportDecl === node) {
+        // If the last import declaration is a generated one, because of we ensured that
+        // the generated import declarations are always unsorted, so TSServer will set the
+        // auto-insertion point next to this last import declaration.
+        // Add a mapping to that position (a written newline character) to the top-of-file,
+        // after skipping hashbang and leading comments.
+        context.write("\n");
+        let sourceOffsetBaseBase = lastImportGenerated
+          ? state.contentStartOffset
+          : (node.range?.[1] ?? 0);
+        const sourceOffset =
+          sourceOffsetBaseBase +
+          Math.max(0, context.source.slice(sourceOffsetBaseBase).search(/\n/));
+        // These +1s below is magic and I don't know why, but it works.
+        context.createExtraMapping(
+          {
+            start: sourceOffset + 1,
+            end: sourceOffset + 1,
+          },
+          context.generatedOffset,
+          context.generatedOffset,
+          DEFAULT_VOLAR_MAPPING_DATA,
+        );
+      } else if (isUntouched || !range) {
         return;
+      } else {
+        context.writeMapped(
+          "",
+          range.end,
+          range.end,
+          VERIFICATION_ONLY_MAPPING_DATA,
+        );
       }
-      context.writeMapped("", range.end, range.end, VERIFICATION_ONLY_MAPPING_DATA);
     },
     printers: {
       // 1) Make the print of dummy identifier print nothing.
@@ -115,7 +156,9 @@ export function getPrintOptions(
             node.range[1],
             ATTRIBUTE_NAME_MAPPING_DATA,
           );
-        } else if ((directActionStubRange = state.directActionStubRange.get(node))) {
+        } else if (
+          (directActionStubRange = state.directActionStubRange.get(node))
+        ) {
           // For direct action stubs, add mappings from this expression statement line to the
           // start of original direct action start position. Add `directActionStub` data
           // for recognizing them in language service plugin.
@@ -124,7 +167,7 @@ export function getPrintOptions(
             directActionStubRange.start,
             directActionStubRange.start + 1,
             DIRECT_ACTION_STUB_MAPPING_DATA,
-          )
+          );
         } else {
           defaultPrinters.Literal(node, context);
         }
@@ -168,37 +211,17 @@ export function getPrintOptions(
           );
         }
       },
-      // If the last import declaration is a generated one, because of we ensured that
-      // the generated import declarations are always unsorted, so TSServer will set the
-      // auto-insertion point next to this last import declaration.
-      // Add a mapping to that position (a written newline character) to the top-of-file,
-      // after skipping hashbang and leading comments.
-      // NOTE: since the insertion derived from here won't add additional newline *before*
-      // the inserted text, so here is a difference behavior from standard TSServer and our
-      // language server. We'd try our best.
-      ImportDeclaration(node, context) {
-        defaultPrinters.ImportDeclaration(node, context);
-        if (state.lastImportDeclarationIfGen === node) {
-          context.write("\n");
-          context.createExtraMapping(
-            {
-              start: state.contentStartOffset,
-              end: state.contentStartOffset + 1,
-            },
-            context.generatedOffset,
-            context.generatedOffset + 1,
-            DEFAULT_VOLAR_MAPPING_DATA,
-          );
-        }
-      },
       // @ts-expect-error This is a custom node type that don't have typing.
       // @see `GTSAttributeNameHintStatement`
-      GTSAttributeNameHintStatement(node: GTSAttributeNameHintStatement, context: PrinterContext<CodeInformation>) {
+      GTSAttributeNameHintStatement(
+        node: GTSAttributeNameHintStatement,
+        context: PrinterContext<CodeInformation>,
+      ) {
         context.writeNode(node.object as EspolarAST.Node);
         context.write(".");
         context.writeSource(node.whiteSpaceStart, node.whiteSpaceEnd);
         context.write(";");
-      }
+      },
     },
     // Enable triggering signature completion
     experimentalGetLeftParenSourceRange: (node) => {

package/src/transform/volar/replacements.ts

@@ -51,6 +51,8 @@ type ReplacementPayload =
       type: "exitAttr";
       returnType: string;
       defType: string;
+      attrName: string;
+      innerMetaType: string;
       oldMetaType: string;
       newMetaType: string;
     };
@@ -194,9 +196,17 @@ export function applyReplacements(
         type ${payload.typingId} = typeof ${payload.typingId};
       `;
       } else if (payload.type === "exitAttr") {
+        const rewrittenMeta = `${payload.oldMetaType}_rewritten`;
+        const mergeFn = `${payload.oldMetaType}_mergeFn`;
+        const mergeFnRet = `${payload.oldMetaType}_mergeFnRet`;
         replacement = dedent`
         type ${payload.returnType} = typeof ${payload.returnType};
-        type ${payload.newMetaType} = ${payload.returnType} extends { rewriteMeta: infer NewMeta extends {} } ? NewMeta : ${payload.oldMetaType}
+        type ${rewrittenMeta} = ${payload.returnType} extends { rewriteMeta: infer NewMeta extends {} } ? NewMeta : ${payload.oldMetaType};
+        let ${mergeFn}!: ${payload.defType} extends {
+          [${payload.attrName}]: { mergeMeta: infer M }
+       } ? M : null;
+        let ${mergeFnRet} = ${mergeFn}?.(null! as ${rewrittenMeta}, null! as ${payload.innerMetaType});
+        type ${payload.newMetaType} = [typeof ${mergeFn}] extends [null] ? ${rewrittenMeta} : typeof ${mergeFnRet};
       `;
       } else {
         replacement = "";

package/src/transform/volar/walker.ts

@@ -76,10 +76,10 @@ export interface TypingTranspileState extends TranspileState {
   /** Nodes that are last arguments of a CallExpression */
   lastArgNodes: WeakSet<Node>;
   /**
-   * The last import declaration, record if it is a generated one.
-   * This declaration marks the TS auto-import insertion point.
+   * The last import declaration and whether it is a generated one.
+   * This declaration marks the TS auto-import insertion point if it's generated.
    */
-  lastImportDeclarationIfGen: ImportDeclaration | null;
+  lastImportDeclaration: [node: ImportDeclaration, generated: boolean] | null;
   /** Nodes that have a diagnostic mappings to the top of the file */
   diagnosticsOnTopNodes: WeakSet<Node>;
   /** Extra mappings, the generated range will be found by the needle after replacement */
@@ -168,7 +168,14 @@ const enterVMFromAttr = (
   state.attrsOfCurrentVm.push([]);
 };
 
-const exitVM = (state: TypingTranspileState, errorRange?: [number, number]) => {
+interface ExitVMResult {
+  finalMetaId: Identifier;
+}
+
+const exitVM = (
+  state: TypingTranspileState,
+  errorRange?: [number, number],
+): ExitVMResult => {
   const currentDefTypeId = state.vmDefTypeIdStack.pop()!;
   const currentMetaId = state.metaTypeIdStack.pop()!;
   const finalMetaId = state.finalMetaTypeIdStack.pop()!;
@@ -183,17 +190,24 @@ const exitVM = (state: TypingTranspileState, errorRange?: [number, number]) => {
       errorRange,
     }),
   );
+  return { finalMetaId };
 };
 
+interface EnterAttrResult {
+  lhsId: Identifier;
+}
+
 const enterAttr = (
   state: TypingTranspileState,
   attrName: string,
-): { lhsId: Identifier } => {
+): EnterAttrResult => {
   const defTypeId = state.vmDefTypeIdStack.at(-1);
   const metaTypeId = state.metaTypeIdStack.at(-1);
   if (!defTypeId || !metaTypeId) {
     // FIXME error handling?
-    return { lhsId: { type: "Identifier", name: "__gts_invalid_attr_obj" } };
+    return {
+      lhsId: { type: "Identifier", name: "__gts_invalid_attr_obj" },
+    };
   }
   state.attrsOfCurrentVm.at(-1)!.push(attrName);
   const lhsId: Identifier = {
@@ -210,7 +224,7 @@ const enterAttr = (
       hintOnly: attrName === ATTR_HINT_ATTR_NAME,
     }),
   );
-  return { lhsId: lhsId };
+  return { lhsId };
 };
 
 const genBindingTyping = (
@@ -236,7 +250,12 @@ const genBindingTyping = (
   );
 };
 
-const exitAttr = (state: TypingTranspileState, returningId: Identifier) => {
+const exitAttr = (
+  state: TypingTranspileState,
+  attrName: string,
+  innerVMFinalMetaId: Identifier,
+  returningId: Identifier,
+) => {
   const currentDefId = state.vmDefTypeIdStack.at(-1);
   if (!currentDefId) {
     return;
@@ -250,6 +269,8 @@ const exitAttr = (state: TypingTranspileState, returningId: Identifier) => {
     createReplacementHolder(state, {
       type: "exitAttr",
       defType: currentDefId.name,
+      attrName,
+      innerMetaType: innerVMFinalMetaId.name,
       oldMetaType: oldMetaTypeId.name,
       newMetaType: newMetaTypeId.name,
       returnType: returningId.name,
@@ -473,11 +494,12 @@ export const gtsToTypingsWalker: Visitors<Node, TypingTranspileState> = {
       ],
     });
     enterVMFromAttr(state, returnValue);
+    let exitVMResult: ExitVMResult;
     if (body.namedAttributes) {
       visit(body.namedAttributes);
-      exitVM(state, body.namedAttributes.range);
+      exitVMResult = exitVM(state, body.namedAttributes.range);
     } else {
-      exitVM(state, name.range);
+      exitVMResult = exitVM(state, name.range);
     }
     if (bindingName) {
       const export_ = node.bindingAccessModifier !== "private";
@@ -505,7 +527,7 @@ export const gtsToTypingsWalker: Visitors<Node, TypingTranspileState> = {
         leadingComments: state.defineLeadingComments,
       });
     }
-    exitAttr(state, returnValue);
+    exitAttr(state, attrName, exitVMResult.finalMetaId, returnValue);
     return EMPTY;
   },
   GTSNamedAttributeBlock(node, { state, visit }) {