Turn module type usage warnings into errors (#1977)

pkl-core/src/main/java/org/pkl/core/ast/builder/AstBuilder.java

@@ -209,7 +209,6 @@ import org.pkl.core.stdlib.registry.ExternalMemberRegistry;
 import org.pkl.core.stdlib.registry.MemberRegistryFactory;
 import org.pkl.core.util.CollectionUtils;
 import org.pkl.core.util.EconomicMaps;
-import org.pkl.core.util.ErrorMessages;
 import org.pkl.core.util.IoUtils;
 import org.pkl.core.util.Pair;
 import org.pkl.parser.Span;
@@ -394,14 +393,20 @@ public class AstBuilder extends AbstractAstBuilder<Object> {
     if (currentScope.getConstLevel() == ConstLevel.MODULE) {
       for (var scope = currentScope; scope != null; scope = scope.getParent()) {
         if (scope.isAnnotationScope()) {
-          errorMessage = ErrorMessages.create("invalidModuleTypeInAnnotation");
+          throw exceptionBuilder()
-          break;
+              .withSourceSection(sourceSection)
+              .evalError("invalidModuleTypeInAnnotation")
+              .build();
         } else if (scope.isClassScope()) {
-          errorMessage = ErrorMessages.create("invalidModuleTypeInClass");
+          throw exceptionBuilder()
-          break;
+              .withSourceSection(sourceSection)
+              .evalError("invalidModuleTypeInClass")
+              .build();
         } else if (scope.isTypeAliasScope()) {
-          errorMessage = ErrorMessages.create("invalidModuleTypeInTypeAlias");
+          throw exceptionBuilder()
-          break;
+              .withSourceSection(sourceSection)
+              .evalError("invalidModuleTypeInTypeAlias")
+              .build();
         }
       }
     }
@@ -418,18 +423,16 @@ public class AstBuilder extends AbstractAstBuilder<Object> {
           }
           var message =
               scope.isPropertyScope() ? "invalidModuleTypeInProperty" : "invalidModuleTypeInMethod";
-          errorMessage = ErrorMessages.create(message, scope.getQualifiedName());
+          throw exceptionBuilder()
-          break;
+              .withSourceSection(sourceSection)
+              .evalError(message, scope.getQualifiedName())
+              .build();
         }
       }
     }
-    assert errorMessage != null;
+
-    // TODO: when making this an error, update comment on moduleClass in ReferenceTypeNode.eval
+    // we should always throw a real exception before we get here!
-    VmContext.get(null)
+    throw PklBugException.unreachableCode();
-        .getLogger()
-        .warn(
-            errorMessage + " This will be an error in a future release.",
-            VmUtils.createStackFrame(sourceSection, null));
   }
 
   @Override

pkl-core/src/test/files/LanguageSnippetTests/input-helper/types/typeAliasModule.pkl

@@ -1 +0,0 @@
-typealias MyModule = module

pkl-core/src/test/files/LanguageSnippetTests/input/types/currentModuleType1.pkl

@@ -18,26 +18,8 @@ res6a: module = res6[0]
 
 function fun(m: module): List<module> = List((m) { x = 2 })
 
-class Bad {
-  res7: module = "abc"
-
-  res8: module = new Person {}
-
-  res9: module? = new Person {}
-
-  res10: List<module> = List(new Person {})
-}
-
 class Person
 
-res7 = test.catch(() -> new Bad {}.res7)
-
-res8 = test.catch(() -> new Bad {}.res8)
-
-res9 = test.catch(() -> new Bad {}.res9)
-
-res10 = test.catch(() -> new Bad {}.res10)
-
 output {
   // force eval but don't render to prevent recursion
   value =
@@ -48,9 +30,5 @@ output {
     let (r5 = res5)
     let (r6 = res6)
     let (r6a = res6a)
-    let (r7 = res7)
-    let (r8 = res8)
-    let (r9 = res9)
-    let (r10 = res10)
       new Dynamic { result = "ok" }
 }

pkl-core/src/test/files/LanguageSnippetTests/input/types/currentModuleType2.pkl

@@ -20,26 +20,8 @@ res6a: module = res6[0]
 
 function fun(m: module): List<module> = List((m) { x = 2 })
 
-class Bad {
-  res7: module = "abc"
-
-  res8: module = new Person {}
-
-  res9: module? = new Person {}
-
-  res10: List<module> = List(new Person {})
-}
-
 class Person
 
-res7 = test.catch(() -> new Bad {}.res7)
-
-res8 = test.catch(() -> new Bad {}.res8)
-
-res9 = test.catch(() -> new Bad {}.res9)
-
-res10 = test.catch(() -> new Bad {}.res10)
-
 output {
   // force eval but don't render to prevent recursion
   value =
@@ -50,9 +32,5 @@ output {
     let (r5 = res5)
     let (r6 = res6)
     let (r6a = res6a)
-    let (r7 = res7)
-    let (r8 = res8)
-    let (r9 = res9)
-    let (r10 = res10)
       new Dynamic { result = "ok" }
 }

pkl-core/src/test/files/LanguageSnippetTests/input/types/currentModuleType4.pkl

@@ -1,21 +0,0 @@
-typealias Foo = module
-
-@Baz { valid = true is module }
-class Bar {
-  baz: module
-}
-
-class Baz extends Annotation {
-  valid: Boolean
-}
-
-const qux = true is module
-const function quux() = true is module
-
-const corge = new {
-  grault {
-    garply = true is module
-  }
-}
-
-hidden const waldo = (x: module) -> true

pkl-core/src/test/files/LanguageSnippetTests/input/types/currentModuleType4a.pkl

@@ -0,0 +1 @@
+typealias Foo = module

pkl-core/src/test/files/LanguageSnippetTests/input/types/currentModuleType4b.pkl

@@ -0,0 +1,6 @@
+@Baz { valid = true is module }
+class Bar
+
+class Baz extends Annotation {
+  valid: Boolean
+}

pkl-core/src/test/files/LanguageSnippetTests/input/types/currentModuleType4c.pkl

@@ -0,0 +1,3 @@
+class Bar {
+  baz: module
+}

pkl-core/src/test/files/LanguageSnippetTests/input/types/currentModuleType4d.pkl

@@ -0,0 +1 @@
+const qux = true is module

pkl-core/src/test/files/LanguageSnippetTests/input/types/currentModuleType4e.pkl

@@ -0,0 +1 @@
+const function quux() = true is module

pkl-core/src/test/files/LanguageSnippetTests/input/types/currentModuleType4f.pkl

@@ -0,0 +1,5 @@
+const corge = new {
+  grault {
+    garply = true is module
+  }
+}

pkl-core/src/test/files/LanguageSnippetTests/input/types/currentModuleType4g.pkl

@@ -0,0 +1 @@
+hidden const waldo = (x: module) -> true

pkl-core/src/test/files/LanguageSnippetTests/input/types/currentModuleType6.pkl

@@ -4,8 +4,6 @@ import ".../input-helper/types/moduleTypeProperty.pkl"
 
 class ModuleSubclass extends moduleTypeProperty {
   x = 2
-  hidden mod2: module
-  mod2x = mod2.x
 }
 
 x = -1

pkl-core/src/test/files/LanguageSnippetTests/input/types/typeAlias6.pkl

@@ -1,3 +0,0 @@
-import "../../input-helper/types/typeAliasModule.pkl"
-
-res: typeAliasModule = module

pkl-core/src/test/files/LanguageSnippetTests/output/types/currentModuleType1.err

@@ -1,5 +0,0 @@
-result = "ok"
-pkl: WARN: Cannot reference `module` type within a class body. This will be an error in a future release. (file:///$snippetsDir/input/types/currentModuleType1.pkl)
-pkl: WARN: Cannot reference `module` type within a class body. This will be an error in a future release. (file:///$snippetsDir/input/types/currentModuleType1.pkl)
-pkl: WARN: Cannot reference `module` type within a class body. This will be an error in a future release. (file:///$snippetsDir/input/types/currentModuleType1.pkl)
-pkl: WARN: Cannot reference `module` type within a class body. This will be an error in a future release. (file:///$snippetsDir/input/types/currentModuleType1.pkl)

pkl-core/src/test/files/LanguageSnippetTests/output/types/currentModuleType1.pcf

@@ -0,0 +1 @@
+result = "ok"

pkl-core/src/test/files/LanguageSnippetTests/output/types/currentModuleType2.err

@@ -1,5 +0,0 @@
-result = "ok"
-pkl: WARN: Cannot reference `module` type within a class body. This will be an error in a future release. (file:///$snippetsDir/input/types/currentModuleType2.pkl)
-pkl: WARN: Cannot reference `module` type within a class body. This will be an error in a future release. (file:///$snippetsDir/input/types/currentModuleType2.pkl)
-pkl: WARN: Cannot reference `module` type within a class body. This will be an error in a future release. (file:///$snippetsDir/input/types/currentModuleType2.pkl)
-pkl: WARN: Cannot reference `module` type within a class body. This will be an error in a future release. (file:///$snippetsDir/input/types/currentModuleType2.pkl)

pkl-core/src/test/files/LanguageSnippetTests/output/types/currentModuleType2.pcf

@@ -0,0 +1 @@
+result = "ok"

pkl-core/src/test/files/LanguageSnippetTests/output/types/currentModuleType3.err

@@ -1,5 +0,0 @@
-result = "ok"
-pkl: WARN: Cannot reference `module` type within a class body. This will be an error in a future release. (file:///$snippetsDir/input/types/currentModuleType2.pkl)
-pkl: WARN: Cannot reference `module` type within a class body. This will be an error in a future release. (file:///$snippetsDir/input/types/currentModuleType2.pkl)
-pkl: WARN: Cannot reference `module` type within a class body. This will be an error in a future release. (file:///$snippetsDir/input/types/currentModuleType2.pkl)
-pkl: WARN: Cannot reference `module` type within a class body. This will be an error in a future release. (file:///$snippetsDir/input/types/currentModuleType2.pkl)

pkl-core/src/test/files/LanguageSnippetTests/output/types/currentModuleType3.pcf

@@ -0,0 +1 @@
+result = "ok"

pkl-core/src/test/files/LanguageSnippetTests/output/types/currentModuleType4.err

@@ -1,13 +0,0 @@
-qux = false
-corge {
-  grault {
-    garply = false
-  }
-}
-pkl: WARN: Cannot reference `module` type within an annotation body. This will be an error in a future release. (file:///$snippetsDir/input/types/currentModuleType4.pkl)
-pkl: WARN: Cannot reference `module` type within a class body. This will be an error in a future release. (file:///$snippetsDir/input/types/currentModuleType4.pkl)
-pkl: WARN: Cannot reference `module` type within a type alias body. This will be an error in a future release. (file:///$snippetsDir/input/types/currentModuleType4.pkl)
-pkl: WARN: Cannot reference `module` type from const property `currentModuleType4#qux`. This will be an error in a future release. (file:///$snippetsDir/input/types/currentModuleType4.pkl)
-pkl: WARN: Cannot reference `module` type from const property `currentModuleType4#corge`. This will be an error in a future release. (file:///$snippetsDir/input/types/currentModuleType4.pkl)
-pkl: WARN: Cannot reference `module` type from const property `currentModuleType4#waldo`. This will be an error in a future release. (file:///$snippetsDir/input/types/currentModuleType4.pkl)
-pkl: WARN: Cannot reference `module` type from const method `currentModuleType4#quux`. This will be an error in a future release. (file:///$snippetsDir/input/types/currentModuleType4.pkl)

pkl-core/src/test/files/LanguageSnippetTests/output/types/currentModuleType4a.err

@@ -0,0 +1,6 @@
+–– Pkl Error ––
+Cannot reference `module` type within a type alias body.
+
+x | typealias Foo = module
+                    ^^^^^^
+at currentModuleType4a#Foo (file:///$snippetsDir/input/types/currentModuleType4a.pkl)

pkl-core/src/test/files/LanguageSnippetTests/output/types/currentModuleType4b.err

@@ -0,0 +1,6 @@
+–– Pkl Error ––
+Cannot reference `module` type within an annotation body.
+
+x | @Baz { valid = true is module }
+                           ^^^^^^
+at currentModuleType4b#Bar.valid (file:///$snippetsDir/input/types/currentModuleType4b.pkl)

pkl-core/src/test/files/LanguageSnippetTests/output/types/currentModuleType4c.err

@@ -0,0 +1,6 @@
+–– Pkl Error ––
+Cannot reference `module` type within a class body.
+
+x | baz: module
+         ^^^^^^
+at currentModuleType4c#Bar.baz (file:///$snippetsDir/input/types/currentModuleType4c.pkl)

pkl-core/src/test/files/LanguageSnippetTests/output/types/currentModuleType4d.err

@@ -0,0 +1,6 @@
+–– Pkl Error ––
+Cannot reference `module` type from const property `currentModuleType4d#qux`.
+
+x | const qux = true is module
+                        ^^^^^^
+at currentModuleType4d#qux (file:///$snippetsDir/input/types/currentModuleType4d.pkl)

pkl-core/src/test/files/LanguageSnippetTests/output/types/currentModuleType4e.err

@@ -0,0 +1,6 @@
+–– Pkl Error ––
+Cannot reference `module` type from const method `currentModuleType4e#quux`.
+
+x | const function quux() = true is module
+                                    ^^^^^^
+at currentModuleType4e#quux (file:///$snippetsDir/input/types/currentModuleType4e.pkl)

pkl-core/src/test/files/LanguageSnippetTests/output/types/currentModuleType4f.err

@@ -0,0 +1,6 @@
+–– Pkl Error ––
+Cannot reference `module` type from const property `currentModuleType4f#corge`.
+
+x | garply = true is module
+                     ^^^^^^
+at currentModuleType4f#corge.grault.garply (file:///$snippetsDir/input/types/currentModuleType4f.pkl)

pkl-core/src/test/files/LanguageSnippetTests/output/types/currentModuleType4g.err

@@ -0,0 +1,6 @@
+–– Pkl Error ––
+Cannot reference `module` type from const property `currentModuleType4g#waldo`.
+
+x | hidden const waldo = (x: module) -> true
+                             ^^^^^^
+at currentModuleType4g#waldo.<function#1> (file:///$snippetsDir/input/types/currentModuleType4g.pkl)

pkl-core/src/test/files/LanguageSnippetTests/output/types/currentModuleType6.pcf

@@ -13,7 +13,5 @@ res3 {
   x = 2
   y = 2
   modName = "currentModuleType6#ModuleSubclass"
-  mod2x = -1
 }
 res4 = "Expected value of type `currentModuleType6#ModuleSubclass`, but got type `moduleTypeProperty`. Value: new moduleTypeProperty { x = ?; y = ?; modName = ? }"
-pkl: WARN: Cannot reference `module` type within a class body. This will be an error in a future release. (file:///$snippetsDir/input/types/currentModuleType6.pkl)

pkl-core/src/test/files/LanguageSnippetTests/output/types/typeAlias6.err

@@ -1,16 +0,0 @@
-pkl: WARN: Cannot reference `module` type within a type alias body. This will be an error in a future release. (file:///$snippetsDir/input-helper/types/typeAliasModule.pkl)
-–– Pkl Error ––
-Expected value of type `typeAliasModule`, but got type `typeAlias6`.
-Value: new typeAlias6 { res = ? }
-
-x | res: typeAliasModule = module
-         ^^^^^^^^^^^^^^^
-at typeAlias6#res (file:///$snippetsDir/input/types/typeAlias6.pkl)
-
-xxx | renderer.renderDocument(value)
-      ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
-at pkl.base#Module.output.text (pkl:base)
-
-xxx | if (renderer is BytesRenderer) renderer.renderDocument(value) else text.encodeToBytes("UTF-8")
-                                                                         ^^^^
-at pkl.base#Module.output.bytes (pkl:base)

pkl-doc/src/test/files/DocGeneratorTest/input/com.package1/moduleTypes2.pkl

@@ -29,9 +29,9 @@ class Foo {
 
   x5: String|moduleTypes1|Int
 
-  x6: module
+  x6: this
 
-  x7: List<module>
+  x7: List<this>
 
-  x8: String|module|Int
+  x8: String|this|Int
 }

pkl-doc/src/test/files/DocGeneratorTest/output/run-1/com.package1/1.2.3/moduleTypes2/Foo.html

@@ -108,7 +108,7 @@
                 <div class="member-modifiers"></div>
               </div>
               <div class="member-main">
-                <div class="member-signature"><span class="name-decl">x6</span>: module<a class="member-source-link" href="https://example.com/package1/moduleTypes2.pkl#L123-L456">Source</a></div>
+                <div class="member-signature"><span class="name-decl">x6</span>: this<a class="member-source-link" href="https://example.com/package1/moduleTypes2.pkl#L123-L456">Source</a></div>
               </div>
             </div>
           </li>
@@ -119,7 +119,7 @@
                 <div class="member-modifiers"></div>
               </div>
               <div class="member-main">
-                <div class="member-signature"><span class="name-decl">x7</span>: <a href="https://pages.github.com/apple/pkl/stdlib/pkl/0.24.0/base/List.html" class="name-ref">List</a>&lt;module&gt;<a class="member-source-link" href="https://example.com/package1/moduleTypes2.pkl#L123-L456">Source</a></div>
+                <div class="member-signature"><span class="name-decl">x7</span>: <a href="https://pages.github.com/apple/pkl/stdlib/pkl/0.24.0/base/List.html" class="name-ref">List</a>&lt;this&gt;<a class="member-source-link" href="https://example.com/package1/moduleTypes2.pkl#L123-L456">Source</a></div>
               </div>
             </div>
           </li>
@@ -130,7 +130,7 @@
                 <div class="member-modifiers"></div>
               </div>
               <div class="member-main">
-                <div class="member-signature"><span class="name-decl">x8</span>: <a href="https://pages.github.com/apple/pkl/stdlib/pkl/0.24.0/base/String.html" class="name-ref">String</a>|module|<a href="https://pages.github.com/apple/pkl/stdlib/pkl/0.24.0/base/Int.html" class="name-ref">Int</a><a class="member-source-link" href="https://example.com/package1/moduleTypes2.pkl#L123-L456">Source</a></div>
+                <div class="member-signature"><span class="name-decl">x8</span>: <a href="https://pages.github.com/apple/pkl/stdlib/pkl/0.24.0/base/String.html" class="name-ref">String</a>|this|<a href="https://pages.github.com/apple/pkl/stdlib/pkl/0.24.0/base/Int.html" class="name-ref">Int</a><a class="member-source-link" href="https://example.com/package1/moduleTypes2.pkl#L123-L456">Source</a></div>
               </div>
             </div>
           </li>

pkl-doc/src/test/files/DocGeneratorTest/output/run-1/com.package1/1.2.3/package-data.json

@@ -1 +1 @@
-{"ref":{"pkg":"com.package1","pkgUri":null,"version":"1.2.3"},"summary":"Docs for Package 1.","deprecation":"com.package1 is deprecated","sourceCode":"https://example.com/package1/","sourceCodeUrlScheme":"https://example.com/package1%{path}#L%{line}-L%{endLine}","dependencies":[{"ref":{"pkg":"com.package2","pkgUri":null,"version":"4.5.6"}},{"ref":{"pkg":"com.externalpackage","pkgUri":null,"version":"7.8.9"}},{"ref":{"pkg":"pkl","pkgUri":null,"version":"0.24.0"}}],"modules":[{"ref":{"pkg":"com.package1","pkgUri":null,"version":"1.2.3","module":"Module Containing Spaces"},"summary":"This is a module that has spaces in its name.","moduleClass":{"ref":{"pkg":"com.package1","pkgUri":null,"version":"1.2.3","module":"Module Containing Spaces","type":"ModuleClass"},"superclasses":[{"pkg":"pkl","pkgUri":null,"version":"0.24.0","module":"base","type":"Module"},{"pkg":"pkl","pkgUri":null,"version":"0.24.0","module":"base","type":"Typed"},{"pkg":"pkl","pkgUri":null,"version":"0.24.0","module":"base","type":"Object"},{"pkg":"pkl","pkgUri":null,"version":"0.24.0","module":"base","type":"Any"}]}},{"ref":{"pkg":"com.package1","pkgUri":null,"version":"1.2.3","module":"baseModule"},"moduleClass":{"ref":{"pkg":"com.package1","pkgUri":null,"version":"1.2.3","module":"baseModule","type":"ModuleClass"},"superclasses":[{"pkg":"pkl","pkgUri":null,"version":"0.24.0","module":"base","type":"Module"},{"pkg":"pkl","pkgUri":null,"version":"0.24.0","module":"base","type":"Typed"},{"pkg":"pkl","pkgUri":null,"version":"0.24.0","module":"base","type":"Object"},{"pkg":"pkl","pkgUri":null,"version":"0.24.0","module":"base","type":"Any"}]},"classes":[{"ref":{"pkg":"com.package1","pkgUri":null,"version":"1.2.3","module":"baseModule","type":"BaseClass"},"superclasses":[{"pkg":"pkl","pkgUri":null,"version":"0.24.0","module":"base","type":"Typed"},{"pkg":"pkl","pkgUri":null,"version":"0.24.0","module":"base","type":"Object"},{"pkg":"pkl","pkgUri":null,"version":"0.24.0","module":"base","type":"Any"}]}]},{"ref":{"pkg":"com.package1","pkgUri":null,"version":"1.2.3","module":"classAnnotations"},"moduleClass":{"ref":{"pkg":"com.package1","pkgUri":null,"version":"1.2.3","module":"classAnnotations","type":"ModuleClass"},"superclasses":[{"pkg":"pkl","pkgUri":null,"version":"0.24.0","module":"base","type":"Module"},{"pkg":"pkl","pkgUri":null,"version":"0.24.0","module":"base","type":"Typed"},{"pkg":"pkl","pkgUri":null,"version":"0.24.0","module":"base","type":"Object"},{"pkg":"pkl","pkgUri":null,"version":"0.24.0","module":"base","type":"Any"}]},"classes":[{"ref":{"pkg":"com.package1","pkgUri":null,"version":"1.2.3","module":"classAnnotations","type":"AnnotatedClss"},"superclasses":[{"pkg":"pkl","pkgUri":null,"version":"0.24.0","module":"base","type":"Typed"},{"pkg":"pkl","pkgUri":null,"version":"0.24.0","module":"base","type":"Object"},{"pkg":"pkl","pkgUri":null,"version":"0.24.0","module":"base","type":"Any"}]},{"ref":{"pkg":"com.package1","pkgUri":null,"version":"1.2.3","module":"classAnnotations","type":"AnnotatedClssWithExpandableComment"},"superclasses":[{"pkg":"pkl","pkgUri":null,"version":"0.24.0","module":"base","type":"Typed"},{"pkg":"pkl","pkgUri":null,"version":"0.24.0","module":"base","type":"Object"},{"pkg":"pkl","pkgUri":null,"version":"0.24.0","module":"base","type":"Any"}]},{"ref":{"pkg":"com.package1","pkgUri":null,"version":"1.2.3","module":"classAnnotations","type":"AnnotatedClass"},"superclasses":[{"pkg":"pkl","pkgUri":null,"version":"0.24.0","module":"base","type":"Typed"},{"pkg":"pkl","pkgUri":null,"version":"0.24.0","module":"base","type":"Object"},{"pkg":"pkl","pkgUri":null,"version":"0.24.0","module":"base","type":"Any"}]}]},{"ref":{"pkg":"com.package1","pkgUri":null,"version":"1.2.3","module":"classComments"},"summary":"The greatest breakthrough since ever.","moduleClass":{"ref":{"pkg":"com.package1","pkgUri":null,"version":"1.2.3","module":"classComments","type":"ModuleClass"},"superclasses":[{"pkg":"pkl","pkgUri":null,"version":"0.24.0","module":"base","type":"Module"},{"pkg":"pkl","pkgUri":null,"version":"0.24.0","module":"base","type":"Typed"},{"pkg":"pkl","pkgUri":null,"version":"0.24.0","module":"base","type":"Object"},{"pkg":"pkl","pkgUri":null,"version":"0.24.0","module":"base","type":"Any"}]},"classes":[{"ref":{"pkg":"com.package1","pkgUri":null,"version":"1.2.3","module":"classComments","type":"Comments1"},"superclasses":[{"pkg":"pkl","pkgUri":null,"version":"0.24.0","module":"base","type":"Typed"},{"pkg":"pkl","pkgUri":null,"version":"0.24.0","module":"base","type":"Object"},{"pkg":"pkl","pkgUri":null,"version":"0.24.0","module":"base","type":"Any"}]},{"ref":{"pkg":"com.package1","pkgUri":null,"version":"1.2.3","module":"classComments","type":"Comments2"},"superclasses":[{"pkg":"pkl","pkgUri":null,"version":"0.24.0","module":"base","type":"Typed"},{"pkg":"pkl","pkgUri":null,"version":"0.24.0","module":"base","type":"Object"},{"pkg":"pkl","pkgUri":null,"version":"0.24.0","module":"base","type":"Any"}]},{"ref":{"pkg":Line truncated
+{"ref":{"pkg":"com.package1","pkgUri":null,"version":"1.2.3"},"summary":"Docs for Package 1.","deprecation":"com.package1 is deprecated","sourceCode":"https://example.com/package1/","sourceCodeUrlScheme":"https://example.com/package1%{path}#L%{line}-L%{endLine}","dependencies":[{"ref":{"pkg":"com.package2","pkgUri":null,"version":"4.5.6"}},{"ref":{"pkg":"com.externalpackage","pkgUri":null,"version":"7.8.9"}},{"ref":{"pkg":"pkl","pkgUri":null,"version":"0.24.0"}}],"modules":[{"ref":{"pkg":"com.package1","pkgUri":null,"version":"1.2.3","module":"Module Containing Spaces"},"summary":"This is a module that has spaces in its name.","moduleClass":{"ref":{"pkg":"com.package1","pkgUri":null,"version":"1.2.3","module":"Module Containing Spaces","type":"ModuleClass"},"superclasses":[{"pkg":"pkl","pkgUri":null,"version":"0.24.0","module":"base","type":"Module"},{"pkg":"pkl","pkgUri":null,"version":"0.24.0","module":"base","type":"Typed"},{"pkg":"pkl","pkgUri":null,"version":"0.24.0","module":"base","type":"Object"},{"pkg":"pkl","pkgUri":null,"version":"0.24.0","module":"base","type":"Any"}]}},{"ref":{"pkg":"com.package1","pkgUri":null,"version":"1.2.3","module":"baseModule"},"moduleClass":{"ref":{"pkg":"com.package1","pkgUri":null,"version":"1.2.3","module":"baseModule","type":"ModuleClass"},"superclasses":[{"pkg":"pkl","pkgUri":null,"version":"0.24.0","module":"base","type":"Module"},{"pkg":"pkl","pkgUri":null,"version":"0.24.0","module":"base","type":"Typed"},{"pkg":"pkl","pkgUri":null,"version":"0.24.0","module":"base","type":"Object"},{"pkg":"pkl","pkgUri":null,"version":"0.24.0","module":"base","type":"Any"}]},"classes":[{"ref":{"pkg":"com.package1","pkgUri":null,"version":"1.2.3","module":"baseModule","type":"BaseClass"},"superclasses":[{"pkg":"pkl","pkgUri":null,"version":"0.24.0","module":"base","type":"Typed"},{"pkg":"pkl","pkgUri":null,"version":"0.24.0","module":"base","type":"Object"},{"pkg":"pkl","pkgUri":null,"version":"0.24.0","module":"base","type":"Any"}]}]},{"ref":{"pkg":"com.package1","pkgUri":null,"version":"1.2.3","module":"classAnnotations"},"moduleClass":{"ref":{"pkg":"com.package1","pkgUri":null,"version":"1.2.3","module":"classAnnotations","type":"ModuleClass"},"superclasses":[{"pkg":"pkl","pkgUri":null,"version":"0.24.0","module":"base","type":"Module"},{"pkg":"pkl","pkgUri":null,"version":"0.24.0","module":"base","type":"Typed"},{"pkg":"pkl","pkgUri":null,"version":"0.24.0","module":"base","type":"Object"},{"pkg":"pkl","pkgUri":null,"version":"0.24.0","module":"base","type":"Any"}]},"classes":[{"ref":{"pkg":"com.package1","pkgUri":null,"version":"1.2.3","module":"classAnnotations","type":"AnnotatedClss"},"superclasses":[{"pkg":"pkl","pkgUri":null,"version":"0.24.0","module":"base","type":"Typed"},{"pkg":"pkl","pkgUri":null,"version":"0.24.0","module":"base","type":"Object"},{"pkg":"pkl","pkgUri":null,"version":"0.24.0","module":"base","type":"Any"}]},{"ref":{"pkg":"com.package1","pkgUri":null,"version":"1.2.3","module":"classAnnotations","type":"AnnotatedClssWithExpandableComment"},"superclasses":[{"pkg":"pkl","pkgUri":null,"version":"0.24.0","module":"base","type":"Typed"},{"pkg":"pkl","pkgUri":null,"version":"0.24.0","module":"base","type":"Object"},{"pkg":"pkl","pkgUri":null,"version":"0.24.0","module":"base","type":"Any"}]},{"ref":{"pkg":"com.package1","pkgUri":null,"version":"1.2.3","module":"classAnnotations","type":"AnnotatedClass"},"superclasses":[{"pkg":"pkl","pkgUri":null,"version":"0.24.0","module":"base","type":"Typed"},{"pkg":"pkl","pkgUri":null,"version":"0.24.0","module":"base","type":"Object"},{"pkg":"pkl","pkgUri":null,"version":"0.24.0","module":"base","type":"Any"}]}]},{"ref":{"pkg":"com.package1","pkgUri":null,"version":"1.2.3","module":"classComments"},"summary":"The greatest breakthrough since ever.","moduleClass":{"ref":{"pkg":"com.package1","pkgUri":null,"version":"1.2.3","module":"classComments","type":"ModuleClass"},"superclasses":[{"pkg":"pkl","pkgUri":null,"version":"0.24.0","module":"base","type":"Module"},{"pkg":"pkl","pkgUri":null,"version":"0.24.0","module":"base","type":"Typed"},{"pkg":"pkl","pkgUri":null,"version":"0.24.0","module":"base","type":"Object"},{"pkg":"pkl","pkgUri":null,"version":"0.24.0","module":"base","type":"Any"}]},"classes":[{"ref":{"pkg":"com.package1","pkgUri":null,"version":"1.2.3","module":"classComments","type":"Comments1"},"superclasses":[{"pkg":"pkl","pkgUri":null,"version":"0.24.0","module":"base","type":"Typed"},{"pkg":"pkl","pkgUri":null,"version":"0.24.0","module":"base","type":"Object"},{"pkg":"pkl","pkgUri":null,"version":"0.24.0","module":"base","type":"Any"}]},{"ref":{"pkg":"com.package1","pkgUri":null,"version":"1.2.3","module":"classComments","type":"Comments2"},"superclasses":[{"pkg":"pkl","pkgUri":null,"version":"0.24.0","module":"base","type":"Typed"},{"pkg":"pkl","pkgUri":null,"version":"0.24.0","module":"base","type":"Object"},{"pkg":"pkl","pkgUri":null,"version":"0.24.0","module":"base","type":"Any"}]},{"ref":{"pkg":Line truncated

pkl-doc/src/test/files/DocGeneratorTest/output/run-1/com.package1/1.2.3/search-index.js

@@ -1 +1 @@
-searchData='[{"name":"com.package1.Module Containing Spaces","kind":1,"url":"Module Containing Spaces/index.html"},{"name":"com.package1.baseModule","kind":1,"url":"baseModule/index.html"},{"name":"baseProperty","kind":5,"url":"baseModule/index.html#baseProperty","sig":": unknown","parId":1},{"name":"baseMethod","kind":4,"url":"baseModule/index.html#baseMethod()","sig":"(): unknown","parId":1},{"name":"BaseClass","kind":3,"url":"baseModule/BaseClass.html","parId":1},{"name":"com.package1.classAnnotations","kind":1,"url":"classAnnotations/index.html"},{"name":"AnnotatedClss","kind":3,"url":"classAnnotations/AnnotatedClss.html","parId":5,"deprecated":true,"aka":["OtherName"]},{"name":"AnnotatedClssWithExpandableComment","kind":3,"url":"classAnnotations/AnnotatedClssWithExpandableComment.html","parId":5,"deprecated":true,"aka":["OtherName"]},{"name":"AnnotatedClass","kind":3,"url":"classAnnotations/AnnotatedClass.html","parId":5,"deprecated":true,"aka":["OtherName"]},{"name":"com.package1.classComments","kind":1,"url":"classComments/index.html"},{"name":"Comments1","kind":3,"url":"classComments/Comments1.html","parId":9},{"name":"Comments2","kind":3,"url":"classComments/Comments2.html","parId":9},{"name":"Comments3","kind":3,"url":"classComments/Comments3.html","parId":9},{"name":"Comments4","kind":3,"url":"classComments/Comments4.html","parId":9},{"name":"Comments5","kind":3,"url":"classComments/Comments5.html","parId":9},{"name":"Comments6","kind":3,"url":"classComments/Comments6.html","parId":9},{"name":"Comments7","kind":3,"url":"classComments/Comments7.html","parId":9},{"name":"Comments8","kind":3,"url":"classComments/Comments8.html","parId":9},{"name":"com.package1.classInheritance","kind":1,"url":"classInheritance/index.html"},{"name":"MyClass1","kind":3,"url":"classInheritance/MyClass1.html","parId":18},{"name":"property1","kind":5,"url":"classInheritance/MyClass1.html#property1","sig":": Boolean","parId":19},{"name":"method1","kind":4,"url":"classInheritance/MyClass1.html#method1()","sig":"(arg): Boolean","parId":19},{"name":"MyClass2","kind":3,"url":"classInheritance/MyClass2.html","parId":18},{"name":"property1","kind":5,"url":"classInheritance/MyClass2.html#property1","sig":": Boolean","parId":22},{"name":"property2","kind":5,"url":"classInheritance/MyClass2.html#property2","sig":": String","parId":22},{"name":"method1","kind":4,"url":"classInheritance/MyClass2.html#method1()","sig":"(arg): Boolean","parId":22},{"name":"method2","kind":4,"url":"classInheritance/MyClass2.html#method2()","sig":"(arg): Boolean","parId":22},{"name":"MyClass3","kind":3,"url":"classInheritance/MyClass3.html","parId":18},{"name":"property1","kind":5,"url":"classInheritance/MyClass3.html#property1","sig":": Boolean","parId":27},{"name":"method1","kind":4,"url":"classInheritance/MyClass3.html#method1()","sig":"(arg): Boolean","parId":27},{"name":"MyClass4","kind":3,"url":"classInheritance/MyClass4.html","parId":18},{"name":"property4","kind":5,"url":"classInheritance/MyClass4.html#property4","sig":": String","parId":30},{"name":"method3","kind":4,"url":"classInheritance/MyClass4.html#method3()","sig":"(arg): Boolean","parId":30},{"name":"com.package1.classMethodComments","kind":1,"url":"classMethodComments/index.html"},{"name":"Comments","kind":3,"url":"classMethodComments/Comments.html","parId":33},{"name":"method1","kind":4,"url":"classMethodComments/Comments.html#method1()","sig":"(): Float","parId":34},{"name":"method2","kind":4,"url":"classMethodComments/Comments.html#method2()","sig":"(): Float","parId":34},{"name":"method3","kind":4,"url":"classMethodComments/Comments.html#method3()","sig":"(): Float","parId":34},{"name":"method4","kind":4,"url":"classMethodComments/Comments.html#method4()","sig":"(): Float","parId":34},{"name":"method5","kind":4,"url":"classMethodComments/Comments.html#method5()","sig":"(): Float","parId":34},{"name":"method6","kind":4,"url":"classMethodComments/Comments.html#method6()","sig":"(): Float","parId":34},{"name":"method7","kind":4,"url":"classMethodComments/Comments.html#method7()","sig":"(): Float","parId":34},{"name":"com.package1.classMethodModifiers","kind":1,"url":"classMethodModifiers/index.html"},{"name":"Modifiers","kind":3,"url":"classMethodModifiers/Modifiers.html","parId":42},{"name":"method1","kind":4,"url":"classMethodModifiers/Modifiers.html#method1()","sig":"(arg): Boolean","parId":43},{"name":"com.package1.classMethodTypeAnnotations","kind":1,"url":"classMethodTypeAnnotations/index.html"},{"name":"TypeAnnotations","kind":3,"url":"classMethodTypeAnnotations/TypeAnnotations.html","parId":45},{"name":"method1","kind":4,"url":"classMethodTypeAnnotations/TypeAnnotations.html#method1()","sig":"(): unknown","parId":46},{"name":"method2","kind":4,"url":"classMethodTypeAnnotations/TypeAnnotations.html#method2()","sig":"(arg1): unknown","parId":46},{"name":"method3","kind":4,"url":"classMethodTypeAnnotations/TypeAnnotations.html#method3()","sig":"(arg1, arg2): unknown","parId":46}Line truncated
+searchData='[{"name":"com.package1.Module Containing Spaces","kind":1,"url":"Module Containing Spaces/index.html"},{"name":"com.package1.baseModule","kind":1,"url":"baseModule/index.html"},{"name":"baseProperty","kind":5,"url":"baseModule/index.html#baseProperty","sig":": unknown","parId":1},{"name":"baseMethod","kind":4,"url":"baseModule/index.html#baseMethod()","sig":"(): unknown","parId":1},{"name":"BaseClass","kind":3,"url":"baseModule/BaseClass.html","parId":1},{"name":"com.package1.classAnnotations","kind":1,"url":"classAnnotations/index.html"},{"name":"AnnotatedClss","kind":3,"url":"classAnnotations/AnnotatedClss.html","parId":5,"deprecated":true,"aka":["OtherName"]},{"name":"AnnotatedClssWithExpandableComment","kind":3,"url":"classAnnotations/AnnotatedClssWithExpandableComment.html","parId":5,"deprecated":true,"aka":["OtherName"]},{"name":"AnnotatedClass","kind":3,"url":"classAnnotations/AnnotatedClass.html","parId":5,"deprecated":true,"aka":["OtherName"]},{"name":"com.package1.classComments","kind":1,"url":"classComments/index.html"},{"name":"Comments1","kind":3,"url":"classComments/Comments1.html","parId":9},{"name":"Comments2","kind":3,"url":"classComments/Comments2.html","parId":9},{"name":"Comments3","kind":3,"url":"classComments/Comments3.html","parId":9},{"name":"Comments4","kind":3,"url":"classComments/Comments4.html","parId":9},{"name":"Comments5","kind":3,"url":"classComments/Comments5.html","parId":9},{"name":"Comments6","kind":3,"url":"classComments/Comments6.html","parId":9},{"name":"Comments7","kind":3,"url":"classComments/Comments7.html","parId":9},{"name":"Comments8","kind":3,"url":"classComments/Comments8.html","parId":9},{"name":"com.package1.classInheritance","kind":1,"url":"classInheritance/index.html"},{"name":"MyClass1","kind":3,"url":"classInheritance/MyClass1.html","parId":18},{"name":"property1","kind":5,"url":"classInheritance/MyClass1.html#property1","sig":": Boolean","parId":19},{"name":"method1","kind":4,"url":"classInheritance/MyClass1.html#method1()","sig":"(arg): Boolean","parId":19},{"name":"MyClass2","kind":3,"url":"classInheritance/MyClass2.html","parId":18},{"name":"property1","kind":5,"url":"classInheritance/MyClass2.html#property1","sig":": Boolean","parId":22},{"name":"property2","kind":5,"url":"classInheritance/MyClass2.html#property2","sig":": String","parId":22},{"name":"method1","kind":4,"url":"classInheritance/MyClass2.html#method1()","sig":"(arg): Boolean","parId":22},{"name":"method2","kind":4,"url":"classInheritance/MyClass2.html#method2()","sig":"(arg): Boolean","parId":22},{"name":"MyClass3","kind":3,"url":"classInheritance/MyClass3.html","parId":18},{"name":"property1","kind":5,"url":"classInheritance/MyClass3.html#property1","sig":": Boolean","parId":27},{"name":"method1","kind":4,"url":"classInheritance/MyClass3.html#method1()","sig":"(arg): Boolean","parId":27},{"name":"MyClass4","kind":3,"url":"classInheritance/MyClass4.html","parId":18},{"name":"property4","kind":5,"url":"classInheritance/MyClass4.html#property4","sig":": String","parId":30},{"name":"method3","kind":4,"url":"classInheritance/MyClass4.html#method3()","sig":"(arg): Boolean","parId":30},{"name":"com.package1.classMethodComments","kind":1,"url":"classMethodComments/index.html"},{"name":"Comments","kind":3,"url":"classMethodComments/Comments.html","parId":33},{"name":"method1","kind":4,"url":"classMethodComments/Comments.html#method1()","sig":"(): Float","parId":34},{"name":"method2","kind":4,"url":"classMethodComments/Comments.html#method2()","sig":"(): Float","parId":34},{"name":"method3","kind":4,"url":"classMethodComments/Comments.html#method3()","sig":"(): Float","parId":34},{"name":"method4","kind":4,"url":"classMethodComments/Comments.html#method4()","sig":"(): Float","parId":34},{"name":"method5","kind":4,"url":"classMethodComments/Comments.html#method5()","sig":"(): Float","parId":34},{"name":"method6","kind":4,"url":"classMethodComments/Comments.html#method6()","sig":"(): Float","parId":34},{"name":"method7","kind":4,"url":"classMethodComments/Comments.html#method7()","sig":"(): Float","parId":34},{"name":"com.package1.classMethodModifiers","kind":1,"url":"classMethodModifiers/index.html"},{"name":"Modifiers","kind":3,"url":"classMethodModifiers/Modifiers.html","parId":42},{"name":"method1","kind":4,"url":"classMethodModifiers/Modifiers.html#method1()","sig":"(arg): Boolean","parId":43},{"name":"com.package1.classMethodTypeAnnotations","kind":1,"url":"classMethodTypeAnnotations/index.html"},{"name":"TypeAnnotations","kind":3,"url":"classMethodTypeAnnotations/TypeAnnotations.html","parId":45},{"name":"method1","kind":4,"url":"classMethodTypeAnnotations/TypeAnnotations.html#method1()","sig":"(): unknown","parId":46},{"name":"method2","kind":4,"url":"classMethodTypeAnnotations/TypeAnnotations.html#method2()","sig":"(arg1): unknown","parId":46},{"name":"method3","kind":4,"url":"classMethodTypeAnnotations/TypeAnnotations.html#method3()","sig":"(arg1, arg2): unknown","parId":46}Line truncated

pkl-doc/src/test/files/DocGeneratorTest/output/run-1/data/com.package1/1.2.3/moduleTypes2/index.json

@@ -1,8 +1 @@
-{
+{}
-  "knownUsages": [
-    {
-      "text": "Foo",
-      "href": "Foo.html"
-    }
-  ]
-}

pkl-doc/src/test/files/DocGeneratorTest/output/run-2/com.package1/1.2.3/moduleTypes2/Foo.html

@@ -108,7 +108,7 @@
                 <div class="member-modifiers"></div>
               </div>
               <div class="member-main">
-                <div class="member-signature"><span class="name-decl">x6</span>: module<a class="member-source-link" href="https://example.com/package1/moduleTypes2.pkl#L123-L456">Source</a></div>
+                <div class="member-signature"><span class="name-decl">x6</span>: this<a class="member-source-link" href="https://example.com/package1/moduleTypes2.pkl#L123-L456">Source</a></div>
               </div>
             </div>
           </li>
@@ -119,7 +119,7 @@
                 <div class="member-modifiers"></div>
               </div>
               <div class="member-main">
-                <div class="member-signature"><span class="name-decl">x7</span>: <a href="https://pages.github.com/apple/pkl/stdlib/pkl/0.24.0/base/List.html" class="name-ref">List</a>&lt;module&gt;<a class="member-source-link" href="https://example.com/package1/moduleTypes2.pkl#L123-L456">Source</a></div>
+                <div class="member-signature"><span class="name-decl">x7</span>: <a href="https://pages.github.com/apple/pkl/stdlib/pkl/0.24.0/base/List.html" class="name-ref">List</a>&lt;this&gt;<a class="member-source-link" href="https://example.com/package1/moduleTypes2.pkl#L123-L456">Source</a></div>
               </div>
             </div>
           </li>
@@ -130,7 +130,7 @@
                 <div class="member-modifiers"></div>
               </div>
               <div class="member-main">
-                <div class="member-signature"><span class="name-decl">x8</span>: <a href="https://pages.github.com/apple/pkl/stdlib/pkl/0.24.0/base/String.html" class="name-ref">String</a>|module|<a href="https://pages.github.com/apple/pkl/stdlib/pkl/0.24.0/base/Int.html" class="name-ref">Int</a><a class="member-source-link" href="https://example.com/package1/moduleTypes2.pkl#L123-L456">Source</a></div>
+                <div class="member-signature"><span class="name-decl">x8</span>: <a href="https://pages.github.com/apple/pkl/stdlib/pkl/0.24.0/base/String.html" class="name-ref">String</a>|this|<a href="https://pages.github.com/apple/pkl/stdlib/pkl/0.24.0/base/Int.html" class="name-ref">Int</a><a class="member-source-link" href="https://example.com/package1/moduleTypes2.pkl#L123-L456">Source</a></div>
               </div>
             </div>
           </li>

pkl-doc/src/test/files/DocGeneratorTest/output/run-2/com.package1/1.2.3/package-data.json

@@ -1 +1 @@
-{"ref":{"pkg":"com.package1","pkgUri":null,"version":"1.2.3"},"summary":"Docs for Package 1.","deprecation":"com.package1 is deprecated","sourceCode":"https://example.com/package1/","sourceCodeUrlScheme":"https://example.com/package1%{path}#L%{line}-L%{endLine}","dependencies":[{"ref":{"pkg":"com.package2","pkgUri":null,"version":"4.5.6"}},{"ref":{"pkg":"com.externalpackage","pkgUri":null,"version":"7.8.9"}},{"ref":{"pkg":"pkl","pkgUri":null,"version":"0.24.0"}}],"modules":[{"ref":{"pkg":"com.package1","pkgUri":null,"version":"1.2.3","module":"Module Containing Spaces"},"summary":"This is a module that has spaces in its name.","moduleClass":{"ref":{"pkg":"com.package1","pkgUri":null,"version":"1.2.3","module":"Module Containing Spaces","type":"ModuleClass"},"superclasses":[{"pkg":"pkl","pkgUri":null,"version":"0.24.0","module":"base","type":"Module"},{"pkg":"pkl","pkgUri":null,"version":"0.24.0","module":"base","type":"Typed"},{"pkg":"pkl","pkgUri":null,"version":"0.24.0","module":"base","type":"Object"},{"pkg":"pkl","pkgUri":null,"version":"0.24.0","module":"base","type":"Any"}]}},{"ref":{"pkg":"com.package1","pkgUri":null,"version":"1.2.3","module":"baseModule"},"moduleClass":{"ref":{"pkg":"com.package1","pkgUri":null,"version":"1.2.3","module":"baseModule","type":"ModuleClass"},"superclasses":[{"pkg":"pkl","pkgUri":null,"version":"0.24.0","module":"base","type":"Module"},{"pkg":"pkl","pkgUri":null,"version":"0.24.0","module":"base","type":"Typed"},{"pkg":"pkl","pkgUri":null,"version":"0.24.0","module":"base","type":"Object"},{"pkg":"pkl","pkgUri":null,"version":"0.24.0","module":"base","type":"Any"}]},"classes":[{"ref":{"pkg":"com.package1","pkgUri":null,"version":"1.2.3","module":"baseModule","type":"BaseClass"},"superclasses":[{"pkg":"pkl","pkgUri":null,"version":"0.24.0","module":"base","type":"Typed"},{"pkg":"pkl","pkgUri":null,"version":"0.24.0","module":"base","type":"Object"},{"pkg":"pkl","pkgUri":null,"version":"0.24.0","module":"base","type":"Any"}]}]},{"ref":{"pkg":"com.package1","pkgUri":null,"version":"1.2.3","module":"classAnnotations"},"moduleClass":{"ref":{"pkg":"com.package1","pkgUri":null,"version":"1.2.3","module":"classAnnotations","type":"ModuleClass"},"superclasses":[{"pkg":"pkl","pkgUri":null,"version":"0.24.0","module":"base","type":"Module"},{"pkg":"pkl","pkgUri":null,"version":"0.24.0","module":"base","type":"Typed"},{"pkg":"pkl","pkgUri":null,"version":"0.24.0","module":"base","type":"Object"},{"pkg":"pkl","pkgUri":null,"version":"0.24.0","module":"base","type":"Any"}]},"classes":[{"ref":{"pkg":"com.package1","pkgUri":null,"version":"1.2.3","module":"classAnnotations","type":"AnnotatedClss"},"superclasses":[{"pkg":"pkl","pkgUri":null,"version":"0.24.0","module":"base","type":"Typed"},{"pkg":"pkl","pkgUri":null,"version":"0.24.0","module":"base","type":"Object"},{"pkg":"pkl","pkgUri":null,"version":"0.24.0","module":"base","type":"Any"}]},{"ref":{"pkg":"com.package1","pkgUri":null,"version":"1.2.3","module":"classAnnotations","type":"AnnotatedClssWithExpandableComment"},"superclasses":[{"pkg":"pkl","pkgUri":null,"version":"0.24.0","module":"base","type":"Typed"},{"pkg":"pkl","pkgUri":null,"version":"0.24.0","module":"base","type":"Object"},{"pkg":"pkl","pkgUri":null,"version":"0.24.0","module":"base","type":"Any"}]},{"ref":{"pkg":"com.package1","pkgUri":null,"version":"1.2.3","module":"classAnnotations","type":"AnnotatedClass"},"superclasses":[{"pkg":"pkl","pkgUri":null,"version":"0.24.0","module":"base","type":"Typed"},{"pkg":"pkl","pkgUri":null,"version":"0.24.0","module":"base","type":"Object"},{"pkg":"pkl","pkgUri":null,"version":"0.24.0","module":"base","type":"Any"}]}]},{"ref":{"pkg":"com.package1","pkgUri":null,"version":"1.2.3","module":"classComments"},"summary":"The greatest breakthrough since ever.","moduleClass":{"ref":{"pkg":"com.package1","pkgUri":null,"version":"1.2.3","module":"classComments","type":"ModuleClass"},"superclasses":[{"pkg":"pkl","pkgUri":null,"version":"0.24.0","module":"base","type":"Module"},{"pkg":"pkl","pkgUri":null,"version":"0.24.0","module":"base","type":"Typed"},{"pkg":"pkl","pkgUri":null,"version":"0.24.0","module":"base","type":"Object"},{"pkg":"pkl","pkgUri":null,"version":"0.24.0","module":"base","type":"Any"}]},"classes":[{"ref":{"pkg":"com.package1","pkgUri":null,"version":"1.2.3","module":"classComments","type":"Comments1"},"superclasses":[{"pkg":"pkl","pkgUri":null,"version":"0.24.0","module":"base","type":"Typed"},{"pkg":"pkl","pkgUri":null,"version":"0.24.0","module":"base","type":"Object"},{"pkg":"pkl","pkgUri":null,"version":"0.24.0","module":"base","type":"Any"}]},{"ref":{"pkg":"com.package1","pkgUri":null,"version":"1.2.3","module":"classComments","type":"Comments2"},"superclasses":[{"pkg":"pkl","pkgUri":null,"version":"0.24.0","module":"base","type":"Typed"},{"pkg":"pkl","pkgUri":null,"version":"0.24.0","module":"base","type":"Object"},{"pkg":"pkl","pkgUri":null,"version":"0.24.0","module":"base","type":"Any"}]},{"ref":{"pkg":Line truncated
+{"ref":{"pkg":"com.package1","pkgUri":null,"version":"1.2.3"},"summary":"Docs for Package 1.","deprecation":"com.package1 is deprecated","sourceCode":"https://example.com/package1/","sourceCodeUrlScheme":"https://example.com/package1%{path}#L%{line}-L%{endLine}","dependencies":[{"ref":{"pkg":"com.package2","pkgUri":null,"version":"4.5.6"}},{"ref":{"pkg":"com.externalpackage","pkgUri":null,"version":"7.8.9"}},{"ref":{"pkg":"pkl","pkgUri":null,"version":"0.24.0"}}],"modules":[{"ref":{"pkg":"com.package1","pkgUri":null,"version":"1.2.3","module":"Module Containing Spaces"},"summary":"This is a module that has spaces in its name.","moduleClass":{"ref":{"pkg":"com.package1","pkgUri":null,"version":"1.2.3","module":"Module Containing Spaces","type":"ModuleClass"},"superclasses":[{"pkg":"pkl","pkgUri":null,"version":"0.24.0","module":"base","type":"Module"},{"pkg":"pkl","pkgUri":null,"version":"0.24.0","module":"base","type":"Typed"},{"pkg":"pkl","pkgUri":null,"version":"0.24.0","module":"base","type":"Object"},{"pkg":"pkl","pkgUri":null,"version":"0.24.0","module":"base","type":"Any"}]}},{"ref":{"pkg":"com.package1","pkgUri":null,"version":"1.2.3","module":"baseModule"},"moduleClass":{"ref":{"pkg":"com.package1","pkgUri":null,"version":"1.2.3","module":"baseModule","type":"ModuleClass"},"superclasses":[{"pkg":"pkl","pkgUri":null,"version":"0.24.0","module":"base","type":"Module"},{"pkg":"pkl","pkgUri":null,"version":"0.24.0","module":"base","type":"Typed"},{"pkg":"pkl","pkgUri":null,"version":"0.24.0","module":"base","type":"Object"},{"pkg":"pkl","pkgUri":null,"version":"0.24.0","module":"base","type":"Any"}]},"classes":[{"ref":{"pkg":"com.package1","pkgUri":null,"version":"1.2.3","module":"baseModule","type":"BaseClass"},"superclasses":[{"pkg":"pkl","pkgUri":null,"version":"0.24.0","module":"base","type":"Typed"},{"pkg":"pkl","pkgUri":null,"version":"0.24.0","module":"base","type":"Object"},{"pkg":"pkl","pkgUri":null,"version":"0.24.0","module":"base","type":"Any"}]}]},{"ref":{"pkg":"com.package1","pkgUri":null,"version":"1.2.3","module":"classAnnotations"},"moduleClass":{"ref":{"pkg":"com.package1","pkgUri":null,"version":"1.2.3","module":"classAnnotations","type":"ModuleClass"},"superclasses":[{"pkg":"pkl","pkgUri":null,"version":"0.24.0","module":"base","type":"Module"},{"pkg":"pkl","pkgUri":null,"version":"0.24.0","module":"base","type":"Typed"},{"pkg":"pkl","pkgUri":null,"version":"0.24.0","module":"base","type":"Object"},{"pkg":"pkl","pkgUri":null,"version":"0.24.0","module":"base","type":"Any"}]},"classes":[{"ref":{"pkg":"com.package1","pkgUri":null,"version":"1.2.3","module":"classAnnotations","type":"AnnotatedClss"},"superclasses":[{"pkg":"pkl","pkgUri":null,"version":"0.24.0","module":"base","type":"Typed"},{"pkg":"pkl","pkgUri":null,"version":"0.24.0","module":"base","type":"Object"},{"pkg":"pkl","pkgUri":null,"version":"0.24.0","module":"base","type":"Any"}]},{"ref":{"pkg":"com.package1","pkgUri":null,"version":"1.2.3","module":"classAnnotations","type":"AnnotatedClssWithExpandableComment"},"superclasses":[{"pkg":"pkl","pkgUri":null,"version":"0.24.0","module":"base","type":"Typed"},{"pkg":"pkl","pkgUri":null,"version":"0.24.0","module":"base","type":"Object"},{"pkg":"pkl","pkgUri":null,"version":"0.24.0","module":"base","type":"Any"}]},{"ref":{"pkg":"com.package1","pkgUri":null,"version":"1.2.3","module":"classAnnotations","type":"AnnotatedClass"},"superclasses":[{"pkg":"pkl","pkgUri":null,"version":"0.24.0","module":"base","type":"Typed"},{"pkg":"pkl","pkgUri":null,"version":"0.24.0","module":"base","type":"Object"},{"pkg":"pkl","pkgUri":null,"version":"0.24.0","module":"base","type":"Any"}]}]},{"ref":{"pkg":"com.package1","pkgUri":null,"version":"1.2.3","module":"classComments"},"summary":"The greatest breakthrough since ever.","moduleClass":{"ref":{"pkg":"com.package1","pkgUri":null,"version":"1.2.3","module":"classComments","type":"ModuleClass"},"superclasses":[{"pkg":"pkl","pkgUri":null,"version":"0.24.0","module":"base","type":"Module"},{"pkg":"pkl","pkgUri":null,"version":"0.24.0","module":"base","type":"Typed"},{"pkg":"pkl","pkgUri":null,"version":"0.24.0","module":"base","type":"Object"},{"pkg":"pkl","pkgUri":null,"version":"0.24.0","module":"base","type":"Any"}]},"classes":[{"ref":{"pkg":"com.package1","pkgUri":null,"version":"1.2.3","module":"classComments","type":"Comments1"},"superclasses":[{"pkg":"pkl","pkgUri":null,"version":"0.24.0","module":"base","type":"Typed"},{"pkg":"pkl","pkgUri":null,"version":"0.24.0","module":"base","type":"Object"},{"pkg":"pkl","pkgUri":null,"version":"0.24.0","module":"base","type":"Any"}]},{"ref":{"pkg":"com.package1","pkgUri":null,"version":"1.2.3","module":"classComments","type":"Comments2"},"superclasses":[{"pkg":"pkl","pkgUri":null,"version":"0.24.0","module":"base","type":"Typed"},{"pkg":"pkl","pkgUri":null,"version":"0.24.0","module":"base","type":"Object"},{"pkg":"pkl","pkgUri":null,"version":"0.24.0","module":"base","type":"Any"}]},{"ref":{"pkg":Line truncated

pkl-doc/src/test/files/DocGeneratorTest/output/run-2/com.package1/1.2.3/search-index.js

@@ -1 +1 @@
-searchData='[{"name":"com.package1.Module Containing Spaces","kind":1,"url":"Module Containing Spaces/index.html"},{"name":"com.package1.baseModule","kind":1,"url":"baseModule/index.html"},{"name":"baseProperty","kind":5,"url":"baseModule/index.html#baseProperty","sig":": unknown","parId":1},{"name":"baseMethod","kind":4,"url":"baseModule/index.html#baseMethod()","sig":"(): unknown","parId":1},{"name":"BaseClass","kind":3,"url":"baseModule/BaseClass.html","parId":1},{"name":"com.package1.classAnnotations","kind":1,"url":"classAnnotations/index.html"},{"name":"AnnotatedClss","kind":3,"url":"classAnnotations/AnnotatedClss.html","parId":5,"deprecated":true,"aka":["OtherName"]},{"name":"AnnotatedClssWithExpandableComment","kind":3,"url":"classAnnotations/AnnotatedClssWithExpandableComment.html","parId":5,"deprecated":true,"aka":["OtherName"]},{"name":"AnnotatedClass","kind":3,"url":"classAnnotations/AnnotatedClass.html","parId":5,"deprecated":true,"aka":["OtherName"]},{"name":"com.package1.classComments","kind":1,"url":"classComments/index.html"},{"name":"Comments1","kind":3,"url":"classComments/Comments1.html","parId":9},{"name":"Comments2","kind":3,"url":"classComments/Comments2.html","parId":9},{"name":"Comments3","kind":3,"url":"classComments/Comments3.html","parId":9},{"name":"Comments4","kind":3,"url":"classComments/Comments4.html","parId":9},{"name":"Comments5","kind":3,"url":"classComments/Comments5.html","parId":9},{"name":"Comments6","kind":3,"url":"classComments/Comments6.html","parId":9},{"name":"Comments7","kind":3,"url":"classComments/Comments7.html","parId":9},{"name":"Comments8","kind":3,"url":"classComments/Comments8.html","parId":9},{"name":"com.package1.classInheritance","kind":1,"url":"classInheritance/index.html"},{"name":"MyClass1","kind":3,"url":"classInheritance/MyClass1.html","parId":18},{"name":"property1","kind":5,"url":"classInheritance/MyClass1.html#property1","sig":": Boolean","parId":19},{"name":"method1","kind":4,"url":"classInheritance/MyClass1.html#method1()","sig":"(arg): Boolean","parId":19},{"name":"MyClass2","kind":3,"url":"classInheritance/MyClass2.html","parId":18},{"name":"property1","kind":5,"url":"classInheritance/MyClass2.html#property1","sig":": Boolean","parId":22},{"name":"property2","kind":5,"url":"classInheritance/MyClass2.html#property2","sig":": String","parId":22},{"name":"method1","kind":4,"url":"classInheritance/MyClass2.html#method1()","sig":"(arg): Boolean","parId":22},{"name":"method2","kind":4,"url":"classInheritance/MyClass2.html#method2()","sig":"(arg): Boolean","parId":22},{"name":"MyClass3","kind":3,"url":"classInheritance/MyClass3.html","parId":18},{"name":"property1","kind":5,"url":"classInheritance/MyClass3.html#property1","sig":": Boolean","parId":27},{"name":"method1","kind":4,"url":"classInheritance/MyClass3.html#method1()","sig":"(arg): Boolean","parId":27},{"name":"MyClass4","kind":3,"url":"classInheritance/MyClass4.html","parId":18},{"name":"property4","kind":5,"url":"classInheritance/MyClass4.html#property4","sig":": String","parId":30},{"name":"method3","kind":4,"url":"classInheritance/MyClass4.html#method3()","sig":"(arg): Boolean","parId":30},{"name":"com.package1.classMethodComments","kind":1,"url":"classMethodComments/index.html"},{"name":"Comments","kind":3,"url":"classMethodComments/Comments.html","parId":33},{"name":"method1","kind":4,"url":"classMethodComments/Comments.html#method1()","sig":"(): Float","parId":34},{"name":"method2","kind":4,"url":"classMethodComments/Comments.html#method2()","sig":"(): Float","parId":34},{"name":"method3","kind":4,"url":"classMethodComments/Comments.html#method3()","sig":"(): Float","parId":34},{"name":"method4","kind":4,"url":"classMethodComments/Comments.html#method4()","sig":"(): Float","parId":34},{"name":"method5","kind":4,"url":"classMethodComments/Comments.html#method5()","sig":"(): Float","parId":34},{"name":"method6","kind":4,"url":"classMethodComments/Comments.html#method6()","sig":"(): Float","parId":34},{"name":"method7","kind":4,"url":"classMethodComments/Comments.html#method7()","sig":"(): Float","parId":34},{"name":"com.package1.classMethodModifiers","kind":1,"url":"classMethodModifiers/index.html"},{"name":"Modifiers","kind":3,"url":"classMethodModifiers/Modifiers.html","parId":42},{"name":"method1","kind":4,"url":"classMethodModifiers/Modifiers.html#method1()","sig":"(arg): Boolean","parId":43},{"name":"com.package1.classMethodTypeAnnotations","kind":1,"url":"classMethodTypeAnnotations/index.html"},{"name":"TypeAnnotations","kind":3,"url":"classMethodTypeAnnotations/TypeAnnotations.html","parId":45},{"name":"method1","kind":4,"url":"classMethodTypeAnnotations/TypeAnnotations.html#method1()","sig":"(): unknown","parId":46},{"name":"method2","kind":4,"url":"classMethodTypeAnnotations/TypeAnnotations.html#method2()","sig":"(arg1): unknown","parId":46},{"name":"method3","kind":4,"url":"classMethodTypeAnnotations/TypeAnnotations.html#method3()","sig":"(arg1, arg2): unknown","parId":46}Line truncated
+searchData='[{"name":"com.package1.Module Containing Spaces","kind":1,"url":"Module Containing Spaces/index.html"},{"name":"com.package1.baseModule","kind":1,"url":"baseModule/index.html"},{"name":"baseProperty","kind":5,"url":"baseModule/index.html#baseProperty","sig":": unknown","parId":1},{"name":"baseMethod","kind":4,"url":"baseModule/index.html#baseMethod()","sig":"(): unknown","parId":1},{"name":"BaseClass","kind":3,"url":"baseModule/BaseClass.html","parId":1},{"name":"com.package1.classAnnotations","kind":1,"url":"classAnnotations/index.html"},{"name":"AnnotatedClss","kind":3,"url":"classAnnotations/AnnotatedClss.html","parId":5,"deprecated":true,"aka":["OtherName"]},{"name":"AnnotatedClssWithExpandableComment","kind":3,"url":"classAnnotations/AnnotatedClssWithExpandableComment.html","parId":5,"deprecated":true,"aka":["OtherName"]},{"name":"AnnotatedClass","kind":3,"url":"classAnnotations/AnnotatedClass.html","parId":5,"deprecated":true,"aka":["OtherName"]},{"name":"com.package1.classComments","kind":1,"url":"classComments/index.html"},{"name":"Comments1","kind":3,"url":"classComments/Comments1.html","parId":9},{"name":"Comments2","kind":3,"url":"classComments/Comments2.html","parId":9},{"name":"Comments3","kind":3,"url":"classComments/Comments3.html","parId":9},{"name":"Comments4","kind":3,"url":"classComments/Comments4.html","parId":9},{"name":"Comments5","kind":3,"url":"classComments/Comments5.html","parId":9},{"name":"Comments6","kind":3,"url":"classComments/Comments6.html","parId":9},{"name":"Comments7","kind":3,"url":"classComments/Comments7.html","parId":9},{"name":"Comments8","kind":3,"url":"classComments/Comments8.html","parId":9},{"name":"com.package1.classInheritance","kind":1,"url":"classInheritance/index.html"},{"name":"MyClass1","kind":3,"url":"classInheritance/MyClass1.html","parId":18},{"name":"property1","kind":5,"url":"classInheritance/MyClass1.html#property1","sig":": Boolean","parId":19},{"name":"method1","kind":4,"url":"classInheritance/MyClass1.html#method1()","sig":"(arg): Boolean","parId":19},{"name":"MyClass2","kind":3,"url":"classInheritance/MyClass2.html","parId":18},{"name":"property1","kind":5,"url":"classInheritance/MyClass2.html#property1","sig":": Boolean","parId":22},{"name":"property2","kind":5,"url":"classInheritance/MyClass2.html#property2","sig":": String","parId":22},{"name":"method1","kind":4,"url":"classInheritance/MyClass2.html#method1()","sig":"(arg): Boolean","parId":22},{"name":"method2","kind":4,"url":"classInheritance/MyClass2.html#method2()","sig":"(arg): Boolean","parId":22},{"name":"MyClass3","kind":3,"url":"classInheritance/MyClass3.html","parId":18},{"name":"property1","kind":5,"url":"classInheritance/MyClass3.html#property1","sig":": Boolean","parId":27},{"name":"method1","kind":4,"url":"classInheritance/MyClass3.html#method1()","sig":"(arg): Boolean","parId":27},{"name":"MyClass4","kind":3,"url":"classInheritance/MyClass4.html","parId":18},{"name":"property4","kind":5,"url":"classInheritance/MyClass4.html#property4","sig":": String","parId":30},{"name":"method3","kind":4,"url":"classInheritance/MyClass4.html#method3()","sig":"(arg): Boolean","parId":30},{"name":"com.package1.classMethodComments","kind":1,"url":"classMethodComments/index.html"},{"name":"Comments","kind":3,"url":"classMethodComments/Comments.html","parId":33},{"name":"method1","kind":4,"url":"classMethodComments/Comments.html#method1()","sig":"(): Float","parId":34},{"name":"method2","kind":4,"url":"classMethodComments/Comments.html#method2()","sig":"(): Float","parId":34},{"name":"method3","kind":4,"url":"classMethodComments/Comments.html#method3()","sig":"(): Float","parId":34},{"name":"method4","kind":4,"url":"classMethodComments/Comments.html#method4()","sig":"(): Float","parId":34},{"name":"method5","kind":4,"url":"classMethodComments/Comments.html#method5()","sig":"(): Float","parId":34},{"name":"method6","kind":4,"url":"classMethodComments/Comments.html#method6()","sig":"(): Float","parId":34},{"name":"method7","kind":4,"url":"classMethodComments/Comments.html#method7()","sig":"(): Float","parId":34},{"name":"com.package1.classMethodModifiers","kind":1,"url":"classMethodModifiers/index.html"},{"name":"Modifiers","kind":3,"url":"classMethodModifiers/Modifiers.html","parId":42},{"name":"method1","kind":4,"url":"classMethodModifiers/Modifiers.html#method1()","sig":"(arg): Boolean","parId":43},{"name":"com.package1.classMethodTypeAnnotations","kind":1,"url":"classMethodTypeAnnotations/index.html"},{"name":"TypeAnnotations","kind":3,"url":"classMethodTypeAnnotations/TypeAnnotations.html","parId":45},{"name":"method1","kind":4,"url":"classMethodTypeAnnotations/TypeAnnotations.html#method1()","sig":"(): unknown","parId":46},{"name":"method2","kind":4,"url":"classMethodTypeAnnotations/TypeAnnotations.html#method2()","sig":"(arg1): unknown","parId":46},{"name":"method3","kind":4,"url":"classMethodTypeAnnotations/TypeAnnotations.html#method3()","sig":"(arg1, arg2): unknown","parId":46}Line truncated

pkl-doc/src/test/files/DocGeneratorTest/output/run-2/data/com.package1/1.2.3/moduleTypes2/index.json

@@ -1,8 +1 @@
-{
+{}
-  "knownUsages": [
-    {
-      "text": "Foo",
-      "href": "Foo.html"
-    }
-  ]
-}