@loopback/cli 4.0.0-alpha.9 → 4.1.1

package/generators/project/templates/package.json.ejs

@@ -0,0 +1,175 @@
+{
+  "name": "<%= project.name -%>",
+  "version": "0.0.1",
+  "description": "<%= project.description -%>",
+  "keywords": [
+    "loopback-<%= project.projectType -%>",
+    "loopback"
+  ],
+<% if (project.private) { -%>
+  "private": true,
+<% } -%>
+  "main": "dist/index.js",
+  "types": "dist/index.d.ts",
+  "engines": {
+    "node": "14 || 16 || 17 || 18"
+  },
+  "scripts": {
+    "build": "lb-tsc",
+    "build:watch": "lb-tsc --watch",
+<% if (project.prettier && project.eslint) { -%>
+<% if (packageManager === 'yarn') { -%>
+    "lint": "yarn run eslint && yarn run prettier:check",
+    "lint:fix": "yarn run eslint:fix && yarn run prettier:fix",
+<% } else { -%>
+    "lint": "npm run eslint && npm run prettier:check",
+    "lint:fix": "npm run eslint:fix && npm run prettier:fix",
+<% } -%>
+<% } else if (project.prettier) { -%>
+<% if (packageManager === 'yarn') { -%>
+    "lint": "yarn run prettier:check",
+    "lint:fix": "yarn run prettier:fix",
+<% } else { -%>
+    "lint": "npm run prettier:check",
+    "lint:fix": "npm run prettier:fix",
+<% } -%>
+<% } else if (project.eslint) { -%>
+<% if (packageManager === 'yarn') { -%>
+    "lint": "yarn run eslint",
+    "lint:fix": "yarn run eslint:fix",
+<% } else { -%>
+    "lint": "npm run eslint",
+    "lint:fix": "npm run eslint:fix",
+<% } -%>
+<% } -%>
+<% if (project.prettier) { -%>
+    "prettier:cli": "lb-prettier \"**/*.ts\" \"**/*.js\"",
+<% if (packageManager === 'yarn') { -%>
+    "prettier:check": "yarn run prettier:cli -l",
+    "prettier:fix": "yarn run prettier:cli --write",
+<% } else { -%>
+    "prettier:check": "npm run prettier:cli -- -l",
+    "prettier:fix": "npm run prettier:cli -- --write",
+<% } -%>
+<% } -%>
+<% if (project.eslint) { -%>
+    "eslint": "lb-eslint --report-unused-disable-directives .",
+<% if (packageManager === 'yarn') { -%>
+    "eslint:fix": "yarn run eslint --fix",
+<% } else { -%>
+    "eslint:fix": "npm run eslint -- --fix",
+<% } -%>
+<% } -%>
+<% if (packageManager === 'yarn') { -%>
+    "pretest": "yarn run rebuild",
+<% } else { -%>
+    "pretest": "npm run rebuild",
+<% } -%>
+<% if (project.mocha) { -%>
+    "test": "lb-mocha --allow-console-logs \"dist/__tests__\"",
+<% } -%>
+<% if (project.prettier || project.eslint) { -%>
+<% if (packageManager === 'yarn') { -%>
+    "posttest": "yarn run lint",
+<% } else { -%>
+    "posttest": "npm run lint",
+<% } -%>
+<% } -%>
+<% if (project.mocha && (project.prettier || project.eslint)) { -%>
+<% if (packageManager === 'yarn') { -%>
+    "test:dev": "lb-mocha --allow-console-logs dist/__tests__/**/*.js && yarn run posttest",
+<% } else { -%>
+    "test:dev": "lb-mocha --allow-console-logs dist/__tests__/**/*.js && npm run posttest",
+<% } -%>
+<% } else if (project.mocha) { -%>
+    "test:dev": "lb-mocha --allow-console-logs dist/__tests__/**/*.js",
+<% } -%>
+<% if (project.projectType === 'application') { -%>
+<% if (project.docker) { -%>
+    "docker:build": "docker build -t <%= project.name -%> .",
+    "docker:run": "docker run -p 3000:3000 -d <%= project.name -%>",
+<% } -%>
+<% if (project.repositories && packageManager === 'yarn') { -%>
+    "premigrate": "yarn run build",
+<% } else if (project.repositories) { -%>
+    "premigrate": "npm run build",
+<% } -%>
+<% if (project.repositories) { -%>
+    "migrate": "node ./dist/migrate",
+<% } -%>
+<% if (packageManager === 'yarn') { -%>
+    "preopenapi-spec": "yarn run build",
+<% } else { -%>
+    "preopenapi-spec": "npm run build",
+<% } -%>
+    "openapi-spec": "node ./dist/openapi-spec",
+<% if (packageManager === 'yarn') { -%>
+    "prestart": "yarn run rebuild",
+<% } else { -%>
+    "prestart": "npm run rebuild",
+<% } -%>
+    "start": "node -r source-map-support/register .",
+<% } -%>
+    "clean": "lb-clean dist *.tsbuildinfo .eslintcache",
+<% if (packageManager === 'yarn') { -%>
+    "rebuild": "yarn run clean && yarn run build"
+<% } else { -%>
+    "rebuild": "npm run clean && npm run build"
+<% } -%>
+  },
+  "repository": {
+    "type": "git",
+    "url": ""
+  },
+<% if (author) { -%>
+  "author": "<%= author.name %> <<%= author.email %>>",
+<% } else { -%>
+  "author": "",
+<% } -%>
+  "license": "",
+  "files": [
+    "README.md",
+    "dist",
+    "src",
+    "!*/__tests__"
+  ],
+<% if (project.projectType === 'extension') { -%>
+  "peerDependencies": {
+    "@loopback/core": "<%= project.dependencies['@loopback/core'] -%>"
+  },
+<% } -%>
+  "dependencies": {
+<% if (project.projectType === 'application') { -%>
+    "@loopback/boot": "<%= project.dependencies['@loopback/boot'] -%>",
+    "@loopback/core": "<%= project.dependencies['@loopback/core'] -%>",
+<% if (project.repositories) { -%>
+    "@loopback/repository": "<%= project.dependencies['@loopback/repository'] -%>",
+<% } -%>
+<% if (project.apiconnect) { -%>
+    "@loopback/apiconnect": "<%= project.dependencies['@loopback/apiconnect'] -%>",
+<% } -%>
+    "@loopback/rest": "<%= project.dependencies['@loopback/rest'] -%>",
+<% if (project.services) { -%>
+    "@loopback/rest-explorer": "<%= project.dependencies['@loopback/rest-explorer'] -%>",
+    "@loopback/service-proxy": "<%= project.dependencies['@loopback/service-proxy'] -%>",
+<% } else { -%>
+    "@loopback/rest-explorer": "<%= project.dependencies['@loopback/rest-explorer'] -%>",
+<% } -%>
+<% } -%>
+    "tslib": "<%= project.dependencies['tslib'] -%>"
+  },
+  "devDependencies": {
+    "@loopback/build": "<%= project.dependencies['@loopback/build'] -%>",
+    "source-map-support": "<%= project.dependencies['source-map-support'] -%>",
+<% if (project.projectType === 'extension') { -%>
+    "@loopback/core": "<%= project.dependencies['@loopback/core'] -%>",
+<% } -%>
+    "@loopback/testlab": "<%= project.dependencies['@loopback/testlab'] -%>",
+    "@types/node": "<%= project.dependencies['@types/node'] -%>",
+<% if (project.eslint) { -%>
+    "@loopback/eslint-config": "<%= project.dependencies['@loopback/eslint-config'] -%>",
+    "eslint": "<%= project.dependencies['eslint'] -%>",
+<% } -%>
+    "typescript": "<%= project.dependencies['typescript'] -%>"
+  }
+}

package/generators/project/templates/package.plain.json.ejs

@@ -0,0 +1,176 @@
+{
+  "name": "<%= project.name -%>",
+  "version": "0.0.1",
+  "description": "<%= project.description -%>",
+  "keywords": [
+    "loopback-<%= project.projectType -%>",
+    "loopback"
+  ],
+<% if (project.private) { -%>
+  "private": true,
+<% } -%>
+  "main": "dist/index.js",
+  "types": "dist/index.d.ts",
+  "engines": {
+    "node": "14 || 16 || 17 || 18"
+  },
+  "scripts": {
+    "build": "tsc",
+    "build:watch": "tsc --watch",
+    "clean": "rimraf dist *.tsbuildinfo .eslintcache",
+<% if (project.prettier && project.eslint) { -%>
+<% if (packageManager === 'yarn') { -%>
+    "lint": "yarn run prettier:check && yarn run eslint",
+    "lint:fix": "yarn run eslint:fix && yarn run prettier:fix",
+<% } else { -%>
+    "lint": "npm run prettier:check && npm run eslint",
+    "lint:fix": "npm run eslint:fix && npm run prettier:fix",
+<% } -%>
+<% } else if (project.prettier) { -%>
+<% if (packageManager === 'yarn') { -%>
+    "lint": "yarn run prettier:check",
+    "lint:fix": "yarn run prettier:fix",
+<% } else { -%>
+    "lint": "npm run prettier:check",
+    "lint:fix": "npm run prettier:fix",
+<% } -%>
+<% } else if (project.eslint) { -%>
+<% if (packageManager === 'yarn') { -%>
+    "lint": "yarn run eslint",
+    "lint:fix": "yarn run eslint:fix",
+<% } else { -%>
+    "lint": "npm run eslint",
+    "lint:fix": "npm run eslint:fix",
+<% } -%>
+<% } -%>
+<% if (project.prettier) { -%>
+    "prettier:cli": "prettier \"**/*.ts\" \"**/*.js\"",
+<% if (packageManager === 'yarn') { -%>
+    "prettier:check": "yarn run prettier:cli -l",
+    "prettier:fix": "yarn run prettier:cli --write",
+<% } else { -%>
+    "prettier:check": "npm run prettier:cli -- -l",
+    "prettier:fix": "npm run prettier:cli -- --write",
+<% } -%>
+<% } -%>
+<% if (project.eslint) { -%>
+    "eslint": "eslint .",
+<% if (packageManager === 'yarn') { -%>
+    "eslint:fix": "yarn run eslint --fix",
+<% } else { -%>
+    "eslint:fix": "npm run eslint -- --fix",
+<% } -%>
+<% } -%>
+<% if (packageManager === 'yarn') { -%>
+    "pretest": "yarn run rebuild",
+<% } else { -%>
+    "pretest": "npm run rebuild",
+<% } -%>
+<% if (project.mocha) { -%>
+    "test": "mocha dist/__tests__",
+<% } -%>
+<% if (project.prettier || project.eslint) { -%>
+<% if (packageManager === 'yarn') { -%>
+    "posttest": "yarn run lint",
+<% } else { -%>
+    "posttest": "npm run lint",
+<% } -%>
+<% } -%>
+<% if (project.mocha && (project.prettier || project.eslint)) { -%>
+<% if (packageManager === 'yarn') { -%>
+    "test:dev": "mocha dist/__tests__/**/*.js && yarn run posttest",
+<% } else { -%>
+    "test:dev": "mocha dist/__tests__/**/*.js && npm run posttest",
+<% } -%>
+<% } else if (project.mocha) { -%>
+    "test:dev": "mocha dist/__tests__/**/*.js",
+<% } -%>
+<% if (project.projectType === 'application') { -%>
+<% if (project.docker) { -%>
+    "docker:build": "docker build -t <%= project.name -%> .",
+    "docker:run": "docker run -p 3000:3000 -d <%= project.name -%>",
+<% } -%>
+<% if (project.repositories) { -%>
+    "migrate": "node ./dist/migrate",
+<% } -%>
+    "openapi-spec": "node ./dist/openapi-spec",
+<% if (packageManager === 'yarn') { -%>
+    "prestart": "yarn run rebuild",
+<% } else { -%>
+    "prestart": "npm run rebuild",
+<% } -%>
+    "start": "node -r source-map-support/register .",
+<% } -%>
+<% if (packageManager === 'yarn') { -%>
+    "prepare": "yarn run build",
+<% } else { -%>
+    "prepare": "npm run build",
+<% } -%>
+<% if (packageManager === 'yarn') { -%>
+  "rebuild": "yarn run clean && yarn run build"
+<% } else { -%>
+  "rebuild": "npm run clean && npm run build"
+<% } -%>
+  },
+  "repository": {
+    "type": "git"
+  },
+<% if (author) { -%>
+  "author": "<%= author.name %> <<%= author.email %>>",
+<% } else { -%>
+  "author": "",
+<% } -%>
+  "license": "",
+  "files": [
+    "README.md",
+    "dist",
+    "src",
+    "!*/__tests__"
+  ],
+<% if (project.projectType === 'extension') { -%>
+  "peerDependencies": {
+    "@loopback/core": "<%= project.dependencies['@loopback/core'] -%>"
+  },
+<% } -%>
+  "dependencies": {
+<% if (project.projectType === 'application') { -%>
+    "@loopback/boot": "<%= project.dependencies['@loopback/boot'] -%>",
+    "@loopback/core": "<%= project.dependencies['@loopback/core'] -%>",
+<% if (project.repositories) { -%>
+    "@loopback/repository": "<%= project.dependencies['@loopback/repository'] -%>",
+<% } -%>
+<% if (project.apiconnect) { -%>
+    "@loopback/apiconnect": "<%= project.dependencies['@loopback/apiconnect'] -%>",
+<% } -%>
+    "@loopback/rest": "<%= project.dependencies['@loopback/rest'] -%>",
+    "@loopback/rest-explorer": "<%= project.dependencies['@loopback/rest-explorer'] -%>",
+<% } -%>
+<% if (project.services) { -%>
+    "@loopback/service-proxy": "<%= project.dependencies['@loopback/service-proxy'] -%>",
+<% } -%>
+    "tslib": "<%= project.dependencies['tslib'] -%>"
+  },
+  "devDependencies": {
+    "rimraf": "<%= project.dependencies['rimraf'] -%>",
+    "source-map-support": "<%= project.dependencies['source-map-support'] -%>",
+<% if (project.projectType === 'extension') { -%>
+    "@loopback/core": "<%= project.dependencies['@loopback/core'] -%>",
+<% } -%>
+    "@loopback/testlab": "<%= project.dependencies['@loopback/testlab'] -%>",
+<% if (project.mocha) { -%>
+    "@types/mocha": "<%= project.dependencies['@types/mocha'] -%>",
+<% } -%>
+    "@types/node": "<%= project.dependencies['@types/node'] -%>",
+<% if (project.mocha) { -%>
+    "mocha": "<%= project.dependencies['mocha'] -%>",
+<% } -%>
+<% if (project.prettier) { -%>
+    "prettier": "<%= project.dependencies['prettier'] -%>",
+<% } -%>
+<% if (project.eslint) { -%>
+    "@loopback/eslint-config": "<%= project.dependencies['@loopback/eslint-config'] -%>",
+    "eslint": "<%= project.dependencies['eslint'] -%>",
+<% } -%>
+    "typescript": "<%= project.dependencies['typescript'] -%>"
+  }
+}

package/generators/project/templates/tsconfig.json.ejs

@@ -0,0 +1,39 @@
+{
+  "$schema": "http://json.schemastore.org/tsconfig",
+<% if (project.loopbackBuild) { -%>
+  "extends": "@loopback/build/config/tsconfig.common.json",
+  "compilerOptions": {
+    "outDir": "dist",
+    "rootDir": "src"
+  },
+  "include": ["src"]
+<% } else { -%>
+  "compilerOptions": {
+    "outDir": "dist",
+    "rootDir": "src",
+
+    "emitDecoratorMetadata": true,
+    "experimentalDecorators": true,
+    "noImplicitAny": true,
+    "strictNullChecks": true,
+    "resolveJsonModule": true,
+    "skipLibCheck": true,
+
+    "incremental": true,
+
+    "lib": ["es2018", "esnext.asynciterable"],
+    "module": "commonjs",
+    "esModuleInterop": true,
+    "moduleResolution": "node",
+    "target": "es2017",
+    "sourceMap": true,
+    "declaration": true
+  },
+  "include": ["src"],
+  "exclude": [
+    "**/node_modules/**",
+    "**/dist/**",
+    "**/*.d.ts"
+  ]
+<% } -%>
+}

package/generators/relation/base-relation.generator.js

@@ -0,0 +1,220 @@
+// Copyright IBM Corp. and LoopBack contributors 2019,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 ast = require('ts-morph');
+const ArtifactGenerator = require('../../lib/artifact-generator');
+const path = require('path');
+const relationUtils = require('./utils.generator');
+const utils = require('../../lib/utils');
+
+module.exports = class BaseRelationGenerator extends ArtifactGenerator {
+  constructor(args, opts) {
+    super(args, opts);
+  }
+
+  _setupGenerator() {
+    this.artifactInfo = {
+      type: 'relation',
+      rootDir: utils.sourceRootDir,
+    };
+
+    this.artifactInfo.outDir = path.resolve(
+      this.artifactInfo.rootDir,
+      'controllers',
+    );
+    this.artifactInfo.modelDir = path.resolve(
+      this.artifactInfo.rootDir,
+      'models',
+    );
+    this.artifactInfo.repositoryDir = path.resolve(
+      this.artifactInfo.rootDir,
+      'repositories',
+    );
+
+    super._setupGenerator();
+  }
+
+  async generateAll(options) {
+    this._setupGenerator();
+    await this.generateModels(options);
+    this._setupGenerator();
+    await this.generateRepositories(options);
+    this._setupGenerator();
+    await this.generateControllers(options);
+  }
+
+  async generateControllers(options) {
+    /* istanbul ignore next */
+    throw new Error('Not implemented');
+  }
+
+  async generateModels(options) {
+    /* istanbul ignore next */
+    throw new Error('Not implemented');
+  }
+
+  async generateRepositories(options) {
+    this._initializeProperties(options);
+    this._addImportsToRepository(options);
+    this._addPropertyToRepository(options);
+    const classDeclaration = relationUtils.getClassObj(
+      this.artifactInfo.srcRepositoryFileObj,
+      this.artifactInfo.srcRepositoryClassName,
+    );
+    const classConstructor =
+      relationUtils.getClassConstructor(classDeclaration);
+    this._addParametersToRepositoryConstructor(classConstructor);
+    this._addCreatorToRepositoryConstructor(classConstructor);
+    this._registerInclusionResolverForRelation(classConstructor, options);
+    await this.artifactInfo.srcRepositoryFileObj.save();
+  }
+
+  _addImportsToRepository(options) {
+    const imports = this._getRepositoryRequiredImports(
+      options.destinationModel,
+      this.artifactInfo.dstRepositoryClassName,
+    );
+
+    relationUtils.addRequiredImports(
+      this.artifactInfo.srcRepositoryFileObj,
+      imports,
+    );
+  }
+
+  _addPropertyToRepository(options) {
+    const classDeclaration =
+      this.artifactInfo.srcRepositoryFileObj.getClassOrThrow(
+        this.artifactInfo.srcRepositoryClassName,
+      );
+
+    const property = {
+      scope: ast.Scope.Public,
+      isReadonly: true,
+      name: this._getRepositoryRelationPropertyName(),
+      type: this._getRepositoryRelationPropertyType(),
+    };
+
+    // already checked the existence of property before
+    relationUtils.addProperty(classDeclaration, property);
+  }
+
+  _addParametersToRepositoryConstructor(classConstructor) {
+    if (this._addThroughRepoToRepositoryConstructor) {
+      this._addThroughRepoToRepositoryConstructor(classConstructor);
+    }
+    const parameterName =
+      utils.camelCase(this.artifactInfo.dstRepositoryClassName) + 'Getter';
+
+    if (relationUtils.doesParameterExist(classConstructor, parameterName)) {
+      // no need to check if the getter already exists
+      return;
+    }
+
+    classConstructor.addParameter({
+      decorators: [
+        {
+          name: 'repository.getter',
+          arguments: ["'" + this.artifactInfo.dstRepositoryClassName + "'"],
+        },
+      ],
+      name: parameterName,
+      type: 'Getter<' + this.artifactInfo.dstRepositoryClassName + '>,',
+      scope: ast.Scope.Protected,
+    });
+  }
+
+  _addCreatorToRepositoryConstructor(classConstructor) {
+    /* istanbul ignore next */
+    throw new Error('Not implemented');
+  }
+
+  _registerInclusionResolverForRelation(classConstructor, options) {
+    /* istanbul ignore next */
+    throw new Error('Not implemented');
+  }
+
+  _initializeProperties(options) {
+    // src configuration.
+    this.artifactInfo.srcModelPrimaryKey = options.sourceModelPrimaryKey;
+    this.artifactInfo.srcModelFile = path.resolve(
+      this.artifactInfo.modelDir,
+      utils.getModelFileName(options.sourceModel),
+    );
+
+    this.artifactInfo.srcModelClass = options.sourceModel;
+
+    this.artifactInfo.srcRepositoryFile = path.resolve(
+      this.artifactInfo.repositoryDir,
+      utils.getRepositoryFileName(options.sourceModel),
+    );
+
+    this.artifactInfo.srcRepositoryClassName =
+      utils.toClassName(options.sourceModel) + 'Repository';
+
+    this.artifactInfo.srcRepositoryFileObj =
+      new relationUtils.AstLoopBackProject().addSourceFileAtPath(
+        this.artifactInfo.srcRepositoryFile,
+      );
+
+    // dst configuration
+    this.artifactInfo.dstModelFile = path.resolve(
+      this.artifactInfo.modelDir,
+      utils.getModelFileName(options.destinationModel),
+    );
+
+    this.artifactInfo.dstModelClass = options.destinationModel;
+
+    this.artifactInfo.dstRepositoryFile = path.resolve(
+      this.artifactInfo.repositoryDir,
+      utils.getRepositoryFileName(options.destinationModel),
+    );
+
+    this.artifactInfo.dstRepositoryClassName =
+      utils.toClassName(options.destinationModel) + 'Repository';
+    this.artifactInfo.dstModelPrimaryKey = options.destinationModelPrimaryKey;
+    if (options.throughModel) {
+      this.artifactInfo.throughModelClass = options.throughModel;
+      this.artifactInfo.throughRepoClassName = utils.toClassName(
+        options.throughModel + 'Repository',
+      );
+    }
+
+    // relation configuration
+    this.artifactInfo.relationName = options.relationName;
+  }
+
+  _getRepositoryRequiredImports(dstModelClassName, dstRepositoryClassName) {
+    return [
+      {
+        name: dstModelClassName,
+        module: '../models',
+      },
+      {
+        name: 'repository',
+        module: '@loopback/repository',
+      },
+      {
+        name: 'Getter',
+        module: '@loopback/core',
+      },
+      {
+        name: dstRepositoryClassName,
+        module: `./${utils.toFileName(dstModelClassName)}.repository`,
+      },
+    ];
+  }
+
+  _getRepositoryRelationPropertyName() {
+    /* istanbul ignore next */
+    throw new Error('Not implemented');
+  }
+
+  _getRepositoryRelationPropertyType() {
+    /* istanbul ignore next */
+    throw new Error('Not implemented');
+  }
+};