feat(cli): improve scaffolding of complex model settings

Leverage stringify-object package to convert model settings object
into well-formatted TypeScript source code.

An example of a simple settings object:

    @model({settings: {strict: false}})
    export class MyModel extends Entity {
      // ...
    }

A more complex example:

    @model({
      settings: {
        annotations: [{destinationClass: 'class1', argument: 0}],
        foreignKeys: {fk_destination: {name: 'fk_destination'}},
        strict: false
      }
    })
    export class MyModel extends Entity {
      // ...
    }

Signed-off-by: Miroslav Bajtoš <mbajtoss@gmail.com>
Co-Authored-By: yanamg7 <Y.Agapeyev@F5.com>

Author: bajtos

packages/cli/generators/model/index.js

@@ -14,6 +14,7 @@ const inspect = require('util').inspect;
 const utils = require('../../lib/utils');
 const chalk = require('chalk');
 const path = require('path');
+const stringifyObject = require('stringify-object');
 
 const PROMPT_BASE_MODEL_CLASS = 'Please select the model base class';
 const ERROR_NO_MODELS_FOUND = 'Model was not found in';
@@ -513,6 +514,17 @@ module.exports = class ModelGenerator extends ArtifactGenerator {
       }
     });
 
+    if (this.artifactInfo.modelSettings) {
+      this.artifactInfo.modelSettings = stringifyObject(
+        {settings: this.artifactInfo.modelSettings},
+        {
+          indent: '  ', // two spaces
+          singleQuotes: true,
+          inlineCharacterLimit: 80,
+        },
+      );
+    }
+
     this.copyTemplatedFiles(
       this.templatePath(MODEL_TEMPLATE_PATH),
       tsPath,

packages/cli/generators/model/templates/model.ts.ejs

@@ -5,8 +5,8 @@ import {model, property} from '@loopback/repository';
 import {<%= modelBaseClass %>} from '.';
 <% } -%>
 
-<% if(Object.keys(modelSettings).length > 0) { -%>
-@model({settings: <%- JSON.stringify(modelSettings) %>})
+<% if (modelSettings) { -%>
+@model(<%- modelSettings %>)
 <% } else { -%>
 @model()
 <% } -%>

packages/cli/package-lock.json

@@ -54,6 +54,7 @@
     "pluralize": "^7.0.0",
     "regenerate": "^1.3.3",
     "semver": "^6.0.0",
+    "stringify-object": "^3.3.0",
     "swagger-parser": "^6.0.5",
     "swagger2openapi": "^5.1.0",
     "typescript": "^3.1.1",

packages/cli/package.json

@@ -192,7 +192,7 @@ describe('lb4 model integration', () => {
       );
       assert.fileContent(
         expectedModelFile,
-        /@model\({settings: {"strict":false}}\)/,
+        /@model\({settings: {strict: false}}\)/,
       );
       assert.fileContent(
         expectedModelFile,
@@ -237,4 +237,28 @@ describe('model generator using --config option', () => {
         ]),
     ).to.be.rejectedWith(/Model was not found in/);
   });
+
+  describe('model generator using --config option with model settings', () => {
+    it('creates a model with valid settings', async () => {
+      await testUtils
+        .executeGenerator(generator)
+        .inDir(SANDBOX_PATH, () => testUtils.givenLBProject(SANDBOX_PATH))
+        .withArguments([
+          '--config',
+          '{"name":"test", "base":"Entity", \
+          "modelSettings": {"annotations": \
+          [{"destinationClass": "class1","argument": 0}],\
+          "foreignKeys": {"fk_destination": {"name": "fk_destination"}}},\
+          "allowAdditionalProperties":true}',
+          '--yes',
+        ]);
+
+      basicModelFileChecks(expectedModelFile, expectedIndexFile);
+
+      assert.fileContent(
+        expectedModelFile,
+        /@model\({\n  settings: {\n    annotations: \[{destinationClass: 'class1', argument: 0}],\n    foreignKeys: {fk_destination: {name: 'fk_destination'}},\n    strict: false\n  }\n}\)/,
+      );
+    });
+  });
 });