@loopback/cli 4.0.0-alpha.7 → 4.0.0

package/{generators/project/templates/LICENSE → LICENSE}

@@ -1,4 +1,5 @@
-Node module: <%= project.name %>
+Copyright (c) IBM Corp. 2017,2019.
+Node module: @loopback/cli
 This project is licensed under the MIT License, full text below.
 
 --------

package/README.md

@@ -1,69 +1,70 @@
 # @loopback/cli
 
-This module contains the experimental CLI for LoopBack 4.
+This module contains the official CLI for LoopBack 4.
 
 ## Installation
 
 Run the following command to install the CLI.
 
-`npm install -g @loopback/cli`
-
-## Usage
+```
+$ npm install -g @loopback/cli
+```
 
-1. To scaffold a LoopBack 4 application
+## Basic Use
 
-    `lb4 app`
+Run `lb4 --commands` or `lb4 -l` to list all available commands:
 
 ```
-Usage:
-  lb4 app [options] [<name>]
-
-Options:
-  -h,   --help             # Print the generator's options and usage
-        --skip-cache       # Do not remember prompt answers              Default: false
-        --skip-install     # Do not automatically install dependencies   Default: false
-        --applicationName  # Application name
-        --description      # Description for the application
-        --outdir           # Project root directory for the application
-        --tslint           # Enable tslint
-        --prettier         # Enable prettier
-        --mocha            # Enable mocha
-        --loopbackBuild    # Use @loopback/build
-
-Arguments:
-  name  # Project name for the application  Type: String  Required: false
+$ lb4 -l
 ```
 
-2. To scaffold a LoopBack 4 extension
+Use the option `--help` to learn more about any specific command:
+
+```
+$ lb4 model --help
+```
 
-    `lb4 extension`
+Run `lb4` or `lb4 app` to scaffold a new LoopBack 4 project.
 
 ```
-Usage:
-  lb4 extension [options] [<name>]
-
-Options:
-  -h,   --help           # Print the generator's options and usage
-        --skip-cache     # Do not remember prompt answers             Default: false
-        --skip-install   # Do not automatically install dependencies  Default: false
-        --description    # Description for the extension
-        --outdir         # Project root directory for the extension
-        --tslint         # Enable tslint
-        --prettier       # Enable prettier
-        --mocha          # Enable mocha
-        --loopbackBuild  # Use @loopback/build
-        --componentName  # Component name
+$ lb4 app
+? Project name: my-awesome-app
+(etc.)
+```
+
+Use `lb4 --version` (or `lb4 -v`) to print out version information to include in
+bug reports, for example:
 
 ```
+$ lb4 -v
+@loopback/cli version: 1.8.1
+
+@loopback/* dependencies:
+  - @loopback/authentication: ^1.0.14
+  - @loopback/boot: ^1.0.14
+  - @loopback/build: ^1.3.1
+  - @loopback/context: ^1.6.0
+  - @loopback/core: ^1.1.7
+  - (etc.)
+```
+
+See [CLI reference](https://loopback.io/doc/en/lb4/Command-line-interface.html)
+for a detailed documentation.
+
+## Contributions
+
+- [Guidelines](https://github.com/loopbackio/loopback-next/blob/master/docs/CONTRIBUTING.md)
+- [Join the team](https://github.com/loopbackio/loopback-next/issues/110)
 
-# Tests
+## Tests
 
 run `npm test` from the root folder.
 
-# Contributors
+## Contributors
 
-See [all contributors](https://github.com/strongloop/loopback-next/graphs/contributors).
+See
+[all contributors](https://github.com/loopbackio/loopback-next/graphs/contributors).
 
-# License
+## License
 
 MIT

package/bin/cli-main.js

@@ -0,0 +1,61 @@
+#!/usr/bin/env node
+// Copyright IBM Corp. 2018,2020. All Rights Reserved.
+// Node module: @loopback/cli
+// This file is licensed under the MIT License.
+// License text available at https://opensource.org/licenses/MIT
+
+'use strict';
+
+const pkg = require('../package.json');
+const semver = require('semver');
+const fs = require('fs-extra');
+const path = require('path');
+const chalk = require('chalk');
+
+const {
+  tabCompletionCommands,
+  runTabCompletionCommand,
+} = require('../lib/tab-completion');
+
+// Make sure node version meets the requirement. This code intentionally only
+// uses ES5 features so that it can be run with lower versions of Node
+// to report the version requirement.
+const nodeVer = process.versions.node;
+const requiredVer = pkg.engines.node;
+const ok = semver.satisfies(nodeVer, requiredVer);
+if (!ok) {
+  const format =
+    'Node.js "%s" is not supported. Please use a version that satisfies "%s".';
+  console.warn(chalk.red(format), nodeVer, requiredVer);
+}
+
+// Intentionally have a separate `main.js` which can use JS features
+// supported by required version of Node
+const minimist = require('minimist');
+const opts = minimist(process.argv.slice(2), {
+  alias: {
+    version: 'v', // --version or -v: print versions
+    commands: 'l', // --commands or -l: print commands
+    help: 'h', // --help or -h: help
+  },
+});
+
+const args = opts._;
+
+const originalCommand = args[0];
+if (tabCompletionCommands.includes(originalCommand)) {
+  const yoJsonFile = path.join(__dirname, '../.yo-rc.json');
+  const config = fs.readJsonSync(yoJsonFile);
+  return runTabCompletionCommand(config.commands, originalCommand, console.log);
+}
+
+const main = require('../lib/cli');
+const updateNotifier = require('update-notifier');
+// Force version check with `lb4 --version`
+const interval = opts.version ? 0 : undefined;
+updateNotifier({
+  pkg: pkg,
+  updateCheckInterval: interval,
+}).notify({isGlobal: true});
+
+main(opts);

package/generators/app/index.js

@@ -1,4 +1,4 @@
-// Copyright IBM Corp. 2017. All Rights Reserved.
+// Copyright IBM Corp. 2017,2020. All Rights Reserved.
 // Node module: @loopback/cli
 // This file is licensed under the MIT License.
 // License text available at https://opensource.org/licenses/MIT
@@ -6,73 +6,167 @@
 'use strict';
 const ProjectGenerator = require('../../lib/project-generator');
 const utils = require('../../lib/utils');
+const g = require('../../lib/globalize');
 
-module.exports = class extends ProjectGenerator {
+module.exports = class AppGenerator extends ProjectGenerator {
   // Note: arguments and options should be defined in the constructor.
   constructor(args, opts) {
     super(args, opts);
+    this.buildOptions.push({
+      name: 'docker',
+      description: g.f('include Dockerfile and .dockerignore'),
+    });
+    this.buildOptions.push({
+      name: 'repositories',
+      description: g.f('include repository imports and RepositoryMixin'),
+    });
+    this.buildOptions.push({
+      name: 'services',
+      description: g.f('include service-proxy imports and ServiceMixin'),
+    });
   }
 
   _setupGenerator() {
     this.projectType = 'application';
+
     this.option('applicationName', {
       type: String,
-      description: 'Application name',
+      description: g.f('Application class name'),
+    });
+
+    this.option('docker', {
+      type: Boolean,
+      description: g.f('Include Dockerfile and .dockerignore'),
     });
+
+    this.option('repositories', {
+      type: Boolean,
+      description: g.f('Include repository imports and RepositoryMixin'),
+    });
+
+    this.option('services', {
+      type: Boolean,
+      description: g.f('Include service-proxy imports and ServiceMixin'),
+    });
+
+    this.option('apiconnect', {
+      type: Boolean,
+      description: g.f('Include ApiConnectComponent'),
+    });
+
     return super._setupGenerator();
   }
 
-  setOptions() {
-    return super.setOptions();
+  async setOptions() {
+    await super.setOptions();
+    if (this.shouldExit()) return;
+    if (this.options.applicationName) {
+      const clsName = utils.toClassName(this.options.applicationName);
+      if (typeof clsName === 'string') {
+        this.projectInfo.applicationName = clsName;
+      } else if (clsName instanceof Error) {
+        throw clsName;
+      }
+      const msg = utils.validateClassName(clsName);
+      if (msg !== true) {
+        throw new Error(msg);
+      }
+    }
   }
 
   promptProjectName() {
+    if (this.shouldExit()) return;
     return super.promptProjectName();
   }
 
   promptProjectDir() {
+    if (this.shouldExit()) return;
     return super.promptProjectDir();
   }
 
   promptApplication() {
+    if (this.shouldExit()) return;
     const prompts = [
       {
         type: 'input',
         name: 'applicationName',
-        message: 'Application class name:',
-        default: utils.toClassName(this.projectInfo.name) + 'Application',
+        message: g.f('Application class name:'),
+        default: utils.pascalCase(this.projectInfo.name) + 'Application',
+        validate: utils.validateClassName,
+        when: this.projectInfo.applicationName == null,
       },
     ];
 
     return this.prompt(prompts).then(props => {
-      Object.assign(this.projectInfo, props);
+      props.applicationName = utils.toClassName(props.applicationName);
+      if (typeof props.applicationName === 'string') {
+        this.projectInfo.applicationName = props.applicationName;
+      }
     });
   }
 
   promptOptions() {
+    if (this.shouldExit()) return;
     return super.promptOptions();
   }
 
+  promptYarnInstall() {
+    if (this.shouldExit()) return;
+    return super.promptYarnInstall();
+  }
+
+  buildAppClassMixins() {
+    if (this.shouldExit()) return;
+    const {repositories, services} = this.projectInfo || {};
+    if (!repositories && !services) return;
+
+    let appClassWithMixins = 'RestApplication';
+    if (repositories) {
+      appClassWithMixins = `RepositoryMixin(${appClassWithMixins})`;
+    }
+    if (services) {
+      appClassWithMixins = `ServiceMixin(${appClassWithMixins})`;
+    }
+
+    this.projectInfo.appClassWithMixins = appClassWithMixins;
+  }
+
   scaffold() {
-    return super.scaffold();
+    const result = super.scaffold();
+    if (this.shouldExit()) return result;
+
+    const {docker, repositories} = this.projectInfo || {};
+    if (!docker) {
+      this.fs.delete(this.destinationPath('Dockerfile'));
+      this.fs.delete(this.destinationPath('.dockerignore'));
+    }
+    if (!repositories) {
+      this.fs.delete(this.destinationPath('src/migrate.ts.ejs'));
+    }
+
+    return result;
   }
 
   install() {
     return super.install();
   }
 
-  end() {
+  async end() {
+    await super.end();
+    if (this.shouldExit()) return;
     this.log();
     this.log(
-      'Application %s is now created in %s.',
-      this.projectInfo.name,
-      this.projectInfo.outdir
+      g.f(
+        'Application %s was created in %s.',
+        this.projectInfo.name,
+        this.projectInfo.outdir,
+      ),
     );
     this.log();
-    this.log('Next steps:');
+    this.log(g.f('Next steps:'));
     this.log();
     this.log('$ cd ' + this.projectInfo.outdir);
-    this.log('$ npm start');
+    this.log(`$ ${this.options.packageManager || 'npm'} start`);
     this.log();
   }
 };

package/generators/app/templates/.dockerignore

@@ -0,0 +1,5 @@
+node_modules
+npm-debug.log
+/dist
+# Cache used by TypeScript's incremental build
+*.tsbuildinfo

package/generators/app/templates/Dockerfile

@@ -0,0 +1,28 @@
+# Check out https://hub.docker.com/_/node to select a new base image
+FROM node:16-slim
+
+# Set to a non-root built-in user `node`
+USER node
+
+# Create app directory (with user `node`)
+RUN mkdir -p /home/node/app
+
+WORKDIR /home/node/app
+
+# Install app dependencies
+# A wildcard is used to ensure both package.json AND package-lock.json are copied
+# where available (npm@5+)
+COPY --chown=node package*.json ./
+
+RUN npm install
+
+# Bundle app source code
+COPY --chown=node . .
+
+RUN npm run build
+
+# Bind to all network interfaces so that it can be mapped to the host OS
+ENV HOST=0.0.0.0 PORT=3000
+
+EXPOSE ${PORT}
+CMD [ "node", "." ]

package/generators/app/templates/README.md.ejs

@@ -0,0 +1,130 @@
+# <%= project.name %>
+
+This application is generated using [LoopBack 4 CLI](https://loopback.io/doc/en/lb4/Command-line-interface.html) with the
+[initial project layout](https://loopback.io/doc/en/lb4/Loopback-application-layout.html).
+
+## Install dependencies
+
+By default, dependencies were installed when this application was generated.
+Whenever dependencies in `package.json` are changed, run the following command:
+
+<% if (packageManager === 'yarn') { -%>
+```sh
+yarn install
+```
+<% } else { -%>
+```sh
+npm install
+```
+
+To only install resolved dependencies in `package-lock.json`:
+
+```sh
+npm ci
+```
+<% } -%>
+
+## Run the application
+
+<% if (packageManager === 'yarn') { -%>
+```sh
+yarn start
+```
+<% } else { -%>
+```sh
+npm start
+```
+<% } -%>
+
+You can also run `node .` to skip the build step.
+
+Open http://127.0.0.1:3000 in your browser.
+
+## Rebuild the project
+
+To incrementally build the project:
+
+<% if (packageManager === 'yarn') { -%>
+```sh
+yarn run build
+```
+<% } else { -%>
+```sh
+npm run build
+```
+<% } -%>
+
+To force a full build by cleaning up cached artifacts:
+
+<% if (packageManager === 'yarn') { -%>
+```sh
+yarn run rebuild
+```
+<% } else { -%>
+```sh
+npm run rebuild
+```
+<% } -%>
+
+<% if (project.prettier || project.eslint) { -%>
+## Fix code style and formatting issues
+
+<% if (packageManager === 'yarn') { -%>
+```sh
+yarn run lint
+```
+<% } else { -%>
+```sh
+npm run lint
+```
+<% } -%>
+
+To automatically fix such issues:
+
+<% if (packageManager === 'yarn') { -%>
+```sh
+yarn run lint:fix
+```
+<% } else { -%>
+```sh
+npm run lint:fix
+```
+<% } -%>
+<% } -%>
+
+## Other useful commands
+
+<% if (packageManager === 'yarn') { -%>
+- `yarn run migrate`: Migrate database schemas for models
+- `yarn run openapi-spec`: Generate OpenAPI spec into a file
+<% if (project.docker) { -%>
+- `yarn run docker:build`: Build a Docker image for this application
+- `yarn run docker:run`: Run this application inside a Docker container
+<% } -%>
+<% } else { -%>
+- `npm run migrate`: Migrate database schemas for models
+- `npm run openapi-spec`: Generate OpenAPI spec into a file
+<% if (project.docker) { -%>
+- `npm run docker:build`: Build a Docker image for this application
+- `npm run docker:run`: Run this application inside a Docker container
+<% } -%>
+<% } -%>
+
+## Tests
+
+<% if (packageManager === 'yarn') { -%>
+```sh
+yarn test
+```
+<% } else { -%>
+```sh
+npm test
+```
+<% } -%>
+
+## What's next
+
+Please check out [LoopBack 4 documentation](https://loopback.io/doc/en/lb4/) to
+understand how you can continue to add features to this application.
+
+[![LoopBack](https://github.com/loopbackio/loopback-next/raw/master/docs/site/imgs/branding/Powered-by-LoopBack-Badge-(blue)-@2x.png)](http://loopback.io/)

package/generators/app/templates/public/index.html.ejs

@@ -0,0 +1,88 @@
+<!DOCTYPE html>
+<html lang="en">
+
+<head>
+  <title><%= project.description %></title>
+
+  <meta charset="utf-8">
+  <meta http-equiv="X-UA-Compatible" content="IE=edge">
+  <meta name="viewport" content="width=device-width, initial-scale=1">
+  <link rel="shortcut icon" type="image/x-icon" href="https://loopback.io/favicon.ico">
+
+  <style>
+    h3 {
+      margin-left: 25px;
+      text-align: center;
+    }
+
+    a, a:visited {
+      color: #3f5dff;
+    }
+
+    h3 a {
+      margin-left: 10px;
+    }
+
+    a:hover, a:focus, a:active {
+      color: #001956;
+    }
+
+    .power {
+      position: absolute;
+      bottom: 25px;
+      left: 50%;
+      transform: translateX(-50%);
+    }
+
+    .info {
+      position: absolute;
+      top: 50%;
+      left: 50%;
+      transform: translate(-50%, -50%)
+    }
+
+    .info h1 {
+      text-align: center;
+      margin-bottom: 0;
+    }
+
+    .info p {
+      text-align: center;
+      margin-bottom: 3em;
+      margin-top: 1em;
+    }
+
+    @media (prefers-color-scheme: dark) {
+      body {
+        background-color: rgb(29, 30, 32);
+        color: white;
+      }
+
+      a, a:visited {
+        color: #4990e2;
+      }
+
+      a:hover, a:focus, a:active {
+        color: #2b78ff;
+      }
+    }
+  </style>
+</head>
+
+<body>
+  <div class="info">
+    <h1><%= project.name %></h1>
+    <p>Version <%= project.version || '1.0.0' %></p>
+
+    <h3>OpenAPI spec: <a href="./openapi.json">/openapi.json</a></h3>
+    <h3>API Explorer: <a href="./explorer">/explorer</a></h3>
+  </div>
+
+  <footer class="power">
+    <a href="https://loopback.io" target="_blank">
+      <img src="https://loopback.io/images/branding/powered-by-loopback/blue/powered-by-loopback-sm.png" />
+    </a>
+  </footer>
+</body>
+
+</html>

package/generators/app/templates/{test → src/__tests__}/README.md

@@ -1,4 +1,3 @@
 # Tests
 
 Please place your tests in this folder.
-

package/generators/app/templates/src/__tests__/acceptance/home-page.acceptance.ts.ejs

@@ -0,0 +1,31 @@
+import {Client} from '@loopback/testlab';
+import {<%= project.applicationName %>} from '../..';
+import {setupApplication} from './test-helper';
+
+describe('HomePage', () => {
+  let app: <%= project.applicationName %>;
+  let client: Client;
+
+  before('setupApplication', async () => {
+    ({app, client} = await setupApplication());
+  });
+
+  after(async () => {
+    await app.stop();
+  });
+
+  it('exposes a default home page', async () => {
+    await client
+      .get('/')
+      .expect(200)
+      .expect('Content-Type', /text\/html/);
+  });
+
+  it('exposes self-hosted explorer', async () => {
+    await client
+      .get('/explorer/')
+      .expect(200)
+      .expect('Content-Type', /text\/html/)
+      .expect(/<title>LoopBack API Explorer/);
+  });
+});

package/generators/app/templates/src/__tests__/acceptance/ping.controller.acceptance.ts.ejs

@@ -0,0 +1,21 @@
+import {Client, expect} from '@loopback/testlab';
+import {<%= project.applicationName %>} from '../..';
+import {setupApplication} from './test-helper';
+
+describe('PingController', () => {
+  let app: <%= project.applicationName %>;
+  let client: Client;
+
+  before('setupApplication', async () => {
+    ({app, client} = await setupApplication());
+  });
+
+  after(async () => {
+    await app.stop();
+  });
+
+  it('invokes GET /ping', async () => {
+    const res = await client.get('/ping?msg=world').expect(200);
+    expect(res.body).to.containEql({greeting: 'Hello from LoopBack'});
+  });
+});