@gi-tcg/gts-transpiler 0.4.4 → 0.4.6

package/dist/index.js

@@ -1293,7 +1293,7 @@ function applyReplacements(state, code, mappings) {
                 ? ${payload.attrName}                             /* have duplicate, disable this */
                 : never
         );
-        let ${payload.lhs}!: { ${Meta}: ${payload.metaType} } & Omit<${payload.defType}, ${omittedKeys}>;
+        let ${payload.lhs}!: ${payload.hintOnly ? `{}` : `{ ${Meta}: ${payload.metaType} }`} & Omit<${payload.defType}, ${omittedKeys}>;
       `;
 		} else if (payload.type === "createBindingTyping") {
 			const typingIdLhs = `${payload.typingId}_lhs`;
@@ -1328,6 +1328,7 @@ function applyReplacements(state, code, mappings) {
 //#endregion
 //#region src/transform/volar/walker.ts
 const EMPTY = { type: "EmptyStatement" };
+const ATTR_HINT_ATTR_NAME = JSON.stringify("~attrNameHint");
 const enterVMFromRoot = (state) => {
 	let defTypeId = {
 		type: "Identifier",
@@ -1407,7 +1408,8 @@ const enterAttr = (state, attrName) => {
 		defType: defTypeId.name,
 		metaType: metaTypeId.name,
 		lhs: lhsId.name,
-		attrName
+		attrName,
+		hintOnly: attrName === ATTR_HINT_ATTR_NAME
 	}));
 	return { lhsId };
 };
@@ -1439,6 +1441,16 @@ const exitAttr = (state, returningId) => {
 		returnType: returningId.name
 	}));
 };
+const insertHintStatement = (state, whiteSpaceStart, whiteSpaceEnd) => {
+	const { lhsId } = enterAttr(state, ATTR_HINT_ATTR_NAME);
+	state.typingPendingStatements.push({
+		type: "GTSAttributeNameHintStatement",
+		object: lhsId,
+		whiteSpaceStart,
+		whiteSpaceEnd
+	});
+	`${state.idCounter++}`;
+};
 const gtsToTypingsWalker = {
 	Program(node, { state, visit }) {
 		const body = [];
@@ -1638,7 +1650,17 @@ const gtsToTypingsWalker = {
 		return EMPTY;
 	},
 	GTSNamedAttributeBlock(node, { state, visit }) {
-		for (const attr of node.attributes) visit(attr);
+		const attributeListEnd = node.directAction?.range?.[0] ?? node.range?.[1] ?? -1;
+		const attributeListStart = node.attributes[0]?.range?.[0] ?? attributeListEnd;
+		if (node.range && attributeListStart > node.range[0] + 1) insertHintStatement(state, node.range[0] + 1, attributeListStart - 1);
+		for (let i = 0; i < node.attributes.length; i++) {
+			const attribute = node.attributes[i];
+			visit(attribute);
+			let nextTokenStart;
+			if (i < node.attributes.length - 1) nextTokenStart = node.attributes[i + 1].range?.[0] ?? -1;
+			else nextTokenStart = attributeListEnd;
+			if (attribute.range && nextTokenStart > attribute.range[1]) insertHintStatement(state, attribute.range[1], nextTokenStart - 1);
+		}
 		if (node.directAction) {
 			const stubStatement = {
 				type: "ExpressionStatement",
@@ -1735,6 +1757,7 @@ function getPrintOptions(source, state) {
 			if (state.attributeNameNodes.has(node)) return false;
 			return state.sourceNodes.has(node);
 		},
+		printCommentsOnUntouchedNodes: true,
 		getLeadingComments: (node) => node.leadingComments,
 		getTrailingComments: (node) => node.trailingComments,
 		getMappingData: () => DEFAULT_VOLAR_MAPPING_DATA,
@@ -1804,6 +1827,12 @@ function getPrintOptions(source, state) {
 						end: state.contentStartOffset + 1
 					}, context.generatedOffset, context.generatedOffset + 1, DEFAULT_VOLAR_MAPPING_DATA);
 				}
+			},
+			GTSAttributeNameHintStatement(node, context) {
+				context.writeNode(node.object);
+				context.write(".");
+				context.writeSource(node.whiteSpaceStart, node.whiteSpaceEnd);
+				context.write(";");
 			}
 		},
 		experimentalGetLeftParenSourceRange: (node) => {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@gi-tcg/gts-transpiler",
-  "version": "0.4.4",
+  "version": "0.4.6",
   "repository": {
     "type": "git",
     "url": "https://github.com/piovium/gts.git"
@@ -22,7 +22,7 @@
     "@sveltejs/acorn-typescript": "^1.0.8",
     "acorn": "^8.15.0",
     "dedent": "^1.7.2",
-    "espolar": "^0.6.0",
+    "espolar": "^0.6.1",
     "esrap": "2.2.1",
     "magic-string": "^0.30.21",
     "path-browserify-esm": "^1.0.6",

package/src/transform/volar/printer.ts

@@ -10,6 +10,7 @@ import {
   type AST as EspolarAST,
   defaultPrinters,
   type SourceRange,
+  type PrinterContext,
 } from "espolar";
 import type { CodeInformation } from "@volar/language-core";
 import {
@@ -19,7 +20,7 @@ import {
   LITERAL_FROM_ID_MAPPING_DATA,
   VERIFICATION_ONLY_MAPPING_DATA,
 } from "./mappings.ts";
-import type { TypingTranspileState } from "./walker.ts";
+import type { TypingTranspileState, GTSAttributeNameHintStatement } from "./walker.ts";
 
 export function getPrintOptions(
   source: string,
@@ -36,6 +37,7 @@ 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,
@@ -186,6 +188,14 @@ export function getPrintOptions(
           );
         }
       },
+      // @ts-expect-error This is a custom node type that don't have typing.
+      // @see `GTSAttributeNameHintStatement`
+      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

@@ -38,6 +38,7 @@ type ReplacementPayload =
       metaType: string;
       lhs: string;
       attrName: string;
+      hintOnly: boolean;
     }
   | {
       type: "createBindingTyping";
@@ -179,7 +180,7 @@ export function applyReplacements(
                 ? ${payload.attrName}                             /* have duplicate, disable this */
                 : never
         );
-        let ${payload.lhs}!: { ${Meta}: ${payload.metaType} } & Omit<${payload.defType}, ${omittedKeys}>;
+        let ${payload.lhs}!: ${payload.hintOnly ? `{}` : `{ ${Meta}: ${payload.metaType} }`} & Omit<${payload.defType}, ${omittedKeys}>;
       `;
       } else if (payload.type === "createBindingTyping") {
         const typingIdLhs = `${payload.typingId}_lhs`;

package/src/transform/volar/walker.ts

@@ -92,7 +92,25 @@ export interface TypingTranspileState extends TranspileState {
   contentStartOffset: number;
 }
 
+/**
+ * Map whitespaces inside named attribute blocks to include a "NameHintStatement", which printed
+ * as following:
+ * ```ts
+ * __gts_attr_obj.      ;
+ * //             ^~~~~~ these whitespaces are mapped from source
+ * ```
+ * so that when user press Ctrl+Space inside whitespace characters, they can get hint of available
+ * attribute names inside this block.
+ */
+export interface GTSAttributeNameHintStatement {
+  type: "GTSAttributeNameHintStatement";
+  object: Identifier;
+  whiteSpaceStart: number;
+  whiteSpaceEnd: number;
+}
+
 const EMPTY: EmptyStatement = { type: "EmptyStatement" };
+const ATTR_HINT_ATTR_NAME = JSON.stringify("~attrNameHint");
 
 const enterVMFromRoot = (state: TypingTranspileState) => {
   let defTypeId: Identifier = {
@@ -174,7 +192,7 @@ const enterAttr = (
   const defTypeId = state.vmDefTypeIdStack.at(-1);
   const metaTypeId = state.metaTypeIdStack.at(-1);
   if (!defTypeId || !metaTypeId) {
-    // TODO error handling?
+    // FIXME error handling?
     return { lhsId: { type: "Identifier", name: "__gts_invalid_attr_obj" } };
   }
   state.attrsOfCurrentVm.at(-1)!.push(attrName);
@@ -189,6 +207,7 @@ const enterAttr = (
       metaType: metaTypeId.name,
       lhs: lhsId.name,
       attrName,
+      hintOnly: attrName === ATTR_HINT_ATTR_NAME,
     }),
   );
   return { lhsId: lhsId };
@@ -238,6 +257,25 @@ const exitAttr = (state: TypingTranspileState, returningId: Identifier) => {
   );
 };
 
+const insertHintStatement = (
+  state: TypingTranspileState,
+  whiteSpaceStart: number,
+  whiteSpaceEnd: number,
+) => {
+  const { lhsId } = enterAttr(state, ATTR_HINT_ATTR_NAME);
+  state.typingPendingStatements.push({
+    type: "GTSAttributeNameHintStatement",
+    object: lhsId,
+    whiteSpaceStart,
+    whiteSpaceEnd,
+  } satisfies GTSAttributeNameHintStatement as any);
+  const returnValue: Identifier = {
+    type: "Identifier",
+    name: `__gts_attrRet_hint_${state.idCounter++}`,
+  };
+  // do NOT exitAttr (rewrite meta) since hint is a incomplete structure
+};
+
 export const gtsToTypingsWalker: Visitors<Node, TypingTranspileState> = {
   Program(node, { state, visit }) {
     const body: Program["body"] = [];
@@ -471,8 +509,35 @@ export const gtsToTypingsWalker: Visitors<Node, TypingTranspileState> = {
     return EMPTY;
   },
   GTSNamedAttributeBlock(node, { state, visit }) {
-    for (const attr of node.attributes) {
-      visit(attr);
+    // Insert hint statement around each attribute name:
+    // ```
+    // define foo {
+    //   // (1) hidden hint
+    //   bar 1; // (2a) hidden hint
+    //   baz 2; // (2b) hidden hint
+    // }
+    // ```
+    const attributeListEnd =
+      node.directAction?.range?.[0] ?? node.range?.[1] ?? -1;
+    const attributeListStart =
+      node.attributes[0]?.range?.[0] ?? attributeListEnd;
+    // (1)
+    if (node.range && attributeListStart > node.range[0] + 1) {
+      insertHintStatement(state, node.range[0] + 1, attributeListStart - 1);
+    }
+    for (let i = 0; i < node.attributes.length; i++) {
+      const attribute = node.attributes[i];
+      visit(attribute);
+      let nextTokenStart: number;
+      if (i < node.attributes.length - 1) {
+        nextTokenStart = node.attributes[i + 1].range?.[0] ?? -1;
+      } else {
+        nextTokenStart = attributeListEnd;
+      }
+      // (2)
+      if (attribute.range && nextTokenStart > attribute.range[1]) {
+        insertHintStatement(state, attribute.range[1], nextTokenStart - 1);
+      }
     }
     if (node.directAction) {
       const stubStatement: ExpressionStatement = {
@@ -529,6 +594,8 @@ export const gtsToTypingsWalker: Visitors<Node, TypingTranspileState> = {
           },
         ],
       });
+      // rewriting meta is unnecessary since direct action must be the last attribute
+      // exitAttr(state, returnValue);
     }
     return EMPTY;
   },