@live-change/cli 0.9.198 → 0.9.199

package/lib/starter.js

@@ -6,6 +6,7 @@ import path from 'path'
 import http from 'http'
 import fs from 'fs'
 import yargs from 'yargs'
+import YAML from 'yaml'
 
 import { createProxyMiddleware } from 'http-proxy-middleware'
 import { readFile } from 'fs/promises'
@@ -364,9 +365,42 @@ export default function starter(servicesConfig = null, args = {}, extraArgs = {}
         default: '*'
       })
       yargs.option('json', {
-        describe: 'print json',
+        describe: 'print json (deprecated, use --output json)',
         type: 'boolean'
       })
+      yargs.option('output', {
+        describe: 'output format: text | json | yaml',
+        type: 'string',
+        choices: ['text', 'json', 'yaml']
+      })
+      yargs.option('model', {
+        describe: 'filter by model name',
+        type: 'string'
+      })
+      yargs.option('index', {
+        describe: 'filter by index name',
+        type: 'string'
+      })
+      yargs.option('action', {
+        describe: 'filter by action name',
+        type: 'string'
+      })
+      yargs.option('view', {
+        describe: 'filter by view name',
+        type: 'string'
+      })
+      yargs.option('trigger', {
+        describe: 'filter by trigger name',
+        type: 'string'
+      })
+      yargs.option('event', {
+        describe: 'filter by event name',
+        type: 'string'
+      })
+      yargs.option('query', {
+        describe: 'filter by query name',
+        type: 'string'
+      })
     }, async (argv) => {
       await setupTelemetry(argv, servicesConfig)
       await describe(argv)
@@ -478,62 +512,148 @@ export async function describe(argv) {
   const services = new Services(argv.services)
   await services.loadServices()
   await services.processDefinitions()
-  function describeService(service) {
-    console.log("Service", service.name)
-    if(argv.json) {
-      console.log(JSON.stringify(service.toJSON(), null, "  "))
-      return
+
+  const output = argv.output || (argv.json ? 'json' : 'text')
+  const hasFilters =
+    argv.model || argv.index || argv.action ||
+    argv.view || argv.trigger || argv.event || argv.query
+
+  function buildFilteredDescription(service) {
+    const json = service.toJSON ? service.toJSON() : service
+    const result = {
+      service: service.name
+    }
+
+    if(argv.model) {
+      const model = json.models && json.models[argv.model]
+      result.model = model ? { [argv.model]: model } : null
     }
-    if(Object.keys(service.models).length > 0) console.log("  models:")
-    for(const modelName in service.models) {
-      const model = service.models[modelName]
-      const properties = Object.keys(model.properties ?? {})
-      console.log("    ", modelName, "(", properties.join(', '), ")")
-      for(const indexName in model.indexes) {
-        const index = model.indexes[indexName]
-        console.log("      ", indexName)
+
+    if(argv.index) {
+      const globalIndex = json.indexes && json.indexes[argv.index]
+      let modelIndex = null
+      if(json.models) {
+        for(const modelName in json.models) {
+          const model = json.models[modelName]
+          if(model.indexes && model.indexes[argv.index]) {
+            modelIndex = {
+              model: modelName,
+              index: model.indexes[argv.index]
+            }
+            break
+          }
+        }
+      }
+      result.index = {
+        global: globalIndex || null,
+        model: modelIndex
       }
     }
-    if(Object.keys(service.indexes).length > 0) console.log("  indexes:")
-    for(const indexName in service.indexes) {
-      const index = service.indexes[indexName]
-      console.log("    ", indexName)
+
+    if(argv.action) {
+      const action = json.actions && json.actions[argv.action]
+      result.action = action ? { [argv.action]: action } : null
     }
-    if(Object.keys(service.actions).length > 0) console.log("  actions:")
-    for(const actionName in service.actions) {
-      const action = service.actions[actionName]
-      const properties = Object.keys(action.properties ?? {})
-      console.log("    ", actionName, "(", properties.join(', '), ")")
+
+    if(argv.view) {
+      const view = json.views && json.views[argv.view]
+      result.view = view ? { [argv.view]: view } : null
     }
-    if(Object.keys(service.views).length > 0) console.log("  views:")
-    for(const viewName in service.views) {
-      const view = service.views[viewName]
-      const properties = Object.keys(view.properties ?? {})
-      console.log("    ", viewName, "(", properties.join(', '), ")",
-          view.global ? "global" : "", view.internal ? "internal" : "", view.remote ? "remote" : "")
+
+    if(argv.trigger) {
+      const trigger = json.triggers && json.triggers[argv.trigger]
+      result.trigger = trigger ? { [argv.trigger]: trigger } : null
     }
-    if(Object.keys(service.triggers).length > 0) console.log("  triggers:")
-    for(const triggerName in service.triggers) {
-      const triggers = service.triggers[triggerName]
-      for(const trigger of triggers) {
-        const properties = Object.keys(trigger.properties ?? {})
-        console.log("    ", triggerName, "(", properties.join(', '), ")")
-      }
+
+    if(argv.event) {
+      const event = json.events && json.events[argv.event]
+      result.event = event ? { [argv.event]: event } : null
+    }
+
+    if(argv.query) {
+      const query = json.queries && json.queries[argv.query]
+      result.query = query ? { [argv.query]: query } : null
+    }
+
+    return result
+  }
+
+  function printStructured(data) {
+    if(output === 'json') {      
+      console.log(JSON.stringify(data, null, 2))
+    } else {
+      console.log(YAML.stringify(JSON.parse(JSON.stringify(data))))
     }
-    if(Object.keys(service.events).length > 0) console.log("  events:")
-    for(const eventName in service.events) {
-      const event = service.events[eventName]
-      const properties = Object.keys(event.properties ?? {})
-      console.log("    ", eventName, "(", properties.join(', '), ")")
+  }
+
+  function describeService(service) {
+    if(output === 'text' && !hasFilters) {
+      console.log("Service", service.name)
+      if(Object.keys(service.models).length > 0) console.log("  models:")
+      for(const modelName in service.models) {
+        const model = service.models[modelName]
+        const properties = Object.keys(model.properties ?? {})
+        console.log("    ", modelName, "(", properties.join(', '), ")")
+        for(const indexName in model.indexes) {
+          const index = model.indexes[indexName]
+          console.log("      ", indexName)
+        }
+      }
+      if(Object.keys(service.indexes).length > 0) console.log("  indexes:")
+      for(const indexName in service.indexes) {
+        const index = service.indexes[indexName]
+        console.log("    ", indexName)
+      }
+      if(Object.keys(service.actions).length > 0) console.log("  actions:")
+      for(const actionName in service.actions) {
+        const action = service.actions[actionName]
+        const properties = Object.keys(action.properties ?? {})
+        console.log("    ", actionName, "(", properties.join(', '), ")")
+      }
+      if(Object.keys(service.views).length > 0) console.log("  views:")
+      for(const viewName in service.views) {
+        const view = service.views[viewName]
+        const properties = Object.keys(view.properties ?? {})
+        console.log("    ", viewName, "(", properties.join(', '), ")",
+          view.global ? "global" : "", view.internal ? "internal" : "", view.remote ? "remote" : "")
+      }
+      if(Object.keys(service.triggers).length > 0) console.log("  triggers:")
+      for(const triggerName in service.triggers) {
+        const triggers = service.triggers[triggerName]
+        for(const trigger of triggers) {
+          const properties = Object.keys(trigger.properties ?? {})
+          console.log("    ", triggerName, "(", properties.join(', '), ")")
+        }
+      }
+      if(Object.keys(service.events).length > 0) console.log("  events:")
+      for(const eventName in service.events) {
+        const event = service.events[eventName]
+        const properties = Object.keys(event.properties ?? {})
+        console.log("    ", eventName, "(", properties.join(', '), ")")
+      }
+      if(Object.keys(service.queries).length > 0) console.log("  queries:")
+      for(const queryName in service.queries) {
+        const query = service.queries[queryName]
+        const properties = Object.keys(query.properties ?? {})
+        console.log("    ", queryName, "(", properties.join(', '), ")")
+      }
+      return
     }
-    if(Object.keys(service.queries).length > 0) console.log("  queries:")
-    for(const queryName in service.queries) {
-      const query = service.queries[queryName]
-      const properties = Object.keys(query.properties ?? {})
-      console.log("    ", queryName, "(", properties.join(', '), ")")
+
+    if(hasFilters) {
+      const filtered = buildFilteredDescription(service)
+      printStructured(filtered)
+    } else {
+      const json = service.toJSON ? service.toJSON() : service
+      printStructured(json)
     }
   }
+
   if(argv.service === '*') {
+    if(hasFilters) {
+      console.error("When using filters like --model, --action, etc. you must specify a concrete --service")
+      process.exit(1)
+    }
     for(const service of services.serviceDefinitions) {
       describeService(service)
     }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@live-change/cli",
-  "version": "0.9.198",
+  "version": "0.9.199",
   "description": "Live Change Framework - command line interface",
   "main": "index.js",
   "scripts": {
@@ -25,12 +25,12 @@
   "type": "module",
   "homepage": "https://github.com/live-change/live-change-stack",
   "dependencies": {
-    "@live-change/dao": "^0.9.198",
-    "@live-change/dao-sockjs": "^0.9.198",
-    "@live-change/dao-websocket": "^0.9.198",
-    "@live-change/db-server": "^0.9.198",
-    "@live-change/framework": "^0.9.198",
-    "@live-change/server": "^0.9.198",
+    "@live-change/dao": "^0.9.199",
+    "@live-change/dao-sockjs": "^0.9.199",
+    "@live-change/dao-websocket": "^0.9.199",
+    "@live-change/db-server": "^0.9.199",
+    "@live-change/framework": "^0.9.199",
+    "@live-change/server": "^0.9.199",
     "dotenv": "^17.2.1",
     "express": "^4.18.2",
     "http-proxy-middleware": "2.0.6",
@@ -38,7 +38,8 @@
     "serialize-javascript": "^6.0.2",
     "sockjs": "^0.3.24",
     "websocket": "^1.0.34",
+    "yaml": "^2.5.0",
     "yargs": "^17.7.2"
   },
-  "gitHead": "7e485dcbaa2af7fb17052a40238210dc8bdf0c09"
+  "gitHead": "1900043a10cf9ad49b9cc33a539fb973706de962"
 }