@tsed/cli 3.25.0 → 3.26.1

package/readme.md

@@ -48,6 +48,103 @@ https_proxy=http://username:password@host:port
 > Note: The following environment variables can be also used to configure the proxy `HTTPS_PROXY`, `HTTP_PROXY`
 > and `NODE_TLS_REJECT_UNAUTHORIZED`.
 
+## Commands
+
+```shell
+Usage: tsed [options] [command]
+
+Options:
+  -V, --version                       output the version number
+  -h, --help                          display help for command
+
+Commands:  
+  add [options] [name]                Add cli plugin to the current project
+  generate|g [options] [type] [name]  Generate a new provider class
+  update [options]                    Update all Ts.ED packages used by your project
+  init [options] [root]               Init a new Ts.ED project
+  run [options] <command>             Run a project level command
+  help [command]                      display help for commands
+```
+
+## Init project
+
+```shell
+Usage: tsed init [options] [root]
+
+Init a new Ts.ED project
+
+Arguments:  
+  root                                    Root directory to initialize the Ts.ED project (default: ".")
+  
+Options:
+  -n, --project-name <projectName>        Set the project name. By default, the project is the same as the name directory. (default: "")
+  -a, --arch <architecture>               Set the default architecture convention (default or feature) (default: "default")
+  -c, --convention <convention>           Set the default project convention (default or feature) (default: "default")
+  -p, --platform <platform>               Set the default platform for Ts.ED (express or koa) (default: "express")
+  --features <features...>                List of the Ts.ED features. (default: [])
+  -m, --package-manager <packageManager>  The default package manager to install the project (default: "yarn")
+  -t, --tsed-version <version>            Use a specific version of Ts.ED (format: 5.x.x). (default: "latest")
+  -f, --file <path>                       Location of a file in which the features are defined.
+  -s, --skip-prompt                       Skip the prompt. (default: false)
+  -r, --root-dir <path>                   Project root directory
+  --verbose                               Verbose mode
+  -h, --help                              display help for command
+```
+
+Interactive prompt:
+
+```shell
+tsed init .
+```
+
+Skip prompt:
+
+```shell
+tsed init . --platform express --package-manager yarn --features swagger,jest,eslint,lintstaged,prettier --skip-prompt
+```
+
+## Use file to generate project
+
+A file can be defined to generate project. For example create a `tsed.template.yml` and add this code:
+
+```yaml
+projectName: project-example
+platform: express
+architecture: default
+convention: default
+skipPrompt: true
+packageManager: yarn
+features:
+ - graphql
+ - socketio
+ - swagger
+ - oidc
+ - passportjs
+ - commands
+ - db
+ - prisma
+ - mongoose
+ - typeorm
+ - typeorm:mysql
+ - testing
+ - jest
+ - mocha
+ - linter
+ - eslint
+ - lintstaged
+ - prettier
+ - bundler
+ - babel
+ - babel:webpack
+```
+> Note: The CLI support `yml` and `json` file!
+
+Then:
+
+```shell
+tsed init . --file ./tsed.template.yml
+```
+
 ## Run Cli from code
 
 ```typescript

package/templates/generate/server.hbs

@@ -1,29 +1,10 @@
 import {join} from "path";
 import {Configuration, Inject} from "@tsed/di";
 import {PlatformApplication} from "@tsed/common";
-{{#if express}}import "@tsed/platform-express"; // /!\ keep this import
-import bodyParser from "body-parser";
-import compress from "compression";
-import cookieParser from "cookie-parser";
-import methodOverride from "method-override";
-import cors from "cors";
-{{/if}}{{#if koa}}import "@tsed/platform-koa"; // /!\ keep this import
-import bodyParser from "koa-bodyparser";
-import compress from "koa-compress";
-import cors from "@koa/cors";
-import methodOverride from "koa-override";
-{{/if}}
-import "@tsed/ajv";{{#if swagger}}
-import "@tsed/swagger";{{/if}}{{#if mongoose}}
-import "@tsed/mongoose";{{/if}}{{#if oidc}}
-import "@tsed/oidc-provider";{{/if}}{{#if graphql}}
-import "@tsed/typegraphql";
-import "./datasources/index";
-import "./resolvers/index";{{/if}}
-import {config} from "./config/index";
-import * as rest from "./controllers/rest/index";{{#if swagger}}
-import * as pages from "./controllers/pages/index";{{/if}}{{#if oidc}}
-import {InteractionsController} from "./controllers/oidc/InteractionsController";{{/if}}
+{{#forEach imports}}{{#if tsIngore}}
+// @ts-ignore
+{{/if}}import {{symbols}}{{#if symbols}} from {{/if}}"{{from}}";{{comment}}
+{{/forEach}}
 
 @Configuration({
   ...config,

package/templates/init/.barrelsby.json.hbs

@@ -1,11 +1,5 @@
 {
-  "directory": [
-    "./src/controllers/rest"{{#or swagger oidc}},
-    "./src/controllers/pages"{{/or}}{{#if oidc}},
-    "./src/interactions"{{/if}}{{#if graphql}},
-    "./src/datasources",
-    "./src/resolvers"{{/if}}
-  ],
+  "directory": {{{barrels}}},
   "exclude": [
     "__mock__",
     "__mocks__",

package/lib/cjs/services/Features.js

@@ -1,528 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.getFeaturesChoicesValues = exports.parseFeaturesFile = exports.FEATURES_TYPEORM_CONNECTION_TYPES = exports.isPlatform = exports.hasValue = exports.hasFeature = exports.Features = void 0;
-const cli_core_1 = require("@tsed/cli-core");
-const core_1 = require("@tsed/core");
-const interfaces_1 = require("../interfaces");
-function Features() {
-    return (0, cli_core_1.Inject)(Features);
-}
-exports.Features = Features;
-function hasFeature(feature) {
-    return (ctx) => !!ctx.features.find((item) => item.type === feature);
-}
-exports.hasFeature = hasFeature;
-function hasValue(expression, value) {
-    return (ctx) => (0, core_1.getValue)(expression, ctx) === value;
-}
-exports.hasValue = hasValue;
-function isPlatform(...types) {
-    return (ctx) => [types].includes(ctx.platform);
-}
-exports.isPlatform = isPlatform;
-exports.FEATURES_TYPEORM_CONNECTION_TYPES = [
-    {
-        name: "MySQL",
-        value: {
-            type: "typeorm:mysql",
-            dependencies: {
-                mysql2: "latest"
-            }
-        }
-    },
-    {
-        name: "MariaDB",
-        value: {
-            type: "typeorm:mariadb",
-            dependencies: {
-                mariadb: "latest"
-            }
-        }
-    },
-    {
-        name: "Postgres",
-        value: {
-            type: "typeorm:postgres",
-            dependencies: {
-                pg: "latest"
-            }
-        }
-    },
-    {
-        name: "CockRoachDB",
-        value: {
-            type: "typeorm:postgres",
-            dependencies: {
-                cockroachdb: "latest"
-            }
-        }
-    },
-    {
-        name: "SQLite",
-        value: {
-            type: "typeorm:sqlite",
-            dependencies: {
-                sqlite3: "latest"
-            }
-        }
-    },
-    {
-        name: "Better SQLite3",
-        value: {
-            type: "typeorm:better-sqlite3",
-            dependencies: {
-                "better-sqlite3": "latest"
-            }
-        }
-    },
-    {
-        name: "Cordova",
-        value: {
-            type: "typeorm:cordova"
-        }
-    },
-    {
-        name: "NativeScript",
-        value: {
-            type: "typeorm:nativescript"
-        }
-    },
-    {
-        name: "Oracle",
-        value: {
-            type: "typeorm:oracle",
-            dependencies: {
-                oracledb: "latest"
-            }
-        }
-    },
-    {
-        name: "MsSQL",
-        value: {
-            type: "typeorm:mssql",
-            dependencies: {
-                mssql: "latest"
-            }
-        }
-    },
-    {
-        name: "MongoDB",
-        value: {
-            type: "typeorm:mongodb",
-            dependencies: {
-                mongodb: "latest"
-            }
-        }
-    },
-    {
-        name: "SQL.js",
-        value: {
-            type: "typeorm:sqljs",
-            dependencies: {}
-        }
-    },
-    {
-        name: "ReactNative",
-        value: {
-            type: "typeorm:reactnative",
-            dependencies: {}
-        }
-    },
-    {
-        name: "Expo",
-        value: {
-            type: "typeorm:expo",
-            dependencies: {}
-        }
-    }
-];
-const babelDevDependencies = {
-    "@babel/cli": "latest",
-    "@babel/core": "latest",
-    "@babel/node": "latest",
-    "@babel/plugin-proposal-class-properties": "latest",
-    "@babel/plugin-proposal-decorators": "latest",
-    "@babel/preset-env": "latest",
-    "@babel/preset-typescript": "latest",
-    "babel-plugin-transform-typescript-metadata": "latest",
-    "babel-watch": "latest"
-};
-const platformChoices = [
-    {
-        name: "Express.js",
-        checked: true,
-        value: "express"
-    },
-    {
-        name: "Koa.js",
-        checked: false,
-        value: "koa"
-    }
-];
-const conventionChoices = [
-    {
-        name: "Ts.ED",
-        checked: true,
-        value: interfaces_1.ProjectConvention.DEFAULT
-    },
-    {
-        name: "Angular",
-        checked: false,
-        value: interfaces_1.ProjectConvention.ANGULAR
-    }
-];
-const featureChoices = (cliVersion) => [
-    {
-        name: "TypeGraphQL",
-        value: {
-            type: "graphql",
-            dependencies: {
-                "@tsed/typegraphql": "{{tsedVersion}}"
-            },
-            devDependencies: {
-                "@tsed/cli-plugin-typegraphql": cliVersion
-            }
-        }
-    },
-    {
-        name: "Database",
-        value: { type: "db" }
-    },
-    {
-        name: "Passport.js",
-        when: isPlatform("express"),
-        value: {
-            type: "passportjs",
-            devDependencies: {
-                "@tsed/cli-plugin-passport": cliVersion
-            }
-        }
-    },
-    {
-        name: "Socket.io",
-        value: {
-            type: "socketio",
-            dependencies: {
-                "@tsed/socketio": "{{tsedVersion}}",
-                "socket.io": "latest"
-            }
-        }
-    },
-    {
-        name: "Swagger",
-        value: {
-            type: "swagger",
-            dependencies: {
-                "@tsed/swagger": "{{tsedVersion}}"
-            }
-        }
-    },
-    {
-        name: "OpenID Connect provider",
-        value: {
-            type: "oidc",
-            devDependencies: {
-                "@tsed/cli-plugin-oidc-provider": cliVersion
-            }
-        }
-    },
-    {
-        name: "Testing",
-        value: {
-            type: "testing",
-            dependencies: {},
-            devDependencies: {
-                "@types/supertest": "latest",
-                supertest: "latest"
-            }
-        }
-    },
-    {
-        name: "Linter",
-        value: {
-            type: "linter"
-        }
-    },
-    {
-        name: "Bundler",
-        value: {
-            type: "bundler"
-        }
-    },
-    {
-        name: "Commands",
-        value: {
-            type: "commands",
-            dependencies: {
-                "@tsed/cli-core": cliVersion
-            },
-            devDependencies: {
-                "@types/inquirer": "latest"
-            }
-        }
-    }
-];
-const featuresDbChoices = (cliVersion) => [
-    {
-        name: "Prisma",
-        value: {
-            type: "prisma",
-            devDependencies: {
-                "@tsed/cli-plugin-prisma": cliVersion
-            }
-        }
-    },
-    {
-        name: "Mongoose",
-        value: {
-            type: "mongoose",
-            devDependencies: {
-                "@tsed/cli-plugin-mongoose": cliVersion
-            }
-        }
-    },
-    {
-        name: "TypeORM",
-        value: {
-            type: "typeorm",
-            devDependencies: {
-                "@tsed/cli-plugin-typeorm": cliVersion
-            }
-        }
-    }
-];
-const featuresTestingChoices = (cliVersion) => [
-    {
-        name: "Jest",
-        value: {
-            type: "jest",
-            devDependencies: {
-                "@tsed/cli-plugin-jest": cliVersion
-            }
-        }
-    },
-    {
-        name: "Mocha + Chai + Sinon",
-        value: {
-            type: "mocha",
-            devDependencies: {
-                "@tsed/cli-plugin-mocha": cliVersion
-            }
-        }
-    }
-];
-const featuresLinterChoices = (cliVersion) => [
-    {
-        name: "EsLint",
-        checked: true,
-        value: {
-            type: "eslint",
-            devDependencies: {
-                "@tsed/cli-plugin-eslint": cliVersion
-            }
-        }
-    }
-];
-const featuresExtraLinterChoices = [
-    {
-        name: "Prettier",
-        value: {
-            type: "prettier"
-        }
-    },
-    {
-        name: "Lint on commit",
-        value: {
-            type: "lintstaged"
-        }
-    }
-];
-const featuresBundlerChoices = [
-    {
-        name: "Babel",
-        value: {
-            type: "babel",
-            devDependencies: {
-                ...babelDevDependencies
-            }
-        }
-    },
-    {
-        name: "Webpack",
-        value: {
-            type: "babel:webpack",
-            devDependencies: {
-                ...babelDevDependencies,
-                "babel-loader": "latest",
-                webpack: "latest",
-                "webpack-cli": "latest"
-            }
-        }
-    }
-];
-const packageManagerChoices = [
-    {
-        name: "Yarn",
-        checked: true,
-        value: "yarn"
-    },
-    {
-        name: "NPM",
-        checked: false,
-        value: "npm"
-    },
-    {
-        name: "PNPM - experimental",
-        checked: false,
-        value: "pnpm"
-    }
-];
-const parseFeaturesFile = (features, cliVersion) => {
-    return {
-        platform: features.platform,
-        convention: features.convention,
-        features: [
-            ...featureChoices(cliVersion)
-                .map((v) => v.value)
-                .filter((v) => features.features.filter((v) => typeof v === "string").includes(v.type)),
-            ...features.features.filter((v) => typeof v === "object")
-        ],
-        featuresDB: featuresDbChoices(cliVersion).find((v) => v.value.type === features.featuresDB)?.value,
-        featuresTypeORM: exports.FEATURES_TYPEORM_CONNECTION_TYPES.find((v) => v.value.type === features.featuresTypeORM)?.value,
-        featuresTesting: featuresTestingChoices(cliVersion).find((v) => v.value.type === features.featuresTesting)?.value,
-        featuresLinter: featuresLinterChoices(cliVersion).find((v) => v.value.type === features.featuresLinter)?.value,
-        featuresExtraLinter: featuresExtraLinterChoices.map((v) => v.value).filter((v) => features.featuresExtraLinter?.includes(v.type)),
-        featuresBundler: featuresBundlerChoices.find((v) => v.value.type === features.featuresBundlerChoices)?.value,
-        packageManager: features.packageManager
-    };
-};
-exports.parseFeaturesFile = parseFeaturesFile;
-const getFeaturesChoicesValues = (cliVersion) => {
-    return {
-        platform: platformChoices.map((v) => v.value),
-        convention: conventionChoices.map((v) => v.value),
-        features: featureChoices(cliVersion).map((v) => v.value.type),
-        featuresDB: featuresDbChoices(cliVersion).map((v) => v.value.type),
-        featuresTypeORM: exports.FEATURES_TYPEORM_CONNECTION_TYPES.map((v) => v.value.type),
-        featuresTesting: featuresTestingChoices(cliVersion).map((v) => v.value.type),
-        featuresLinter: featuresLinterChoices(cliVersion).map((v) => v.value.type),
-        featuresExtraLinter: featuresExtraLinterChoices.map((v) => v.value.type),
-        featuresBundler: featuresBundlerChoices.map((v) => v.value.type),
-        packageManager: packageManagerChoices.map((v) => v.value)
-    };
-};
-exports.getFeaturesChoicesValues = getFeaturesChoicesValues;
-(0, cli_core_1.registerProvider)({
-    provide: Features,
-    deps: [cli_core_1.CliPackageJson],
-    useFactory(cliPackageJson) {
-        const cliVersion = cliPackageJson.version;
-        return [
-            {
-                message: "Choose the target platform:",
-                type: "list",
-                name: "platform",
-                choices: platformChoices
-            },
-            {
-                message: "Choose the architecture for your project:",
-                type: "list",
-                name: "architecture",
-                choices: [
-                    {
-                        name: "Ts.ED",
-                        checked: true,
-                        value: interfaces_1.ArchitectureConvention.DEFAULT
-                    },
-                    {
-                        name: "feature",
-                        checked: false,
-                        value: interfaces_1.ArchitectureConvention.FEATURE
-                    }
-                ]
-            },
-            {
-                message: "Choose the convention file styling:",
-                type: "list",
-                name: "convention",
-                choices: conventionChoices
-            },
-            {
-                type: "checkbox",
-                name: "features",
-                message: "Check the features needed for your project",
-                choices: featureChoices(cliVersion)
-            },
-            {
-                message: "Choose a ORM manager",
-                type: "list",
-                name: "featuresDB",
-                when: hasFeature("db"),
-                choices: featuresDbChoices(cliVersion)
-            },
-            {
-                type: "list",
-                name: "featuresTypeORM",
-                message: "Which TypeORM you want to install?",
-                choices: exports.FEATURES_TYPEORM_CONNECTION_TYPES,
-                when: hasValue("featuresDB.type", "typeorm")
-            },
-            // {
-            //   type: "password",
-            //   name: "GH_TOKEN",
-            //   message:
-            //     "Enter GH_TOKEN to use the premium @tsedio/prisma package or leave blank (see https://tsed.io/tutorials/prisma-client.html)",
-            //   when: hasValue("featuresDB.type", "prisma")
-            // },
-            {
-                message: "Choose unit framework",
-                type: "list",
-                name: "featuresTesting",
-                when: hasFeature("testing"),
-                choices: featuresTestingChoices(cliVersion)
-            },
-            {
-                message: "Choose linter tools framework",
-                type: "list",
-                name: "featuresLinter",
-                when: hasFeature("linter"),
-                choices: featuresLinterChoices(cliVersion)
-            },
-            {
-                message: "Choose extra linter tools",
-                type: "checkbox",
-                name: "featuresExtraLinter",
-                when: hasFeature("linter"),
-                choices: featuresExtraLinterChoices
-            },
-            {
-                message: "Choose your bundler",
-                type: "list",
-                name: "featuresBundler",
-                when: hasFeature("bundler"),
-                choices: featuresBundlerChoices
-            },
-            {
-                message: "Choose the OIDC base path server",
-                name: "oidcBasePath",
-                default: "/oidc",
-                when: hasFeature("oidc"),
-                type: "input"
-            },
-            {
-                message: "Choose the OIDC base path server",
-                name: "oidcBasePath",
-                default: "/oidc",
-                when: hasFeature("oidc"),
-                type: "input"
-            },
-            {
-                message: "Choose the package manager:",
-                type: "list",
-                name: "packageManager",
-                choices: packageManagerChoices
-            }
-        ];
-    }
-});
-//# sourceMappingURL=Features.js.map