Merge pull request #149 from modelix/typescript-generator-test

slisson · web-flow · commit eb1f19fa8922 · 2023-06-22T10:08:38.000+02:00
fix(model-api-gen): added tests for the typescript generator
diff --git a/model-api-gen-gradle-test/build.gradle.kts b/model-api-gen-gradle-test/build.gradle.kts
@@ -1,3 +1,4 @@
+import com.github.gradle.node.npm.task.NpmSetupTask
 
 buildscript {
     repositories {
@@ -24,6 +25,7 @@ plugins {
     kotlin("jvm") version "1.8.20"
     id("base")
     id("org.modelix.model-api-gen")
+    id("com.github.node-gradle.node") version "3.4.0"
 }
 
 val mps by configurations.creating
@@ -68,6 +70,7 @@ metamodel {
     mpsHome = mpsDir
     kotlinDir = kotlinGenDir
     kotlinProject = project
+    typescriptDir = projectDir.resolve("typescript_src")
     includeNamespace("jetbrains")
     exportModules("jetbrains.mps.baseLanguage")
 
@@ -78,3 +81,25 @@ metamodel {
         typedNodeImpl.suffix = "Impl"
     }
 }
+
+node {
+    version.set("18.3.0")
+    npmVersion.set("8.11.0")
+    download.set(true)
+}
+
+tasks.withType<NpmSetupTask> {
+    dependsOn("generateMetaModelSources")
+}
+
+tasks.named("npm_run_build") {
+    inputs.dir("typescript_src")
+    inputs.file("package.json")
+    inputs.file("package-lock.json")
+
+    outputs.dir("dist")
+}
+
+tasks.named("assemble") {
+    dependsOn("npm_run_build")
+}
diff --git a/model-api-gen-gradle-test/package.json b/model-api-gen-gradle-test/package.json
@@ -0,0 +1,52 @@
+{
+  "name": "@modelix/model-api-gen-gradle-test",
+  "version": "0.0.0",
+  "description": "",
+  "keywords": [
+    "ts-model-api",
+    "node",
+    "typescript"
+  ],
+  "homepage": "https://modelix.org/",
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/modelix/modelix.core.git"
+  },
+  "license": "Apache 2.0",
+  "files": [
+    "dist/*.*js.map",
+    "dist/*.*js",
+    "dist/*.d.ts.map",
+    "dist/*.d.ts"
+  ],
+  "type": "commonjs",
+  "main": "dist/index",
+  "typings": "dist/index.d.ts",
+  "types": "dist/index.d.ts",
+  "scripts": {
+    "build": "tsc -p tsconfig.json",
+    "clean": "shx rm -rf dist/ .*cache *.log",
+    "lint": "npm run lint:debug -- --config tslint.json",
+    "lint:debug": "tslint --project tsconfig.json --format stylish",
+    "prepublishOnly": "npm run lint && npm run build",
+    "test": "shx echo 'Write your own tests'",
+    "ts": "tsc",
+    "watch": "tsc --watch"
+  },
+  "dependencies": {
+    "@modelix/ts-model-api": "file:../ts-model-api"
+  },
+  "devDependencies": {
+    "@reallyland/tsconfig": "^2.0.0",
+    "@reallyland/tslint-config": "^1.1.1",
+    "@types/node": "^13.9.8",
+    "husky": "^4.2.3",
+    "shx": "^0.3.2",
+    "tslint": "^6.1.0",
+    "typescript": "^4.7.4"
+  },
+  "engines": {
+    "node": ">= 10.18.1",
+    "npm": ">= 6.13.4"
+  }
+}
diff --git a/model-api-gen-gradle-test/tsconfig.json b/model-api-gen-gradle-test/tsconfig.json
@@ -0,0 +1,15 @@
+{
+  "extends": "@reallyland/tsconfig",
+  "compilerOptions": {
+    "rootDir": "typescript_src",
+    "outDir": "dist",
+    "declarationDir": "dist",
+    "noUnusedLocals": false,
+    "importsNotUsedAsValues": "remove",
+    "module": "CommonJS",
+    "resolveJsonModule": false,
+    "target": "ES2020"
+  },
+  "include": ["typescript_src/**/*.ts"],
+  "exclude": ["dist"]
+}
diff --git a/model-api-gen-gradle-test/tslint.json b/model-api-gen-gradle-test/tslint.json
@@ -0,0 +1,24 @@
+{
+  "extends": [
+    "@reallyland/tslint-config"
+  ],
+  "rules": {
+    "object-curly-spacing": false,
+    "quotemark": false,
+    "ordered-imports": false,
+    "function-name": false,
+    "prefer-array-literal": false,
+    "semicolon": false,
+    "max-classes-per-file": false,
+    "prefer-const": false,
+    "prefer-template": false,
+    "no-empty-interface": false,
+    "interface-name": false,
+    "ter-arrow-parens": false,
+    "no-increment-decrement": false,
+    "no-angle-bracket-type-assertion": false,
+    "object-literal-shorthand": false,
+    "trailing-comma": false,
+    "max-line-length": false
+  }
+}
diff --git a/model-api-gen/src/main/kotlin/org/modelix/metamodel/generator/ConceptInLanguage.kt b/model-api-gen/src/main/kotlin/org/modelix/metamodel/generator/ConceptInLanguage.kt
@@ -112,10 +112,6 @@ class ConceptRef(val languageName: String, val conceptName: String) {
     override fun toString(): String = languageName + "." + conceptName
 }
 
-private val reservedPropertyNames: Set<String> = setOf(
-    "constructor", // already exists on JS objects
-) + IConcept::class.members.map { it.name }
-
 data class FeatureInConcept(val concept: LanguageSet.ConceptInLanguage, val data: IConceptFeatureData) {
     val validName: String by lazy {
         if (reservedPropertyNames.contains(originalName) || hasNameConflict()) {
diff --git a/model-api-gen/src/main/kotlin/org/modelix/metamodel/generator/GeneratorInput.kt b/model-api-gen/src/main/kotlin/org/modelix/metamodel/generator/GeneratorInput.kt
@@ -20,8 +20,9 @@ import org.modelix.model.data.LanguageData
 import org.modelix.model.data.PropertyType
 import kotlin.reflect.KClass
 
-private val reservedPropertyNames: Set<String> = setOf(
+val reservedPropertyNames: Set<String> = setOf(
     "constructor", // already exists on JS objects
+    "_node" // exists in TypedNode in ts-model-api
 ) + IConcept::class.members.map { it.name }
 
 interface IProcessedLanguageSet
diff --git a/model-api-gen/src/main/kotlin/org/modelix/metamodel/generator/MetaModelGenerator.kt b/model-api-gen/src/main/kotlin/org/modelix/metamodel/generator/MetaModelGenerator.kt
@@ -10,10 +10,6 @@ import org.modelix.model.data.PrimitivePropertyType
 import java.nio.file.Path
 import kotlin.reflect.KClass
 
-private val reservedPropertyNames: Set<String> = setOf(
-    "constructor", // already exists on JS objects
-) + IConcept::class.members.map { it.name }
-
 class MetaModelGenerator(val outputDir: Path, val nameConfig: NameConfig = NameConfig()) {
     var alwaysUseNonNullableProperties: Boolean = true
 
diff --git a/model-api-gen/src/main/kotlin/org/modelix/metamodel/generator/TypescriptMMGenerator.kt b/model-api-gen/src/main/kotlin/org/modelix/metamodel/generator/TypescriptMMGenerator.kt
@@ -95,15 +95,15 @@ class TypescriptMMGenerator(val outputDir: Path, val nameConfig: NameConfig = Na
             when (feature) {
                 is ProcessedProperty -> {
                     val rawValueName = feature.rawValueName()
-                    val defaultPropertyText = """
+                    val rawPropertyText = """
                         public set $rawValueName(value: string | undefined) {
-                            this.node.setPropertyValue("${feature.originalName}", value)
+                            this._node.setPropertyValue("${feature.originalName}", value)
                         }
                         public get $rawValueName(): string | undefined {
-                            return this.node.getPropertyValue("${feature.originalName}")
+                            return this._node.getPropertyValue("${feature.originalName}")
                         }
                     """.trimIndent()
-                    if (feature.type is PrimitivePropertyType) {
+                    val typedPropertyText = if (feature.type is PrimitivePropertyType) {
                         when((feature.type as PrimitivePropertyType).primitive) {
                             Primitive.INT -> {
                                 """
@@ -128,20 +128,33 @@ class TypescriptMMGenerator(val outputDir: Path, val nameConfig: NameConfig = Na
                                 
                             """.trimIndent()
                             }
-                            else -> defaultPropertyText
+                            Primitive.STRING -> """
+                                public set ${feature.generatedName}(value: string) {
+                                    this.${rawValueName} = value;
+                                }
+                                public get ${feature.generatedName}(): string {
+                                    return this.${rawValueName} ?? "";
+                                }
+                                
+                            """.trimIndent()
                         }
-                    } else defaultPropertyText
+                    } else ""
+                    """
+                        $rawPropertyText
+                        $typedPropertyText
+                    """.trimIndent()
                 }
                 is ProcessedReferenceLink -> {
                     val typeRef = feature.type.resolved
                     val languagePrefix = typeRef.languagePrefix(concept.language)
                     val entityType = "$languagePrefix${typeRef.nodeWrapperInterfaceName()}"
                     """
                     public set ${feature.generatedName}(value: $entityType | undefined) {
-                        this.node.setReferenceTargetNode("${feature.originalName}", value?.unwrap());
+                        this._node.setReferenceTargetNode("${feature.originalName}", value?.unwrap());
                     }
                     public get ${feature.generatedName}(): $entityType | undefined {
-                        return LanguageRegistry.INSTANCE.wrapNode(this.node.getReferenceTargetNode("${feature.originalName}"));
+                        let target = this._node.getReferenceTargetNode("${feature.originalName}");
+                        return target ? LanguageRegistry.INSTANCE.wrapNode(target) as $entityType : undefined;
                     }
                 """.trimIndent()
                 }
@@ -150,7 +163,7 @@ class TypescriptMMGenerator(val outputDir: Path, val nameConfig: NameConfig = Na
                     val typeRef = feature.type.resolved
                     val languagePrefix = typeRef.languagePrefix(concept.language)
                     """
-                        public ${feature.generatedName}: $accessorClassName<$languagePrefix${typeRef.nodeWrapperInterfaceName()}> = new $accessorClassName(this.node, "${feature.originalName}")
+                        public ${feature.generatedName}: $accessorClassName<$languagePrefix${typeRef.nodeWrapperInterfaceName()}> = new $accessorClassName(this._node, "${feature.originalName}")
                     """.trimIndent()
                 }
                 else -> ""
@@ -159,26 +172,35 @@ class TypescriptMMGenerator(val outputDir: Path, val nameConfig: NameConfig = Na
         val features = concept.getOwnRoles().joinToString("\n") { feature ->
             when (feature) {
                 is ProcessedProperty -> {
-                    val defaultPropertyText = """
+                    val rawPropertyText = """
                         ${feature.rawValueName()}: string | undefined
                     """.trimIndent()
-                    if (feature.type is PrimitivePropertyType) {
+                    val typedPropertyText = if (feature.type is PrimitivePropertyType) {
                         when ((feature.type as PrimitivePropertyType).primitive) {
                             Primitive.BOOLEAN -> {
                                 """
                                 ${feature.generatedName}: boolean
                                 
-                            """.trimIndent()
+                                """.trimIndent()
                             }
                             Primitive.INT -> {
                                 """
                                 ${feature.generatedName}: number
                                 
-                            """.trimIndent()
+                                """.trimIndent()
+                            }
+                            Primitive.STRING -> {
+                                """
+                                ${feature.generatedName}: string
+                                
+                                """.trimIndent()
                             }
-                            else -> defaultPropertyText
                         }
-                    } else defaultPropertyText
+                    } else ""
+                    """
+                        $rawPropertyText
+                        $typedPropertyText
+                    """.trimIndent()
                 }
                 is ProcessedReferenceLink -> {
                     val typeRef = feature.type.resolved
@@ -275,8 +297,4 @@ internal fun ProcessedLanguage.languageDependencies(): List<ProcessedLanguage> {
     return languageSet.getLanguages().filter { languageNames.contains(it.name) }.minus(this)
 }
 
-private fun ProcessedProperty.rawValueName() =
-    if (type is PrimitivePropertyType
-        && ((type as PrimitivePropertyType).primitive == Primitive.STRING))
-            generatedName
-    else "raw_$generatedName"
+private fun ProcessedProperty.rawValueName() = "raw_$generatedName"
diff --git a/model-api/src/jsMain/kotlin/org/modelix/model/api/NodeAdapterJS.kt b/model-api/src/jsMain/kotlin/org/modelix/model/api/NodeAdapterJS.kt
@@ -32,7 +32,7 @@ object JSNodeConverter {
     fun toINode(node: Any): INode {
         if (node is INode) return node
         if (node is NodeAdapterJS) return node.node
-        if (node is TypedNode) return toINode(node.node)
+        if (node is TypedNode) return toINode(node._node)
 
         // Workaround, because ts-model-api is loaded twice by webpack making the instanceof check on TypedNode fail.
         val unwrapped = node.asDynamic().node
diff --git a/ts-model-api/src/TypedNode.ts b/ts-model-api/src/TypedNode.ts
@@ -1,11 +1,11 @@
 import type {INodeJS} from "./INodeJS.js";
 
 export class TypedNode implements ITypedNode {
-  constructor(public node: INodeJS) {
+  constructor(public _node: INodeJS) {
   }
 
   unwrap(): INodeJS {
-    return this.node;
+    return this._node;
   }
 
 }

Original file line number	Diff line number	Diff line change
`@@ -1,11 +1,11 @@`
`1`	`1`	`import type {INodeJS} from "./INodeJS.js";`
`2`	`2`
`3`	`3`	`export class TypedNode implements ITypedNode {`
`4`		`- constructor(public node: INodeJS) {`
	`4`	`+ constructor(public _node: INodeJS) {`
`5`	`5`	`}`
`6`	`6`
`7`	`7`	`unwrap(): INodeJS {`
`8`		`- return this.node;`
	`8`	`+ return this._node;`
`9`	`9`	`}`
`10`	`10`
`11`	`11`	`}`