@axinom/mosaic-cli 0.14.2-rc.8 → 0.15.0-rc.0

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@axinom/mosaic-cli",
-  "version": "0.14.2-rc.8",
+  "version": "0.15.0-rc.0",
   "description": "The Axinom Mosaic CLI",
   "author": "Axinom",
   "license": "PROPRIETARY",
@@ -13,7 +13,8 @@
     "mosaic": "./bin/mosaic.js"
   },
   "files": [
-    "dist"
+    "dist",
+    "src"
   ],
   "main": "dist/exports.js",
   "types": "dist/exports.d.ts",
@@ -32,8 +33,8 @@
     "@asyncapi/diff": "^0.4.0",
     "@asyncapi/modelina": "^0.43.0",
     "@asyncapi/parser": "^1.15.0",
-    "@axinom/mosaic-id-link-be": "^0.9.3-rc.8",
-    "@axinom/mosaic-service-common": "^0.27.0-rc.6",
+    "@axinom/mosaic-id-link-be": "^0.10.0-rc.0",
+    "@axinom/mosaic-service-common": "^0.27.0-rc.11",
     "@graphql-inspector/core": "^3.1.2",
     "@stoplight/spectral": "^5.9.1",
     "chalk": "^4.1.0",
@@ -66,5 +67,5 @@
   "publishConfig": {
     "access": "public"
   },
-  "gitHead": "39b4147fb00b4c9500e37effef1ac7b8fb43797f"
+  "gitHead": "140f827280ea9616400d5f6d2f770a0911ebf0e2"
 }

package/src/cli/README.md

@@ -0,0 +1,60 @@
+# Modular Mosaic CLI
+
+Mosaic CLI modularity achieved by using Typescript
+[Dynamic Import Expressions](https://www.typescriptlang.org/docs/handbook/release-notes/typescript-2-4.html#dynamic-import-expressions),
+that allows to asynchronously request a module at any arbitrary point in the
+program.
+
+CLI provides possibility to access commands added in other Mosaic libraries
+through `mosaic` script. To load CLI extension Mosaic CLI provides new command
+
+```
+mosaic create-extension-config
+```
+
+This command scans current project and finds all Mosaic `@axinom/mosaic-*`
+packages used in the project. Each package is checked for CLI extension, by
+importing method `cliExtension` from the package. If extension for Mosaic CLI is
+provided, package will be saved to configuration file `.mosaic` in project root.
+
+```
+CLI_EXTENSIONS=@axinom/mosaic-db-common
+```
+
+Mosaic CLI automatically imports all commands from packages saved in
+configuration file.
+
+## Create extension for Modular CLI
+
+Mosaic packages can provide extension commands for Mosaic CLI. To define
+extension commands should be used interface `CommandModule` from package
+[`yargs`](https://github.com/yargs/yargs). When creating extension commands for
+Mosaic CLI ensure, that the command name is unique across all Mosaic packages.
+
+Extension commands should be exported through method `cliExtension`.
+
+```
+export const cliExtension = (): yargs.CommandModule<any, any>[] => [
+  {
+    command: 'extension-command-start',
+    describe: 'Command description...',
+    builder: (yargs) =>
+      yargs
+        .option(...)
+        .example(...)
+        ...etc,
+    handler: commandHandler,
+  },
+  {
+    command: 'extension-command-do',
+    describe: 'Command description...',
+    builder: (yargs) =>
+      yargs
+        .option(...)
+        .example(...)
+        ...etc,
+    handler: commandHandler,
+  },
+];
+
+```

package/src/cli/index.ts

@@ -0,0 +1,47 @@
+import * as yargs from 'yargs';
+import { applyTemplates } from '../commands/apply-templates';
+import {
+  createExtensionConfigCommand,
+  getExtensions,
+} from '../commands/create-extension-config';
+import { getAccessToken } from '../commands/get-access-token';
+import { graphqlDiff } from '../commands/graphql-diff';
+import { msgCodegen } from '../commands/msg-codegen';
+import { msgDiff } from '../commands/msg-diff';
+import { pgDump } from '../commands/pg-dump';
+import { publishSchemaToDb } from '../commands/publish-schema-to-db';
+
+export const run = async (): Promise<void> => {
+  yargs
+    .scriptName('mosaic')
+    .env()
+    .command(applyTemplates)
+    .command(getAccessToken)
+    .command(publishSchemaToDb)
+    .command(pgDump)
+    .command(msgCodegen)
+    .command(msgDiff)
+    .command(createExtensionConfigCommand)
+    .command(graphqlDiff);
+
+  //adding cli extensions:
+  await Promise.all(
+    getExtensions().map(async (library) => {
+      try {
+        const { cliExtension } = await import(library);
+        if (cliExtension) {
+          cliExtension().map((cmd) => {
+            yargs.command(cmd);
+          });
+        }
+      } catch (error) {
+        //package is either not installed, or doesn't have cli extension
+      }
+    }),
+  );
+
+  yargs
+    .demandCommand()
+    .help()
+    .epilog(`For more information, visit https://portal.axinom.com.`).argv;
+};