fix(cli): fix templates & move some utils to base generator

Author: raymondfeng

packages/cli/generators/controller/templates/src/controllers/controller-rest-template.ts.ejs

@@ -7,7 +7,7 @@ import {
   patch,
   del,
   requestBody
-} from '@loopback/openapi-v3';
+} from '@loopback/rest';
 import {<%= modelName %>} from '../models';
 import {<%= repositoryName %>} from '../repositories';
 

packages/cli/generators/controller/templates/src/controllers/controller-template.ts.ejs

@@ -1,6 +1,6 @@
 // Uncomment these imports to begin using these cool features!
 
-// import {inject} from @loopback/context;
+// import {inject} from '@loopback/context';
 
 
 export class <%= name %>Controller {

packages/cli/lib/artifact-generator.js

@@ -10,7 +10,6 @@ const utils = require('./utils');
 const updateIndex = require('./update-index');
 const path = require('path');
 const chalk = require('chalk');
-const StatusConflicter = utils.StatusConflicter;
 
 module.exports = class ArtifactGenerator extends BaseGenerator {
   // Note: arguments and options should be defined in the constructor.
@@ -36,41 +35,7 @@ module.exports = class ArtifactGenerator extends BaseGenerator {
       this.destinationPath(),
       this.artifactInfo.outDir,
     );
-    this.conflicter = new StatusConflicter(
-      this.env.adapter,
-      this.options.force,
-    );
-  }
-
-  /**
-   * Checks if current directory is a LoopBack project by checking for
-   * keyword 'loopback' under 'keywords' attribute in package.json.
-   * 'keywords' is an array
-   */
-  checkLoopBackProject() {
-    debug('Checking for loopback project');
-    if (this.shouldExit()) return false;
-    const pkg = this.fs.readJSON(this.destinationPath('package.json'));
-    const key = 'loopback';
-    if (!pkg) {
-      const err = new Error(
-        'No package.json found in ' +
-          this.destinationRoot() +
-          '. ' +
-          'The command must be run in a LoopBack project.',
-      );
-      this.exit(err);
-      return;
-    }
-    if (!pkg.keywords || !pkg.keywords.includes(key)) {
-      const err = new Error(
-        'No `loopback` keyword found in ' +
-          this.destinationPath('package.json') +
-          '. ' +
-          'The command must be run in a LoopBack project.',
-      );
-      this.exit(err);
-    }
+    super._setupGenerator();
   }
 
   promptArtifactName() {
@@ -111,7 +76,7 @@ module.exports = class ArtifactGenerator extends BaseGenerator {
   }
 
   async end() {
-    const success = super.end();
+    const success = await super.end();
     if (!success) return false;
 
     let generationStatus = true;
@@ -128,7 +93,7 @@ module.exports = class ArtifactGenerator extends BaseGenerator {
        *
        * Both those properties must be present for this to happen. Optionally,
        * this can be disabled even if the properties are present by setting:
-       * this.artifactInfo.disableIndexUdpdate = true;
+       * this.artifactInfo.disableIndexUpdate = true;
        */
       if (
         this.artifactInfo.outDir &&

packages/cli/lib/base-generator.js

@@ -4,24 +4,31 @@
 // License text available at https://opensource.org/licenses/MIT
 
 'use strict';
+
 const Generator = require('yeoman-generator');
 const chalk = require('chalk');
-
+const debug = require('./debug')('artifact-generator');
+const utils = require('./utils');
+const StatusConflicter = utils.StatusConflicter;
 /**
  * Base Generator for LoopBack 4
  */
 module.exports = class BaseGenerator extends Generator {
   // Note: arguments and options should be defined in the constructor.
   constructor(args, opts) {
     super(args, opts);
+    this.conflicter = new StatusConflicter(
+      this.env.adapter,
+      this.options.force,
+    );
     this._setupGenerator();
   }
 
   /**
    * Subclasses can extend _setupGenerator() to set up the generator
    */
   _setupGenerator() {
-    this.artifactInfo = {
+    this.artifactInfo = this.artifactInfo || {
       rootDir: 'src',
     };
   }
@@ -46,6 +53,37 @@ module.exports = class BaseGenerator extends Generator {
     this.exitGeneration = reason;
   }
 
+  /**
+   * Checks if current directory is a LoopBack project by checking for
+   * keyword 'loopback' under 'keywords' attribute in package.json.
+   * 'keywords' is an array
+   */
+  checkLoopBackProject() {
+    debug('Checking for loopback project');
+    if (this.shouldExit()) return false;
+    const pkg = this.fs.readJSON(this.destinationPath('package.json'));
+    const key = 'loopback';
+    if (!pkg) {
+      const err = new Error(
+        'No package.json found in ' +
+          this.destinationRoot() +
+          '. ' +
+          'The command must be run in a LoopBack project.',
+      );
+      this.exit(err);
+      return;
+    }
+    if (!pkg.keywords || !pkg.keywords.includes(key)) {
+      const err = new Error(
+        'No `loopback` keyword found in ' +
+          this.destinationPath('package.json') +
+          '. ' +
+          'The command must be run in a LoopBack project.',
+      );
+      this.exit(err);
+    }
+  }
+
   /**
    * Check if the generator should exit
    */

packages/cli/lib/update-index.js

@@ -6,7 +6,9 @@
 const path = require('path');
 const util = require('util');
 const fs = require('fs');
-const appendFileAsync = util.promisify(fs.appendFile);
+const appendFile = util.promisify(fs.appendFile);
+const readFile = util.promisify(fs.readFile);
+const exists = util.promisify(fs.exists);
 
 /**
  *
@@ -18,6 +20,14 @@ module.exports = async function(dir, file) {
   if (!file.endsWith('.ts')) {
     throw new Error(`${file} must be a TypeScript (.ts) file`);
   }
+
+  let index = '';
+  const indexExists = await exists(indexFile);
+  if (indexExists) {
+    index = await readFile(indexFile);
+  }
   const content = `export * from './${file.slice(0, -3)}';\n`;
-  await appendFileAsync(indexFile, content);
+  if (!index.includes(content)) {
+    await appendFile(indexFile, content);
+  }
 };