Merge pull request #820 from drik98/feature/add-optional-typescript-barrels

feat(model-api-gen): allow generating typescript barrels

Author: Oleksandr Dzhychko

docs/global/modules/core/pages/reference/component-model-api-gen-gradle.adoc

@@ -101,6 +101,11 @@ Inside of the `metamodel` block the following settings can be configured.
 |File
 |Target TypeScript directory of the generator
 
+|`includeTypescriptBarrels`
+|Boolean
+|Add barrelling to the generated index file for convenience.
+Only enable when you are completely sure there are no naming conflicts among the concepts of all generated languages.
+
 |`registrationHelperName`
 |String
 |Fully qualified name of the generated language registration helper

model-api-gen-gradle/src/main/kotlin/org/modelix/metamodel/gradle/GenerateMetaModelSources.kt

@@ -39,6 +39,9 @@ abstract class GenerateMetaModelSources @Inject constructor(of: ObjectFactory) :
     @Optional
     val typescriptOutputDir: DirectoryProperty = of.directoryProperty()
 
+    @get:Input
+    val includeTypescriptBarrels: Property<Boolean> = of.property(Boolean::class.java)
+
     @get:Input
     val includedNamespaces: ListProperty<String> = of.listProperty(String::class.java)
 
@@ -114,7 +117,7 @@ abstract class GenerateMetaModelSources @Inject constructor(of: ObjectFactory) :
 
         val typescriptOutputDir = this.typescriptOutputDir.orNull?.asFile
         if (typescriptOutputDir != null) {
-            val tsGenerator = TypescriptMMGenerator(typescriptOutputDir.toPath(), nameConfig.get())
+            val tsGenerator = TypescriptMMGenerator(typescriptOutputDir.toPath(), nameConfig.get(), includeTypescriptBarrels.get())
             tsGenerator.generate(processedLanguages)
         }
     }

model-api-gen-gradle/src/main/kotlin/org/modelix/metamodel/gradle/MetaModelGradlePlugin.kt

@@ -76,6 +76,7 @@ class MetaModelGradlePlugin @Inject constructor(val project: Project) : Plugin<P
                 settings.kotlinDir?.let { task.kotlinOutputDir.set(it) }
                 settings.modelqlKotlinDir?.let { task.modelqlKotlinOutputDir.set(it) }
                 settings.typescriptDir?.let { task.typescriptOutputDir.set(it) }
+                task.includeTypescriptBarrels.set(settings.includeTypescriptBarrels)
                 task.includedNamespaces.addAll(settings.includedLanguageNamespaces)
                 task.includedLanguages.addAll(settings.includedLanguages)
                 task.includedConcepts.addAll(settings.includedConcepts)

model-api-gen-gradle/src/main/kotlin/org/modelix/metamodel/gradle/MetaModelGradleSettings.kt

@@ -29,6 +29,7 @@ open class MetaModelGradleSettings {
             field = value
         }
     var typescriptDir: File? = null
+    var includeTypescriptBarrels: Boolean = false
     var registrationHelperName: String? = null
     var conceptPropertiesInterfaceName: String? = null
     val taskDependencies: MutableList<Any> = ArrayList()

model-api-gen/src/main/kotlin/org/modelix/metamodel/generator/TypescriptMMGenerator.kt

@@ -8,7 +8,7 @@ import java.nio.file.Files
 import java.nio.file.Path
 import kotlin.io.path.writeText
 
-class TypescriptMMGenerator(val outputDir: Path, val nameConfig: NameConfig = NameConfig()) {
+class TypescriptMMGenerator(val outputDir: Path, val nameConfig: NameConfig = NameConfig(), private val includeTsBarrels: Boolean = false) {
 
     private fun LanguageData.packageDir(): Path {
         val packageName = name
@@ -33,7 +33,7 @@ class TypescriptMMGenerator(val outputDir: Path, val nameConfig: NameConfig = Na
                 .resolve(language.generatedClassName().simpleName + ".ts")
                 .fixFormatAndWriteText(generateLanguage(language))
 
-            generateRegistry(languages)
+            generateIndexTs(languages)
         }
     }
 
@@ -54,7 +54,7 @@ class TypescriptMMGenerator(val outputDir: Path, val nameConfig: NameConfig = Na
 
     private fun Path.fixFormatAndWriteText(text: String) = writeText(fixFormat(text))
 
-    private fun generateRegistry(languages: ProcessedLanguageSet) {
+    private fun generateIndexTs(languages: ProcessedLanguageSet) {
         outputDir.resolve("index.ts").fixFormatAndWriteText(
             """
             import { LanguageRegistry } from "@modelix/ts-model-api";
@@ -68,6 +68,13 @@ class TypescriptMMGenerator(val outputDir: Path, val nameConfig: NameConfig = Na
             """
             }}
             }
+            ${if (!includeTsBarrels) {
+                ""
+            } else {
+                languages.getLanguages().joinToString("\n") {
+                    """export * from "./${it.simpleClassName()}";"""
+                }
+            }}
             """,
         )
     }

model-api-gen/src/test/kotlin/org/modelix/metamodel/generator/KotlinGeneratorTest.kt

@@ -10,6 +10,7 @@ import kotlin.io.path.deleteRecursively
 import kotlin.io.path.readText
 import kotlin.test.Test
 import kotlin.test.assertContains
+import kotlin.test.assertFalse
 
 class KotlinGeneratorTest {
 
@@ -81,6 +82,50 @@ class KotlinGeneratorTest {
         // val outputDir = File(".").toPath().resolve("build").resolve("test-generator-output")
         val outputDir = File("build/test-generator-output").toPath()
         TypescriptMMGenerator(outputDir).generate(LanguageSet(listOf(language)).process())
+
+        val indexFileContents = outputDir.resolve("index.ts").readText()
+        assertFalse(indexFileContents.contains("export * from"), "Does not include barrels when not explicitly opted in.")
+    }
+
+    @Test
+    fun test_ts_with_barrels() {
+        val input = """
+            name: org.modelix.entities
+            concepts:
+            - name: Entity
+              properties:
+              - name: name
+              children:
+              - name: properties
+                type: Property
+                multiple: true
+                optional: true
+            - name: Property
+              children:
+              - name: type
+                type: Type
+                optional: false
+            - name: Type
+            - name: EntityType
+              extends:
+              - Type
+              references:
+              - name: entity
+                type: Entity
+                optional: false
+            enums: []
+        """.trimIndent()
+
+        val language = Yaml.default.decodeFromString<LanguageData>(input)
+        val outputDir = File("build/test-generator-output").toPath()
+        TypescriptMMGenerator(outputDir, NameConfig(), true).generate(LanguageSet(listOf(language)).process())
+
+        val indexFileContents = outputDir.resolve("index.ts").readText()
+        assertContains(
+            indexFileContents,
+            """export * from "./L_org_modelix_entities";""",
+            message = "Includes barrels when explicitly opted in.",
+        )
     }
 
     @OptIn(ExperimentalPathApi::class)