Support comments for top-level variables

src/converter/plugins/convertVariableDeclaration.ts

@@ -3,6 +3,8 @@ import {createSimplePlugin} from "../plugin.js";
 import {CheckCoverageService, checkCoverageServiceKey} from "./CheckCoveragePlugin.js";
 import {TypeScriptService, typeScriptServiceKey} from "./TypeScriptPlugin.js";
 import {NamespaceInfoService, namespaceInfoServiceKey} from "./NamespaceInfoPlugin.js";
+import {CommentService, commentServiceKey} from "./CommentPlugin.js";
+import {ConfigurationService, configurationServiceKey} from "./ConfigurationPlugin.js";
 
 export const convertVariableDeclaration = createSimplePlugin((node, context, render) => {
     if (!ts.isVariableDeclaration(node)) return null
@@ -13,6 +15,8 @@ export const convertVariableDeclaration = createSimplePlugin((node, context, ren
     // skip initializer
     node.initializer && checkCoverageService?.cover(node.initializer)
 
+    const commentService = context.lookupService<CommentService>(commentServiceKey)
+    const configurationService = context.lookupService<ConfigurationService>(configurationServiceKey)
     const typeScriptService = context.lookupService<TypeScriptService>(typeScriptServiceKey)
     const namespaceInfoService = context.lookupService<NamespaceInfoService>(namespaceInfoServiceKey)
 
@@ -30,6 +34,18 @@ export const convertVariableDeclaration = createSimplePlugin((node, context, ren
         externalModifier = ""
     }
 
+    let leadingComment = ""
+
+    if (
+        configurationService?.configuration.granularity === "top-level"
+        && (
+            namespace === undefined
+            || namespaceInfoService?.resolveNamespaceStrategy(namespace) === "package"
+        )
+    ) {
+        leadingComment = commentService?.renderLeadingComments(node.parent) ?? ""
+    }
+
     let type: string
 
     if (node.type) {
@@ -38,5 +54,5 @@ export const convertVariableDeclaration = createSimplePlugin((node, context, ren
         type = "Any? /* should be inferred */" // TODO: infer types
     }
 
-    return `${externalModifier}${modifier}${name}: ${type}`
+    return `${leadingComment}${externalModifier}${modifier}${name}: ${type}`
 })

test/functional/base/generated/variable/simple.kt

@@ -0,0 +1,11 @@
+// Generated by Karakum - do not modify it manually!
+
+@file:JsModule("sandbox-base/variable/simple")
+@file:Suppress(
+    "NON_EXTERNAL_DECLARATION_IN_INAPPROPRIATE_FILE",
+)
+
+package sandbox.base.variable
+
+/** my favorite constant */
+external val myConstWithComment: Double

test/functional/base/lib/variable/simple.d.ts

@@ -0,0 +1,2 @@
+/** my favorite constant */
+const myConstWithComment: number

test/functional/namespace/generated/index.kt

@@ -8,6 +8,8 @@ package sandbox.namespace
 
 external object ObjectNamespace {
 val objectNamespaceValue: Double
+/** my favorite constant */
+val objectNamespaceValueWithComment: Double
 sealed interface objectNamespaceUnion {
 companion object {
 @seskar.js.JsValue("0")
@@ -25,3 +27,5 @@ val innerObjectNamespaceValue: Double
 }
 
 external val topLevelValue: Double
+/** my favorite constant */
+external val topLevelValueWithComment: Double

test/functional/namespace/lib/index.d.ts

@@ -20,6 +20,9 @@ declare module "package-namespace" {
 declare namespace ObjectNamespace {
     const objectNamespaceValue: number
 
+    /** my favorite constant */
+    const objectNamespaceValueWithComment: number
+
     type objectNamespaceUnion = "0" | "1";
 
     interface ObjectNamespaceInterface {
@@ -33,6 +36,9 @@ declare namespace ObjectNamespace {
 
 declare namespace IgnoreNamespace {
     const topLevelValue: number
+
+    /** my favorite constant */
+    const topLevelValueWithComment: number
 }
 
 declare module "will-be-mapped" {

test/functional/top-level/generated/myConstWithComment.kt

@@ -0,0 +1,8 @@
+// Generated by Karakum - do not modify it manually!
+
+@file:JsModule("sandbox-top-level")
+
+package sandbox.top.level
+
+/** my favorite constant */
+external val myConstWithComment: Double

test/functional/top-level/lib/index.d.ts

@@ -2,6 +2,9 @@ const myConst1: string
 
 const myConst2: number
 
+/** my favorite constant */
+const myConstWithComment: number
+
 function myFunction1(firstParam: string, secondParam: number): void
 
 function myFunction1(firstParam: boolean, secondParam: number): void