@lionweb/cli 0.1.0-beta.0 → 0.5.0-beta.4

package/CHANGELOG.md

@@ -0,0 +1,6 @@
+# Changelog
+
+## 0.5.0
+
+* Configure single CLI entrypoint.
+

package/README.md

@@ -0,0 +1,52 @@
+# The `cli` package
+
+An NPM package that can be added to a Node.js/NPM codebase as follows:
+
+```shell
+$ npm add @lionweb/cli
+```
+It exposes an executable for use with a CLI.
+It works as follows:
+
+```shell
+$ node dist/lionweb-cli.js <command> <arguments>
+```
+
+(Turning this into a proper NPM CLI command is a TODO.)
+
+Just running
+
+```shell
+$ node dist/lionweb-cli.js
+```
+
+produces information about which commands are available.
+
+Build the executable from source as follows:
+
+```shell
+$ ./build.sh
+```
+
+
+## Extracting essential information from a serialization chunk
+
+Run the following command to make "extractions" from a serialization chunk (e.g.):
+
+```shell
+node dist/lionweb-cli.js extract ../artifacts/chunks/languages/lioncore.json
+```
+
+This is meant as a way to inspect, reason about, and compare serialization because the format is rather verbose.
+These extractions are:
+
+* A "sorted" JSON with:
+    * all nodes sorted by ID,
+    * for all nodes, their properties, containments, and references sorted by key (from the meta-pointer),
+    * and all containments and references sorted by ID.
+* A "shortened" JSON where keys are used as key names.
+* If the serialization represents a language - i.e.: a LionCore model - then a textual version is generated as well.
+
+This CLI utility does not perform any explicit validation apart from the file at the given path existing and being valid JSON.
+It does some implicit validation as it can error out on incorrect serializations.
+

package/build.sh

@@ -0,0 +1,6 @@
+#!/usr/bin/env sh
+
+rm -rf dist/ node_modules/ lionweb-cli-*.tgz
+npm i
+npm run build
+

package/dist/lionweb-cli.d.ts

@@ -0,0 +1,3 @@
+#!/usr/bin/env node
+export {};
+//# sourceMappingURL=lionweb-cli.d.ts.map

package/dist/lionweb-cli.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"lionweb-cli.d.ts","sourceRoot":"","sources":["../src/lionweb-cli.ts"],"names":[],"mappings":""}

package/dist/{lioncore-cli.js → lionweb-cli.js}

@@ -1,14 +1,16 @@
+#!/usr/bin/env node
 import { argv } from "process";
 import { extractFromSerialization } from "./serialization-extractor.js";
 import { diagramFromSerialization } from "./m3/diagram-generator.js";
 const main = (args) => {
     if (args.length <= 2) {
-        console.log(`lioncore-cli is a LionWeb utility around LionCore-TypeScript
+        console.log(`lionweb-cli is a LionWeb utility around LionWeb-TypeScript
 
-Usage: $ lioncore-cli <command> <arguments>
+Usage: $ lionweb-cli <command> <arguments>
 
 Available commands are:
 
+    diagram
     extract
 `);
         return;
@@ -35,11 +37,11 @@ If the chunk is the serialization of a LionCore Language/M2, then a textual rend
             }
             return;
         }
-        // TODO  schema, Ecore import
+        // TODO  generate schema, import Ecore
         default: {
             console.error(`command "${command}" is not recognized`);
         }
     }
 };
 main(argv);
-//# sourceMappingURL=lioncore-cli.js.map
+//# sourceMappingURL=lionweb-cli.js.map

package/dist/{lioncore-cli.js.map → lionweb-cli.js.map}

@@ -1 +1 @@
-{"version":3,"file":"lioncore-cli.js","sourceRoot":"","sources":["../src/lioncore-cli.ts"],"names":[],"mappings":"AAAA,OAAO,EAAC,IAAI,EAAC,MAAM,SAAS,CAAA;AAE5B,OAAO,EAAC,wBAAwB,EAAC,MAAM,8BAA8B,CAAA;AACrE,OAAO,EAAC,wBAAwB,EAAC,MAAM,2BAA2B,CAAA;AAGlE,MAAM,IAAI,GAAG,CAAC,IAAc,EAAC,EAAE;IAC3B,IAAI,IAAI,CAAC,MAAM,IAAI,CAAC,EAAE;QAClB,OAAO,CAAC,GAAG,CACnB;;;;;;;CAOC,CACQ,CAAA;QACD,OAAM;KACT;IAED,MAAM,OAAO,GAAG,IAAI,CAAC,CAAC,CAAC,CAAA;IACvB,MAAM,WAAW,GAAG,IAAI,CAAC,KAAK,CAAC,CAAC,CAAC,CAAA;IACjC,QAAQ,OAAO,EAAE;QAEb,KAAK,SAAS,CAAC,CAAC;YACZ,IAAI,WAAW,CAAC,MAAM,KAAK,CAAC,EAAE;gBAC1B,OAAO,CAAC,GAAG,CACP,8GAA8G,CACjH,CAAA;aACJ;iBAAM;gBACH,WAAW,CAAC,OAAO,CAAC,wBAAwB,CAAC,CAAA;aAChD;YACD,OAAM;SACT;QAED,KAAK,SAAS,CAAC,CAAC;YACZ,IAAI,WAAW,CAAC,MAAM,KAAK,CAAC,EAAE;gBAC1B,OAAO,CAAC,GAAG,CAC3B;yGACyG,CACxF,CAAA;aACJ;iBAAM;gBACH,WAAW,CAAC,OAAO,CAAC,wBAAwB,CAAC,CAAA;aAChD;YACD,OAAM;SACT;QAED,6BAA6B;QAE7B,OAAO,CAAC,CAAC;YACL,OAAO,CAAC,KAAK,CAAC,YAAY,OAAO,qBAAqB,CAAC,CAAA;SAC1D;KACJ;AAEL,CAAC,CAAA;AAED,IAAI,CAAC,IAAI,CAAC,CAAA"}
+{"version":3,"file":"lionweb-cli.js","sourceRoot":"","sources":["../src/lionweb-cli.ts"],"names":[],"mappings":";AAGA,OAAO,EAAC,IAAI,EAAC,MAAM,SAAS,CAAA;AAE5B,OAAO,EAAC,wBAAwB,EAAC,MAAM,8BAA8B,CAAA;AACrE,OAAO,EAAC,wBAAwB,EAAC,MAAM,2BAA2B,CAAA;AAGlE,MAAM,IAAI,GAAG,CAAC,IAAc,EAAC,EAAE;IAC3B,IAAI,IAAI,CAAC,MAAM,IAAI,CAAC,EAAE;QAClB,OAAO,CAAC,GAAG,CACnB;;;;;;;;CAQC,CACQ,CAAA;QACD,OAAM;KACT;IAED,MAAM,OAAO,GAAG,IAAI,CAAC,CAAC,CAAC,CAAA;IACvB,MAAM,WAAW,GAAG,IAAI,CAAC,KAAK,CAAC,CAAC,CAAC,CAAA;IACjC,QAAQ,OAAO,EAAE;QAEb,KAAK,SAAS,CAAC,CAAC;YACZ,IAAI,WAAW,CAAC,MAAM,KAAK,CAAC,EAAE;gBAC1B,OAAO,CAAC,GAAG,CACP,8GAA8G,CACjH,CAAA;aACJ;iBAAM;gBACH,WAAW,CAAC,OAAO,CAAC,wBAAwB,CAAC,CAAA;aAChD;YACD,OAAM;SACT;QAED,KAAK,SAAS,CAAC,CAAC;YACZ,IAAI,WAAW,CAAC,MAAM,KAAK,CAAC,EAAE;gBAC1B,OAAO,CAAC,GAAG,CAC3B;yGACyG,CACxF,CAAA;aACJ;iBAAM;gBACH,WAAW,CAAC,OAAO,CAAC,wBAAwB,CAAC,CAAA;aAChD;YACD,OAAM;SACT;QAED,sCAAsC;QAEtC,OAAO,CAAC,CAAC;YACL,OAAO,CAAC,KAAK,CAAC,YAAY,OAAO,qBAAqB,CAAC,CAAA;SAC1D;KACJ;AAEL,CAAC,CAAA;AAED,IAAI,CAAC,IAAI,CAAC,CAAA"}

package/package.json

@@ -1,24 +1,27 @@
 {
   "name": "@lionweb/cli",
-  "version": "0.1.0-beta.0",
+  "version": "0.5.0-beta.4",
   "description": "LionWeb CLI for {Java|Type}Script",
+  "bin": "./dist/lionweb-cli.js",
   "main": "dist/index.js",
   "types": "dist/index.d.ts",
   "typings": "dist/index.d.ts",
   "type": "module",
-  "license": "MIT",
+  "license": "Apache-2.0",
   "repository": {
     "type": "git",
-    "url": "https://github.com/LionWeb-org/lioncore-typescript.git"
+    "url": "https://github.com/LionWeb-io/lionweb-typescript.git"
   },
   "bugs": {
-    "url": "https://github.com/LionWeb-org/lioncore-typescript/issues"
+    "url": "https://github.com/LionWeb-io/lionweb-typescript/issues"
+  },
+  "dependencies": {
+    "@lionweb/core": "0.5.0-beta.3",
+    "@lionweb/utilities": "0.5.0-beta.3"
   },
   "devDependencies": {
-    "@lionweb/core": "0.5.0-beta.0",
-    "@lionweb/utilities": "0.1.0-beta.0",
-    "@types/node": "^20.6.3",
-    "typescript": "^5.2.2"
+    "@types/node": "20.6.3",
+    "typescript": "5.2.2"
   },
   "scripts": {
     "build": "tsc"

package/dist/lioncore-cli.d.ts

@@ -1,2 +0,0 @@
-export {};
-//# sourceMappingURL=lioncore-cli.d.ts.map

package/dist/lioncore-cli.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"lioncore-cli.d.ts","sourceRoot":"","sources":["../src/lioncore-cli.ts"],"names":[],"mappings":""}