cob-cli 2.40.0 → 2.41.0

package/bin/cob-cli.js

@@ -90,7 +90,8 @@ program
     .command('generateMermaid')
     .option('-e --environment <name>', 'environment to use')
     .option('-s --server <name>', 'server to use (ignores -e)')
-    .option('-f --filter <regexp>', 'regexp used to filter against names & descriptions')
+    .option('-f --filter <regexp>', 'regexp used to filter against names & descriptions. You can use multiple filters separated by spaces and you can prefix the filter with a minus(-) to explicit Definition not containing that filter.')
+    .option('-i --includeReferencedTables', 'Includes tables referenced, even if excluded by the filter')
     .option('-l --labels <lang>', 'add labels in the given language. Available options are "en", "pt" or "es"')
     .option('-d --debug', 'send debug info to stderr')
     .description('Generates mermaid diagram from Definitions')

package/lib/commands/generateMermaid.js

@@ -19,9 +19,11 @@ async function generateMermaid(args) {
         console.log('erDiagram');
         let refs = [];
         let references = [];
+        const tables = new Set();
         for(const def of defs){
             refs.push(...getRefs(def.name, def.fieldDefinitions, args.debug));
             references.push(...getReferences(def.name, def.fieldDefinitions, args.debug));
+            tables.add(def.name);
         }
         refs = uniqBy(refs, r => r.one + ":" + r.many)
         references = uniqBy(references, r => r.one + ":" + r.many)
@@ -30,41 +32,37 @@ async function generateMermaid(args) {
             'references: ', references
         )
 
-        const tables = new Set();
-        for(const ref of refs){
-            tables.add(ref.one);
-            tables.add(ref.many);
-        }
-
         // Output table defs
         for(const table of tables){
             const id = toMermaidId(table)
-            if (id != table) { console.debug(`\t${id}["${table}"]{}`) }
+            console.debug(`\t${id}["${table}"]{}`) 
         }
         console.debug("")
         // Output relations
         for (const ref of refs) {
-            const one = toMermaidId(ref.one);
-            const many = toMermaidId(ref.many);
-            const left = '|o';
-            const right = (ref.required ? '|' : 'o') + '{';
-            const msgType = references.some(r => r.one === ref.one && r.many === ref.many) ? "hasMany" : "isOf"
-            let msg = "";
-            switch (args.label) {
-                case "en":
-                    msg = msgType == "hasMany" ? `${ref.one} have many ${ref.many}` : `_${ref.fieldName}_ is one of ${ref.one}`;
-                    break;
-                case "pt":
-                    msg = msgType == "hasMany" ? `${ref.one} têm ${ref.many}` : `_${ref.fieldName}_ refere um registo de ${ref.one}`;
-                    break;
-                case "es":
-                    msg = msgType == "hasMany" ? `${ref.one} tienen ${ref.many}` : `_${ref.fieldName}_ se refiere a un registro de ${ref.one}`;
-                    break;
+            // Only output relations that involve tables not excluded (or if arg to include referenced tables is present)
+            if(args.includeReferencedTables || tables.has(ref.one) && tables.has(ref.many)) {                
+                const one = toMermaidId(ref.one);
+                const many = toMermaidId(ref.many);
+                const left = '|o';
+                const right = (ref.required ? '|' : 'o') + '{';
+                const msgType = references.some(r => r.one === ref.one && r.many === ref.many) ? "hasMany" : "isOf"
+                let msg = "";
+                switch (args.labels) {
+                    case "en":
+                        msg = msgType == "hasMany" ? `${ref.one} have many ${ref.many}` : `_${ref.fieldName}_ is one of ${ref.one}`;
+                        break;
+                    case "pt":
+                        msg = msgType == "hasMany" ? `${ref.one} têm ${ref.many}` : `_${ref.fieldName}_ refere um registo de ${ref.one}`;
+                        break;
+                    case "es":
+                        msg = msgType == "hasMany" ? `${ref.one} tienen ${ref.many}` : `_${ref.fieldName}_ se refiere a un registro de ${ref.one}`;
+                        break;
+                }
+    
+                console.debug(`\t${one} ${left}..${right} ${many}: " ${msg}"`)
             }
-
-            console.debug(`\t${one} ${left}..${right} ${many}: " ${msg}"`)
         }
-
     } catch(err) {
         console.error("\n",err.message);
     }
@@ -76,9 +74,7 @@ async function readDefsFromDisk(dir, filter, debug) {
     const defFiles = await fg([`${dir}/*.json`]);
     return defFiles
         .map((f) => JSON.parse(fs.readFileSync(f)))
-        .filter(def => {
-            return !filter || def.name.match(filter) || def.description?.match(filter)
-        })
+        .filter(def => relevant(def,filter))
 }
 
 async function readDefsFromServer(server, filter, debug) {
@@ -97,9 +93,8 @@ async function readDefsFromServer(server, filter, debug) {
     })).data
     if(debug) console.error('found a total of ', defs.length, 'Defs');
     // filter
-    if(filter) defs = defs.filter(def => {
-        return def.name.match(filter) || def.description?.match(filter)
-    })
+    defs = defs.filter(def => relevant(def,filter))
+
     if(debug) console.error('filtered to ', defs.length, 'Defs');
     return await Promise.all(defs.map(async (def) => {
         return (await axios.get(`https://${server}/recordm/recordm/definitions/${def.id}`,{
@@ -129,7 +124,6 @@ function getRefs(defName, fieldDefs, debug) {
                 many: defName,
                 fieldName: fd.name,
                 required: !!fd.required,
-                duplicable: !!fd.duplicable
             });
         }
         if (fd.fields) acc.push(...getRefs(defName, fd.fields));
@@ -144,7 +138,6 @@ function getReferences(defName, fieldDefs, debug) {
             acc.push({
                 one: defName,
                 many: fd.configuration.keys.References.args.definition,
-                duplicable: true
             });
         }
         if (fd.fields) acc.push(...getReferences(defName, fd.fields));
@@ -166,3 +159,17 @@ function uniqBy(a, key) {
         return seen.has(k) ? false : seen.add(k);
     });
 }
+
+function relevant(def,filter) {
+    return !filter 
+        || filter
+        .split(" ")
+        .every( filterPart => {
+            if(filterPart.startsWith("-")) {
+                filterPart = filterPart.substring(1)
+                return !def.name.match(filterPart) && !def.description?.match(filterPart)  
+            } else {
+                return def.name.match(filterPart) || def.description?.match(filterPart)
+            }
+        })
+}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "cob-cli",
-  "version": "2.40.0",
+  "version": "2.41.0",
   "description": "A command line utility to help Cult of Bits partners develop with higher speed and reusing common code and best practices.",
   "preferGlobal": true,
   "repository": {