feat(vue-model-api): add a library to use models from Vue.js

Users can use the exported functions `useModelsFromJson` to read models from exported JSON files.

To connect to a server, users must use `useModelClient` and `useRootNode`.

The returned objects also work with Vue.js reactivity system and the typed classes generated by
`model-api-gen`.

Author: Oleksandr Dzhychko

.github/CODEOWNERS

@@ -27,3 +27,4 @@
 /mps-model-server/ @slisson
 /mps-model-server-plugin/ @slisson
 /ts-model-api/ @slisson
+/vue-model-api/ @odzhychko

.pre-commit-config.yaml

@@ -31,3 +31,21 @@ repos:
           # IMPORTANT: keep in sync with the version configured in build.gradle.kts
           - --ktlint-version=0.50.0
           - --autofix
+  - repo: https://github.com/pre-commit/mirrors-prettier
+    # IMPORTANT: keep in sync with the version configured in `vue-model-api/package.json`
+    rev: v3.0.3
+    hooks:
+      - id: prettier
+        files: ^(vue-model-api)|(model-api-gen-gradle-test/vue-integration)/
+  - repo: https://github.com/pre-commit/mirrors-eslint
+    # IMPORTANT: keep versions of hook and additional dependencies in sync with the versions configured in `vue-model-api/package.json`
+    rev: v8.50.0
+    hooks:
+      - id: eslint
+        additional_dependencies:
+          - "[email protected]"
+          - "[email protected]"
+          - "@typescript-eslint/[email protected]"
+          - "@typescript-eslint/[email protected]"
+        files: ^vue-model-api/src/
+        'types': [ts]

build.gradle.kts

@@ -59,7 +59,12 @@ fun computeVersion(): Any {
     return if (versionFile.exists()) {
         versionFile.readText().trim()
     } else {
-        gitVersion().let { if (it.endsWith("-SNAPSHOT")) it else "$it-SNAPSHOT" }.also { versionFile.writeText(it) }
+        gitVersion()
+            // Avoid duplicated "-SNAPSHOT" ending
+            .let { if (it.endsWith("-SNAPSHOT")) it else "$it-SNAPSHOT" }
+            // Normalize the version so that is always a valid NPM version.
+            .let { if (it.matches("""\d+\.\d+.\d+-.*""".toRegex())) it else "0.0.1-$it" }
+            .also { versionFile.writeText(it) }
     }
 }
 

commitlint.config.js

@@ -23,6 +23,7 @@ module.exports = {
         "mps-model-server",
         "mps-model-server-plugin",
         "ts-model-api",
+        "vue-model-api",
       ],
     ],
     "subject-case": [0, 'never']

model-api-gen-gradle-test/settings.gradle.kts

@@ -30,3 +30,4 @@ rootProject.name = "model-api-gen-gradle-test"
 include("metamodel-export")
 include("typescript-generation")
 include("kotlin-generation")
+include("vue-integration")

model-api-gen-gradle-test/typescript-generation/build.gradle.kts

@@ -1,15 +1,14 @@
-import org.modelix.metamodel.gradle.GenerateMetaModelSources
+import com.github.gradle.node.npm.task.NpmTask
 
 plugins {
     base
     alias(libs.plugins.node)
     id("org.modelix.model-api-gen") apply false
 }
 
-val codeGenerationTask = project(":metamodel-export").tasks.named<GenerateMetaModelSources>("generateMetaModelSources")
-
 tasks.named("npm_run_build") {
-    inputs.dir(codeGenerationTask.map { it.typescriptOutputDir })
+    dependsOn(":metamodel-export:generateMetaModelSources")
+    inputs.dir(layout.buildDirectory.dir("typescript_src"))
     inputs.file("package.json")
     inputs.file("package-lock.json")
 
@@ -23,3 +22,8 @@ tasks.assemble {
 tasks.clean {
     dependsOn("npm_run_clean")
 }
+
+tasks.register<NpmTask>("packJsPackage") {
+    dependsOn("npm_run_build")
+    args.set(listOf("pack", "--pack-destination", "build"))
+}

model-api-gen-gradle-test/typescript-generation/package-lock.json

@@ -1,5 +1,5 @@
 {
-  "name": "@modelix/model-api-gen-gradle-test",
+  "name": "typescript-generation",
   "version": "0.0.0",
   "description": "",
   "keywords": [
@@ -14,10 +14,7 @@
   },
   "license": "Apache 2.0",
   "files": [
-    "dist/*.*js.map",
-    "dist/*.*js",
-    "dist/*.d.ts.map",
-    "dist/*.d.ts"
+    "dist/"
   ],
   "type": "commonjs",
   "main": "dist/index",

model-api-gen-gradle-test/typescript-generation/package.json

@@ -0,0 +1,2 @@
+.gradle
+build