feat: Add-Editable solicits edit field title

Suggests title from model schema if available, otherwise generates it from field name

Author: jezhiggins

lib/actions/add-editable/index.js

@@ -4,6 +4,7 @@ const Blueprint = require('../blueprint')
 const validator = require('../../util/validators')
 const path = require('path')
 const fs = require('fs-extra')
+const _ = require('lodash')
 
 async function addEditable (options) {
   const blueprint = Blueprint.load(options)
@@ -14,7 +15,7 @@ async function addEditable (options) {
     return
   }
 
-  const fields = await selectFields(model.fields)
+  const fields = await selectFields(model.fields, model.schema.properties)
   const filename = await chooseFilename(`${model.name}-editing-form`)
 
   const scaffold = blueprint.scaffold
@@ -28,11 +29,9 @@ async function addEditable (options) {
 } // addEditable
 
 async function selectModel (blueprint, modelPath) {
-  if (modelPath) {
-    return loadExternalModel(modelPath)
-  }
+  const model = modelPath ? loadExternalModel(modelPath) : await selectInternalModel(blueprint)
 
-  return selectInternalModel(blueprint)
+  return model
 } // selectInternalModel
 
 function loadExternalModel (modelPath) {
@@ -42,8 +41,8 @@ function loadExternalModel (modelPath) {
 
   const name = path.basename(modelPath, path.extname(modelPath))
   const schema = fs.readJsonSync(modelPath)
-  const fields = schema.properties
-  console.log(c.bold(`Loading model ${c.cyan(name)}`))
+  const fields = Object.keys(schema.properties)
+  console.log(c.bold(`Loading external model ${c.cyan(name)}`))
   return {
     name,
     schema,
@@ -74,7 +73,7 @@ async function selectInternalModel (blueprint) {
   return models.find(m => m.name === modelName)
 } // selectModel
 
-async function selectFields (propertyNames) {
+async function selectFields (propertyNames, properties) {
   const allProperties = await ask({
     type: 'confirm',
     name: 'all',
@@ -83,6 +82,7 @@ async function selectFields (propertyNames) {
   })
 
   if (allProperties) {
+    Object.entries(properties).forEach(([p, v]) => v.title = suggestedTitle(p, v.title))
     return null
   }
 
@@ -95,11 +95,23 @@ async function selectFields (propertyNames) {
       initial: true
     })) {
       fields.push(property)
+      properties[property].title = await ask({
+        type: 'input',
+        name: 'field',
+        message: 'Field title',
+        initial: suggestedTitle(property, properties[property].title),
+        validate: validator.notEmpty()
+      })
     }
   }
   return fields
 } // selectFields
 
+function suggestedTitle (name, title) {
+  if (title) return title
+  return _.upperFirst(_.lowerCase(name))
+}
+
 async function chooseFilename (defaultFilename) {
   const suffix = '.json'
   const filenameQuestion = {

lib/actions/blueprint.js

@@ -31,13 +31,19 @@ class Blueprint {
       .map(f => f.replace('.json', ''))
     names.sort()
     return names.map(n => {
+      const schema = this.modelProperties(n)
       return {
         name: n,
-        fields: this.modelPropertyNames(n)
+        fields: Object.keys(schema.properties),
+        schema: schema
       }
     })
   }
 
+  modelProperties (modelName) {
+    return this.scaffold.loadModel(modelName)
+  }
+
   modelPropertyNames (modelName) {
     return Object.keys(this.scaffold.loadModel(modelName).properties)
   }

test/add-editable-test.js

@@ -20,10 +20,13 @@ describe('tymly add-editable', () => {
       helpers.down,
       'N',
       '',
+      '', // generated title
       '',
+      '', // use title from model
       'N',
       '',
-      ''
+      'Is it vegetarian?', // provide title
+      '' // take selected filename
     ],
     'set-file-name': [
       'Y',

test/fixtures/add-editable/expected/one-model/card-templates/pizza-editing-form.json

@@ -10,7 +10,8 @@
     },
     {
       "id": "code",
-      "type": "Input.Text"
+      "type": "Input.Text",
+      "title": "Code"
     },
     {
       "id": "label",
@@ -19,11 +20,13 @@
     },
     {
       "id": "popularitySeq",
-      "type": "Input.Number"
+      "type": "Input.Number",
+      "title": "Popularity seq"
     },
     {
       "id": "vegetarian",
-      "type": "Input.Toggle"
+      "type": "Input.Toggle",
+      "title": "Vegetarian"
     }
   ],
   "actions": [

test/fixtures/add-editable/expected/path-to-external-model/card-templates/drinks-editing-form.json

@@ -10,7 +10,8 @@
     },
     {
       "id": "code",
-      "type": "Input.Text"
+      "type": "Input.Text",
+      "title": "Code"
     },
     {
       "id": "label",

test/fixtures/add-editable/expected/set-file-name/card-templates/the-pizza-form.json

@@ -10,7 +10,8 @@
     },
     {
       "id": "code",
-      "type": "Input.Text"
+      "type": "Input.Text",
+      "title": "Code"
     },
     {
       "id": "label",
@@ -19,11 +20,13 @@
     },
     {
       "id": "popularitySeq",
-      "type": "Input.Number"
+      "type": "Input.Number",
+      "title": "Popularity seq"
     },
     {
       "id": "vegetarian",
-      "type": "Input.Toggle"
+      "type": "Input.Toggle",
+      "title": "Vegetarian"
     }
   ],
   "actions": [

test/fixtures/add-editable/expected/two-models-choose-fields/card-templates/pizza-editing-form.json

@@ -10,7 +10,8 @@
     },
     {
       "id": "code",
-      "type": "Input.Text"
+      "type": "Input.Text",
+      "title": "Code"
     },
     {
       "id": "label",
@@ -19,7 +20,8 @@
     },
     {
       "id": "vegetarian",
-      "type": "Input.Toggle"
+      "type": "Input.Toggle",
+      "title": "Is it vegetarian?"
     }
   ],
   "actions": [

test/fixtures/add-editable/expected/two-models/card-templates/pizza-editing-form.json

@@ -10,7 +10,8 @@
     },
     {
       "id": "code",
-      "type": "Input.Text"
+      "type": "Input.Text",
+      "title": "Code"
     },
     {
       "id": "label",
@@ -19,11 +20,13 @@
     },
     {
       "id": "popularitySeq",
-      "type": "Input.Number"
+      "type": "Input.Number",
+      "title": "Popularity seq"
     },
     {
       "id": "vegetarian",
-      "type": "Input.Toggle"
+      "type": "Input.Toggle",
+      "title": "Vegetarian"
     }
   ],
   "actions": [