feat: Annotated categories, roles, state-machines, etc with name of blueprint they came from

Author: jezhiggins

lib/actions/add-role/index.js

@@ -1,7 +1,7 @@
 const c = require('ansi-colors')
 const Blueprint = require('../blueprint')
 const nameLabelDescription = require('../util/name-label-and-description')
-const ask = require('../util/ask')
+const chooseRoles = require('../util/choose-roles')
 
 async function addRole (options) {
   const blueprint = Blueprint.load(options)
@@ -30,18 +30,15 @@ async function selectRoles (blueprint) {
     return
   }
 
-  const selectedRoles = await ask({
-    type: 'autocomplete',
-    multiple: true,
-    message: 'Roles this new role is a member of',
-    hint: '(Use <space> to select, <return> to submit)',
-    sort: true,
-    choices: roles.map(m => m.label)
-  })
+  const selectedRoles = await chooseRoles(
+    blueprint,
+    {
+      message: 'Roles this new role is a member of',
+      includeBuiltIn: false
+    }
+  )
 
-  return roles
-    .filter(r => selectedRoles.includes(r.label))
-    .map(r => r.name)
+  return selectedRoles
 } // selectRoles
 
 module.exports = addRole

lib/actions/add-search-doc/index.js

@@ -17,7 +17,7 @@ async function addSearchDoc (options) {
 
   const category = await chooseCategory(blueprint, model.name)
 
-  const roles = await chooseRoles(blueprint, '$everyone')
+  const roles = await chooseRoles(blueprint, { suggested: '$everyone' })
 
   const launches = await chooseLaunches(blueprint)
 

lib/actions/add-state-machine/index.js

@@ -65,7 +65,7 @@ async function selectForm (blueprint) {
   const forms = blueprint.forms()
 
   if (forms.length === 0) {
-    console.log(c.bold.red('Blueprint has no models to scaffold a form against'))
+    console.log(c.bold.red('Blueprint has no forms against'))
     return
   }
 

lib/actions/blueprint.js

@@ -41,28 +41,24 @@ class Blueprint {
       }
     })
 
-    this.uses.forEach(b => {
-      const extras = b.models()
-      extras.forEach(e => { if(!e.parent) e.parent = b.name })
-      models.push(...extras)
-    })
-
-    return models
-  }
+    return grabExtras(models, this.uses, 'models')
+  } // models
 
   forms () {
     const names = listJsonFiles(this.path, 'card-templates')
-    return names.map(n => {
+    const forms = names.map(n => {
       return {
         name: n,
         meta: formMeta(this.path, 'card-templates', `${n}.json`)
       }
     })
+
+    return grabExtras(forms, this.uses, 'forms')
   } // forms
 
   stateMachines () {
     const names = listJsonFiles(this.path, 'state-machines')
-    return names.map(name => {
+    const machines = names.map(name => {
       const details = readJson(this.path, 'state-machines', `${name}.json`)
 
       const parts = [
@@ -76,6 +72,8 @@ class Blueprint {
         .map(p => p.replace('.', '_'))
         .join('_')
     })
+
+    return grabExtras(machines, this.uses, 'stateMachines')
   } // stateMachines
 
   categories () {
@@ -87,10 +85,10 @@ class Blueprint {
         ...details
       }
     })
-    return cats
+    return grabExtras(cats, this.uses, 'categories')
   }
 
-  roles (includeBuiltin = true) {
+  roles (includeBuiltin = false) {
     const names = listJsonFiles(this.path, 'template-roles')
     const roles = names.map(n => {
       const details = readJson(this.path, 'template-roles', `${n}.json`)
@@ -99,6 +97,7 @@ class Blueprint {
         ...details
       }
     })
+    grabExtras(roles, this.uses, 'roles')
     if (includeBuiltin) {
       roles.unshift({
         name: '$everyone',
@@ -127,6 +126,16 @@ class Blueprint {
   get scaffold () { return this.scaffold_ }
 }
 
+function grabExtras (target, uses, fn) {
+  uses.forEach(b => {
+    const extras = b[fn]()
+    extras.forEach(e => { if (!e.parent) e.parent = b.name })
+    target.push(...extras)
+  })
+  return target
+}
+
+
 function listJsonFiles (basepath, directory) {
   if (!isDir(basepath, directory)) return []
 

lib/actions/util/choose-categories.js

@@ -26,7 +26,7 @@ async function chooseCategories (blueprint) {
       return {
         name: c.name,
         message: c.label,
-        hint: c.description,
+        hint: `${c.description} ${c.parent ? '(' + c.parent + ')' : ''}`,
         value: c.name
       }
     })

lib/actions/util/choose-category.js

@@ -24,7 +24,7 @@ async function chooseCategory (blueprint, suggestion) {
       return {
         name: c.name,
         message: c.label,
-        hint: c.description,
+        hint: `${c.description} ${c.parent ? '(' + c.parent + ')' : ''}`,
         value: c.name
       }
     })

lib/actions/util/choose-roles.js

@@ -1,8 +1,14 @@
 const c = require('ansi-colors')
 const ask = require('./ask')
 
-async function chooseRoles (blueprint, suggested = '$authenticated') {
-  const roles = blueprint.roles()
+async function chooseRoles (
+  blueprint,
+  options = {
+    includeBuiltIn: true
+  }) {
+
+  const suggested = options.suggested || '$authenticated'
+  const roles = blueprint.roles(options.includeBuiltIn)
 
   if (roles.length === 0) {
     console.log(c.bold.red('Blueprint has no roles defined'))
@@ -17,12 +23,13 @@ async function chooseRoles (blueprint, suggested = '$authenticated') {
   const cats = await ask({
     type: 'autocomplete',
     multiple: true,
-    message: 'Select roles',
+    message: options.message || 'Select roles',
+    sort: true,
     choices: roles.map(r => {
       return {
         name: r.name,
         message: r.label,
-        hint: r.description,
+        hint: `${r.description} ${r.parent ? '(' + r.parent + ')' : ''}`,
         value: r.name
       }
     })