@cyber-tools/create-cyber-project 7.7.0 → 9.0.0

package/.bin/index.js

@@ -1,2 +1,3 @@
 #!/usr/bin/env node
-require("../index");
+require("esbuild-register");
+require("../index.ts");

package/commons/ApplicationConfigManager.ts

@@ -0,0 +1,77 @@
+import os from "os";
+import path from "path";
+import { merge } from "lodash";
+import pathExists from "path-exists";
+import { readFile } from "jsonfile";
+import { injectable } from "inversify";
+
+import { IOCContainer } from "@/commons/IOCContainer";
+
+@injectable()
+export class ApplicationConfigManager {
+
+  /** 应用层内置的默认配置 **/
+  private defaultConfig: any = {
+    projects: [{
+      name: "基本的typescript项目",
+      value: {
+        remote: "https://github.com/cyber-scaffold/typescript-bootstrap-project"
+      }
+    }, {
+      name: "基于MVC和控制反转的全栈项目",
+      value: {
+        remote: "https://github.com/cyber-scaffold/mvc-fullstack-scaffold"
+      }
+    }, {
+      name: "基于typescript和express的纯后端项目",
+      value: {
+        remote: "https://github.com/cyber-scaffold/pure-typescript-server-project"
+      }
+    }, {
+      name: "基于typescript和express的没有ssr的spa全栈项目",
+      value: {
+        remote: "https://github.com/cyber-scaffold/server-spa-client-project"
+      }
+    }, {
+      name: "基于typescript的electron项目",
+      value: {
+        remote: "https://github.com/cyber-scaffold/omni-electron-project"
+      }
+    }]
+  };
+
+  /** 操作系统层的配置 **/
+  private systemConfig: any = {};
+
+  /** $HOME目录下的配置 **/
+  private custmerConfig: any = {};
+
+  /** 声明在操作系统层的配置文件路径 **/
+  get systemConfigPath() {
+    return path.join("/etc/", "/redis-broadcast-discover/", "./config.json");
+  };
+
+  /** 声明在$HOME目录下的配置文件路径 **/
+  get custmerConfigPath() {
+    return path.join(os.homedir(), "/.redis-broadcast-discover/", "./config.json");
+  };
+
+  /** 初始化并加载配置到运行时 **/
+  public async initialize() {
+    if (await pathExists(this.systemConfigPath)) {
+      this.systemConfig = await readFile(this.systemConfigPath);
+    };
+    if (await pathExists(this.custmerConfigPath)) {
+      this.custmerConfig = await readFile(this.custmerConfigPath);
+    };
+  };
+
+  /** 获取最终组合之后的运行时配置 **/
+  public getRuntimeConfig() {
+    const composeConfig = merge(this.defaultConfig, this.systemConfig, this.custmerConfig);
+    return composeConfig;
+  };
+
+};
+
+IOCContainer.bind(ApplicationConfigManager).toSelf().inSingletonScope();

package/commons/IOCContainer.ts

@@ -0,0 +1,4 @@
+import "reflect-metadata";
+import { Container } from "inversify";
+
+export const IOCContainer = new Container();

package/index.ts

@@ -0,0 +1,22 @@
+import { IOCContainer } from "@/commons/IOCContainer";
+import { CommandLineUtils } from "@/utils/CommandLineUtils";
+import { ApplicationConfigManager } from "@/commons/ApplicationConfigManager";
+
+//@ts-ignore
+setImmediate(async () => {
+  try {
+    /** 初始化配置文件 **/
+    const $ApplicationConfigManager = IOCContainer.get(ApplicationConfigManager);
+    await $ApplicationConfigManager.initialize();
+    /** 选择远程摸板 **/
+    const $CommandLineUtils = IOCContainer.get(CommandLineUtils);
+    const { remote, devDependencies } = await $CommandLineUtils.selectTemplate();
+    /** 输入项目名称 **/
+    const packageName = await $CommandLineUtils.inputPackageName();
+    /** 拉取并创建项目 **/
+    await $CommandLineUtils.downloadTemplate({ folderName: packageName, remote });
+    await $CommandLineUtils.changeJsonFile({ folderName: packageName, projectName: packageName, devDependencies });
+  } catch (error) {
+    throw error;
+  };
+});

package/package.json

@@ -1,13 +1,14 @@
 {
   "name": "@cyber-tools/create-cyber-project",
-  "version": "7.7.0",
-  "main": "index.js",
+  "version": "9.0.0",
+  "main": "./.bin/index.js",
   "scripts": {
-    "test": "echo \"Error: no test specified\" && exit 1"
+    "test": "echo test"
   },
   "publishConfig": {
     "access": "public"
   },
+  "bin": "./.bin/index.js",
   "keywords": [
     "cli",
     "cyber",
@@ -19,16 +20,21 @@
   "license": "ISC",
   "description": "用于创建cyber系列项目的命令行工具",
   "dependencies": {
-    "@cyber-tools/cli-utils": "^2.4.1",
+    "ora": "^5.1.0",
     "colors": "1.4.0",
+    "path-exists": "^4.0.0",
+    "cli-spinners": "^2.4.0",
     "download-git-repo": "^3.0.2",
-    "es6-promisify": "^6.1.1",
     "inquirer": "^7.3.3",
+    "inversify": "^6.0.2",
     "jsonfile": "^6.0.1",
-    "module-alias": "^2.2.2",
+    "lodash": "^4.17.23",
     "prompt": "1.2.2",
+    "reflect-metadata": "^0.2.2",
+    "esbuild-register": "^3.6.0",
     "winston": "3.6.0"
   },
-  "bin": "./.bin/index.js",
-  "gitHead": "a2ef8251d9d5607f82724a90fc65b34ad23d40f0"
+  "devDependencies": {
+    "esbuild": "^0.27.4"
+  }
 }

package/tsconfig.json

@@ -0,0 +1,21 @@
+{
+  "compilerOptions": {
+    "emitDecoratorMetadata": true,
+    "experimentalDecorators": true,
+    "target": "es2016",
+    "module": "commonjs",
+    "baseUrl": "./",
+    "moduleResolution": "node",
+    "resolveJsonModule": true,
+    "esModuleInterop": true,
+    "forceConsistentCasingInFileNames": true,
+    "strict": false,
+    "skipLibCheck": true,
+    "sourceMap": true,
+    "paths": {
+      "@/*": [
+        "./*"
+      ]
+    }
+  }
+}

package/utils/CommandLineToast.ts

@@ -0,0 +1,26 @@
+import ora from "ora";
+import { dots } from "cli-spinners";
+import { injectable, inject } from "inversify";
+import { IOCContainer } from "@/commons/IOCContainer";
+
+@injectable()
+export class CommandLineToast {
+
+  public toast = ora(dots);
+
+  public start(...params: any) {
+    this.toast.start(...arguments);
+  };
+
+  public succeed(params: any) {
+    this.toast.succeed(...arguments);
+  };
+
+  public fail(params: any) {
+    this.toast.fail(...arguments);
+  };
+
+};
+
+IOCContainer.bind(CommandLineToast).toSelf().inRequestScope();
+

package/utils/CommandLineUtils.ts

@@ -0,0 +1,120 @@
+import path from "path";
+import prompt from "prompt";
+import colors from "colors";
+import npmName from "npm-name";
+import inquirer from "inquirer";
+import { promisify } from "util";
+import download from "download-git-repo";
+import { readFile, writeFile } from "jsonfile";
+import { injectable, inject } from "inversify";
+import validate from "validate-npm-package-name";
+
+import { IOCContainer } from "@/commons/IOCContainer";
+import { CommandLineToast } from "@/utils/CommandLineToast";
+import { ApplicationConfigManager } from "@/commons/ApplicationConfigManager";
+
+@injectable()
+export class CommandLineUtils {
+
+  constructor(
+    @inject(CommandLineToast) private readonly $CommandLineToast: CommandLineToast,
+    @inject(ApplicationConfigManager) private readonly $ApplicationConfigManager: ApplicationConfigManager
+  ) { };
+
+  /**
+   * 选择远程摸板
+   * **/
+  public async selectTemplate() {
+    const { projects } = await this.$ApplicationConfigManager.getRuntimeConfig();
+    const { template } = await inquirer.prompt({
+      type: "list",
+      name: "template",
+      defaultValue: projects[0]["name"],
+      message: "选择拉取的项目脚手架:",
+      choices: projects
+    });
+    return template;
+  };
+
+  /**
+   * 输入包的名称@packageName
+   * **/
+  public async inputPackageName() {
+    try {
+      prompt.message = undefined;
+      prompt.delimiter = ":";
+      prompt.start();
+      const { packageName } = await promisify(prompt.get)([{
+        name: "packageName",
+        required: true,
+        message: colors.red("项目名称必须填写!"),
+        description: colors.white("请输入项目名称")
+      }]);
+      return packageName;
+    } catch (error) {
+      if (error.message === "canceled") {
+        process.exit(0);
+      };
+      throw error;
+    };
+  };
+
+  /**
+   * 检查包明是否已经在npm注册
+   * **/
+  public async caniUseName(name: string) {
+    try {
+      this.$CommandLineToast.start(["正在查询包名(", name, ")是否可用", "... ..."].join(""));
+      const { validForNewPackages, validForOldPackages } = await validate(name);
+      const isValidate = (validForNewPackages && validForOldPackages);
+      const isAvailable = await npmName(name);
+      if (isValidate && isAvailable) {
+        this.$CommandLineToast.toast.succeed(["包名(", name, ")可用!"].join(""));
+        return true;
+      };
+      this.$CommandLineToast.toast.fail(["包名(", name, ")不可用!"].join(""));
+      return false;
+    } catch (error) {
+      throw error;
+    };
+  };
+
+  /**
+   * 下载远程仓库中的代码摸板
+   * **/
+  public async downloadTemplate({ remote, folderName }) {
+    try {
+      const downloadTemplate = `direct:${remote.replace(/\.git$/ig, "")}.git`;
+      this.$CommandLineToast.start("正在拉取项目文件...");
+      const projectPath = path.join(process.cwd(), folderName);
+      await promisify(download)(downloadTemplate, projectPath, { clone: true });
+      this.$CommandLineToast.succeed("拉取成功!");
+    } catch (error) {
+      this.$CommandLineToast.fail("拉取失败!");
+      throw error;
+    };
+  };
+
+  /**
+   * 修改package.json中的相关内容
+   * **/
+  public async changeJsonFile({ folderName, projectName, devDependencies }) {
+    try {
+      this.$CommandLineToast.toast.start("修改package.json");
+      const jsonFilePath = path.resolve(process.cwd(), folderName, "./package.json");
+      const jsonObject = await promisify(readFile)(jsonFilePath);
+      const rewriteJsonObject = Object.assign({}, jsonObject, {
+        name: projectName,
+        devDependencies: Object.assign({}, jsonObject.devDependencies, devDependencies)
+      });
+      await promisify(writeFile)(jsonFilePath, rewriteJsonObject, { spaces: 2, EOL: '\r\n' });
+      this.$CommandLineToast.succeed("package.json修改成功!");
+    } catch (error) {
+      this.$CommandLineToast.fail("package.json修改失败!");
+      throw error;
+    };
+  };
+
+};
+
+IOCContainer.bind(CommandLineUtils).toSelf().inRequestScope();

package/configs/runtime.config.js

@@ -1,23 +0,0 @@
-
-
-module.exports = [{
-  name: "基本的typescript项目",
-  value: {
-    remote: "https://github.com/cyber-scaffold/typescript-bootstrap-project"
-  }
-}, {
-  name: "基于typescript和express的纯后端项目",
-  value: {
-    remote: "https://github.com/cyber-scaffold/pure-typescript-server-project"
-  }
-}, {
-  name: "基于typescript和express的没有ssr的spa全栈项目",
-  value: {
-    remote: "https://github.com/cyber-scaffold/server-spa-client-project"
-  }
-}, {
-  name: "基于typescript的electron项目",
-  value: {
-    remote: "https://github.com/cyber-scaffold/omni-electron-project"
-  }
-}];

package/index.js

@@ -1,17 +0,0 @@
-require("@cyber-tools/cli-utils/initial");
-require("module-alias").addAlias("@", __dirname);
-const selectTemplate = require("@/utils/selectTemplate");
-const inputPackageName = require("@/utils/inputPackageName");
-const downloadTemplate = require("@/utils/downloadTemplate");
-const changeJsonFile = require("@/utils/changeJsonFile");
-
-(async () => {
-  try {
-    const { remote, devDependencies } = await selectTemplate();
-    const packageName = await inputPackageName();
-    await downloadTemplate({ folderName: packageName, remote });
-    await changeJsonFile({ folderName: packageName, projectName: packageName, devDependencies });
-  } catch (error) {
-    throw error;
-  }
-})();

package/utils/changeJsonFile.js

@@ -1,23 +0,0 @@
-const ora = require("ora");
-const path = require("path");
-const { promisify } = require("es6-promisify");
-const { readFile, writeFile } = require("jsonfile");
-
-
-module.exports = async ({ folderName, projectName, devDependencies }) => {
-  const toast = ora();
-  try {
-    toast.start("修改package.json");
-    const jsonFilePath = path.resolve(process.cwd(), folderName, "./package.json");
-    const jsonObject = await promisify(readFile)(jsonFilePath);
-    const rewriteJsonObject = Object.assign({}, jsonObject, {
-      name: projectName,
-      devDependencies: Object.assign({}, jsonObject.devDependencies, devDependencies)
-    });
-    await promisify(writeFile)(jsonFilePath, rewriteJsonObject, { spaces: 2, EOL: '\r\n' });
-    toast.succeed("package.json修改成功!");
-  } catch (error) {
-    toast.fail("package.json修改失败!");
-    throw error;
-  };
-};

package/utils/downloadTemplate.js

@@ -1,18 +0,0 @@
-const path = require("path");
-const download = require("download-git-repo");
-const { promisify } = require("es6-promisify");
-
-const toast = require("@cyber-tools/cli-utils/toast");
-
-module.exports = async ({ folderName, remote }) => {
-  try {
-    const downloadTemplate = `direct:${remote.replace(/\.git$/ig, "")}.git`;
-    toast.start("正在拉取项目文件...");
-    const projectPath = path.join(process.cwd(), folderName);
-    await promisify(download)(downloadTemplate, projectPath, { clone: true });
-    toast.succeed("拉取成功!");
-  } catch (error) {
-    toast.fail("拉取失败!");
-    throw error;
-  };
-};

package/utils/inputPackageName.js

@@ -1,24 +0,0 @@
-const colors = require("colors");
-const prompt = require("prompt");
-const { promisify } = require("es6-promisify");
-
-
-module.exports = async () => {
-  try {
-    prompt.message = undefined;
-    prompt.delimiter = ":";
-    prompt.start();
-    const { packageName } = await promisify(prompt.get)([{
-      name: "packageName",
-      required: true,
-      message: colors.red("项目名称必须填写!"),
-      description: colors.white("请输入项目名称")
-    }]);
-    return packageName;
-  } catch (error) {
-    if (error.message === "canceled") {
-      process.exit(0);
-    };
-    throw error;
-  };
-};

package/utils/selectTemplate.js

@@ -1,13 +0,0 @@
-const inquirer = require("inquirer");
-const PROJECT_LIST = require("@/configs/runtime.config");
-
-module.exports = async () => {
-  const { template } = await inquirer.prompt({
-    type: "list",
-    name: "template",
-    defaultValue: "dva-app",
-    message: "选择拉取的项目脚手架:",
-    choices: PROJECT_LIST
-  });
-  return template;
-};