Add ref comment for typealias (#29)

pkl-community · Mar 17, 2024 · bda315f · bda315f
1 parent bd1df67
commit bda315f
Show file tree

Hide file tree

Showing 3 changed files with 8 additions and 1 deletion.
diff --git a/codegen/snippet-tests/output/06_with_type_alias.pkl.ts b/codegen/snippet-tests/output/06_with_type_alias.pkl.ts
@@ -16,8 +16,10 @@ export interface MyClassToBeAliased {
   b: number
 }
 
+// Ref: Pkl type `06-withTypeAlias.MyStringAlias`.
 type MyStringAlias = string
 
+// Ref: Pkl type `06-withTypeAlias.MyAliasedClass`.
 type MyAliasedClass = MyClassToBeAliased
 
 // LoadFromPath loads the pkl module at the given path and evaluates it into a N06WithTypeAlias

diff --git a/codegen/snippet-tests/output/n12_pkl_typescript_tests_module_name_override.pkl.ts b/codegen/snippet-tests/output/n12_pkl_typescript_tests_module_name_override.pkl.ts
@@ -14,6 +14,7 @@ export interface MyCustomClassName {
   name: string
 }
 
+// Ref: Pkl type `n12.pkl.typescript.tests.moduleNameOverride.AliasName`.
 type ThisTypeAlias = "x" | "y" | MyCustomClassName
 
 // LoadFromPath loads the pkl module at the given path and evaluates it into a N12TypescriptGeneratedInterface

diff --git a/codegen/src/internal/TypeAliasGen.pkl b/codegen/src/internal/TypeAliasGen.pkl
@@ -10,4 +10,8 @@ typealiaz: reflect.TypeAlias = mapping.source as reflect.TypeAlias
 
 type: Type = typegen.generateType(typealiaz.referent, typealiaz, mappings)
 
-contents = "type \(mapping.name) = \(type.render(typescriptModule))"
+contents = new Listing {
+  "// Ref: Pkl type `\(typealiaz.enclosingDeclaration.name).\(typealiaz.name)`."
+
+  "type \(module.mapping.name) = \(type.render(module.typescriptModule))"
+}.join("\n")