@lazycatcloud/lzc-cli 1.1.7 → 1.1.9

package/template/lite/lzc-build.yml

@@ -0,0 +1,60 @@
+# 整个文件中，可以通过 ${var} 的方式，使用 manifest.yml 文件中定义的值
+
+# buildscript
+# - 可以为构建脚本的路径地址
+# - 如果构建命令简单，也可以直接写 sh 的命令
+# buildscript: ./build.sh
+
+# manifest: 指定 lpk 包的 manifest.yml 文件路径
+# manifest: ./lzc-manifest.yml
+
+# contentdir: 指定打包的内容，将会打包到 lpk 中
+contentdir: ./error_pages
+
+# pkgout: lpk 包的输出路径
+pkgout: ./
+
+# icon 指定 lpk 包 icon 的路径路径，如果不指定将会警告
+# icon 仅仅允许 png 后缀的文件
+icon: ./lazycat.png
+
+# devshell 自定义应用的开发容器环境
+# - routers 指定应用容器的访问路由
+
+# devshell 没有指定 image 的情况，将会默认使用 registry.lazycat.cloud/lzc-cli/devshell:latest
+# devshell:
+#   routers:
+#     - /=http://127.0.0.1:8080
+
+# devshell 指定 image 的情况
+# devshell:
+#   routes:
+#     - /=http://127.0.0.1:3000
+#   image: registry.lazycat.cloud/lzc-cli/devshell:0.0.4
+
+# devshell 指定构建Dockerfile
+# image 字段如果没有定义，将默认使用 ${package}-devshell:${version}
+# devshell:
+#   routes:
+#     - /=http://127.0.0.1:3000
+#   image: ${package}-devshell:${version}
+#   pull_policy: build
+#   build: .
+
+# dvshell 指定开发依赖的情况
+# 这种情况下，选用 apline:3.16 作为基础镜像，在 dependencies 中添加所需要的开发依赖即可
+# 如果 dependencies 和 build 同时存在，将会优先使用 dependencies
+# devshell:
+#   routes:
+#     - /=http://127.0.0.1:3000
+#   dependencies:
+#     - go
+#     - vim
+#   # setupscript 每次进入到app container后都会执行的配置脚本
+#   # - 可以为脚本的路径地址
+#   # - 如果构建命令简单，也可以直接写 sh 的命令
+#   # setupscript: export GOPROXY=https://goproxy.cn
+#   # setupscript: ./setupscript.sh
+#   setupscript: |
+#     export GOPROXY=https://goproxy.cn
+#     export npm_config_registry=https://registry.npmmirror.com

package/cmds/app.js

@@ -1,133 +0,0 @@
-import process from "process";
-import path from "path";
-import {
-  archiveFolder,
-  isValidApp,
-  getMetaInfo,
-  ensureDir,
-} from "../lib/utils.js";
-import fs from "fs";
-import chalk from "chalk";
-import Builder, { execPreBuild } from "../lib/builder.js";
-import env, { sdkEnv } from "../lib/env.js";
-import BoxAPI from "../lib/api.js";
-import Archiver from "../lib/archiver.js";
-import Key from "../lib/key.js";
-
-// this set of api target box
-class App {
-  constructor(context) {
-    this.context = context;
-
-    const { appDir, isTemplate } = isValidApp(process.cwd());
-    if (!appDir) {
-      console.log(chalk.red("未识别懒猫云应用"));
-      process.exit(1);
-    }
-    this.appPath = appDir;
-    this.isTemplate = isTemplate;
-    env.load(process.cwd());
-  }
-
-  async deploy() {
-    try {
-      if (this.isTemplate) {
-        const outDir = await this.prepare();
-
-        await this.archiveAndInstall(outDir);
-      } else {
-        await sdkEnv.ensure();
-
-        await this.archiveAndInstall(this.appPath);
-      }
-    } catch (e) {
-      throw e;
-    }
-  }
-
-  async uninstall() {
-    let api;
-    const sdkUrl = sdkEnv.sdkUrl;
-    if (this.isTemplate) {
-      api = new BoxAPI(env.get("APP_ID"), sdkUrl);
-    } else {
-      const metaInfo = getMetaInfo(
-        path.join(this.appPath, "docker-compose.yml")
-      );
-      api = new BoxAPI(metaInfo.id, sdkUrl);
-    }
-
-    try {
-      await api.uninstall();
-    } catch (e) {
-      throw e;
-    }
-  }
-
-  async prepare() {
-    await this.prepareBuildEnv();
-
-    const outputDir = path.join(this.appPath, "output/release/");
-    const buildDir = path.join(process.cwd(), env.get("BUILD_CONTEXT"));
-
-    ensureDir(outputDir);
-
-    await new Key().ensure(sdkEnv.sdkUrl);
-
-    const envAll = {
-      ...env.all,
-      APP_IMAGE_NAME: env.get("APP_ID"),
-    };
-
-    // exec pre build
-    await execPreBuild(buildDir, process.cwd(), envAll);
-
-    // do image build
-    await new Builder(envAll).buildImage(process.cwd(), buildDir);
-
-    // do archive
-    const archiver = new Archiver(outputDir);
-    console.log("appPath", this.appPath);
-    await archiver.load(this.appPath);
-    await archiver.add(buildDir);
-
-    await archiver.finalize();
-
-    return outputDir;
-  }
-
-  async prepareBuildEnv() {
-    await sdkEnv.ensure();
-    await env.ensure([{ name: "HTTP_SERVICE_PORT" }]);
-  }
-
-  // archive current dir and install
-  async archiveAndInstall(dir) {
-    const metaInfo = getMetaInfo(path.join(dir, "docker-compose.yml"));
-    const api = new BoxAPI(metaInfo.id, sdkEnv.sdkUrl);
-    let out;
-    try {
-      const out = await archiveFolder(dir);
-      console.log(chalk.green("开始部署应用"));
-      await api.applyZip(out.path);
-      await api.checkStatus();
-
-      console.log(
-        `请在浏览器中访问 ${chalk.green(
-          sdkEnv.sdkUrl.replace(/sdk/, metaInfo.id)
-        )}`
-      );
-    } catch (e) {
-      throw e;
-    } finally {
-      if (out) fs.rmSync(out.path, { recursive: true });
-    }
-  }
-}
-
-const app = new App();
-
-export default {
-  deploy: () => app.deploy(),
-  uninstall: () => app.uninstall(),
-};

package/cmds/config.js

@@ -1,55 +0,0 @@
-import process from "process";
-import { isValidApp } from "../lib/utils.js";
-import env, { sdkEnv } from "../lib/env.js";
-import { debuglog } from "util";
-
-const debug = debuglog("cmd/config");
-
-class Config {
-  constructor(context) {
-    this.context = context;
-  }
-  async exec() {
-    const [key, value, options] = this.context;
-
-    isValidApp(process.cwd());
-    env.load(process.cwd());
-
-    // // lzc-cli config
-    if (!key && !value) {
-      console.log(env.stringify());
-      return;
-    }
-
-    // lzc-cli config SDK_URL
-    if (key && !value) {
-      if (env.get(key)) {
-        console.log(env.get(key));
-      }
-      return;
-    }
-
-    if (key && value) {
-      const pair = Object.fromEntries([[key, value]]);
-      // if (pair["SDK_URL"]) {
-      //   pair["SDK_URL"] = pair["SDK_URL"].replace(/\/$/, "");
-      //
-      //   try {
-      //     // 这里只需要测试sdk的合法性即可, 不需要处理安装的逻辑
-      //     await sdkEnv.checkConnection(pair["SDK_URL"]);
-      //   } catch (e) {
-      //     console.log(e.message);
-      //     debug("got error when check connection %s", e);
-      //     process.exit();
-      //   }
-      // }
-      env.set(pair, options.global);
-    }
-  }
-}
-
-export default {
-  config: async (context) => {
-    return await new Config(context).exec();
-  },
-};

package/cmds/create.js

@@ -1,55 +0,0 @@
-import chalk from "chalk";
-import { Init, chooseTemplate } from "./init.js";
-import path from "path";
-import Generator, { TemplateConfig } from "../lib/generator.js";
-import fs from "fs";
-import inquirer from "inquirer";
-import { parse2CorrectName } from "../lib/utils.js";
-const fsPromises = fs.promises;
-class Create {
-  constructor({ name }) {
-    this.name = name;
-  }
-
-  async exec() {
-    const type = await chooseTemplate();
-    this.init = new Init({
-      cwd: path.join(process.cwd(), this.name),
-      type: type,
-    });
-    if (TemplateConfig[type]) {
-      const config = TemplateConfig[type];
-      const init = this.init;
-      const answers = await init.askQuestions();
-      console.log(chalk.green(`初始化项目 ${this.name}`));
-      await Generator().generate(type, this.name);
-      console.log(chalk.green("设置懒猫云应用"));
-      await init.createTemplates(answers);
-      await init.createReleaseFolder();
-      await config.after(this.name);
-    }
-  }
-}
-
-export default async (context) => {
-  context.name = parse2CorrectName(context.name);
-  await fsPromises.access(process.cwd() + "/" + context.name).then(
-    async () => {
-      const questions = [
-        {
-          name: "override",
-          type: "input",
-          default: "n",
-          message: "项目已存在，是否覆盖(y/n): ",
-        },
-      ];
-      const answers = await inquirer.prompt(questions);
-      if (answers.override.toLowerCase() === "y") {
-        return new Create(context).exec();
-      }
-    },
-    () => {
-      return new Create(context).exec();
-    }
-  );
-};

package/cmds/dev.js

@@ -1,130 +0,0 @@
-import process from "process";
-import { isValidApp } from "../lib/utils.js";
-import chalk from "chalk";
-import Dev from "../lib/dev.js";
-import env, { sdkEnv } from "../lib/env.js";
-import BoxAPI from "../lib/api.js";
-import { dockerPullLzcAppsImage } from "../lib/sdk.js";
-import Key from "../lib/key.js";
-import logger from "loglevel";
-
-// this set of api target box
-class Develop {
-  constructor(context) {
-    this.context = context;
-
-    const { appDir, isTemplate } = isValidApp(process.cwd());
-    if (!appDir) {
-      console.log(chalk.red("未识别懒猫云应用"));
-      process.exit(1);
-    }
-
-    this.appPath = appDir;
-    this.isTemplate = isTemplate;
-    env.load(process.cwd());
-  }
-
-  async devShell({ build }) {
-    let appdev = new Dev(env.get("APP_ID"), this.appPath);
-
-    await sdkEnv.ensure();
-
-    // 确保 sdk 能通过公钥正常访问
-    await new Key().ensure(sdkEnv.sdkUrl);
-
-    if (build) {
-      appdev.reset();
-      await dockerPullLzcAppsImage(sdkEnv.sdkHostName);
-    }
-
-    // 当如果已经连接。直接连接ssh
-    if (appdev.hasShellStatus()) {
-      try {
-        await appdev.directShell();
-        return;
-      } catch (e) {
-        return Promise.reject(e);
-      }
-    }
-
-    // 重新部署dev app container
-    try {
-      const { APP_ID: appId } = await env.ensure([{ name: "APP_ID" }]);
-
-      logger.debug(sdkEnv.sdkUrl);
-      const api = new BoxAPI(appId, sdkEnv.sdkUrl);
-
-      let out = await appdev.fakeApp("shell");
-
-      logger.debug("设置端口转发");
-      await api.applyZip(out.path, { build: true });
-      await api.checkStatus();
-
-      await appdev.shell();
-      return;
-    } catch (e) {
-      return Promise.reject(e);
-    }
-  }
-
-  async devPortForward(localaddr) {
-    console.log("逻辑需要重新梳理");
-    process.exit();
-    // try {
-    //   await this.ensureEnv([
-    //     {
-    //       name: "DEV_PORT",
-    //       type: "input",
-    //       message: "开发暴露端口",
-    //       default: "8080",
-    //     },
-    //     {
-    //       name: "DEV_CMD",
-    //       type: "input",
-    //       default: "npm run serve",
-    //       message: "开发运行命令",
-    //     },
-    //   ]);
-    //
-    //   await this.ensureSDK();
-    //
-    //   console.debug(env.get("SDK_URL"));
-    //   const api = new BoxAPI(env.get("APP_ID"), env.get("SDK_URL"));
-    //
-    //   let appdev = new Dev(env.get("APP_ID"), this.appPath);
-    //
-    //   let out = await appdev.fakeApp("devforward");
-    //
-    //   console.debug("设置端口转发");
-    //   await api.install(out.path, { build: true });
-    //   await api.checkStatus();
-    //
-    //   console.log(
-    //     `请在浏览器中访问 ${chalk.green(
-    //       env.get("SDK_URL").replace(/sdk/, env.get("APP_ID"))
-    //     )}`
-    //   );
-    //
-    //   await appdev.portForward(localaddr);
-    // } catch (e) {
-    //   throw e;
-    // }
-  }
-}
-
-const dev = new Develop();
-
-export default {
-  dev: (addr) => dev.devPortForward(addr),
-  devShell: async (options) => {
-    try {
-      await dev.devShell(options);
-    } catch (e) {
-      console.log(chalk.red(e));
-      process.exit(1);
-    }
-
-    // 需要显示的退出，因为当shell退出后，rsync和watch的进程还在执行
-    // process.exit();
-  },
-};

package/cmds/init.js

@@ -1,125 +0,0 @@
-import path from "path";
-import inquirer from "inquirer";
-import generator, { TemplateConfig } from "../lib/generator.js";
-import { APP_FOLDER } from "../lib/utils.js";
-import env from "../lib/env.js";
-import fs from "fs";
-let fsPromises = fs.promises;
-import { debuglog } from "util";
-
-const debug = debuglog("cmd/init");
-
-export class Init {
-  constructor(context) {
-    this.context = context;
-    this.type = context.type;
-  }
-
-  async askQuestions() {
-    const questions = [
-      {
-        name: "APP_ID",
-        type: "input",
-        default: () => {
-          const name = path.basename(this.context.cwd);
-          return name;
-        },
-        message: "应用名称",
-        validate: (input) => {
-          if (!/^([a-z]|[0-9]|[\-])+$/.test(input)) {
-            return "应用名称只能包含(减号，小写字母，数字)，请重新输入";
-          }
-          return true;
-        },
-      },
-      {
-        name: "APP_DESCRIPTION",
-        type: "input",
-        default: (answers) => {
-          return answers["APP_ID"];
-        },
-        message: "应用描述",
-      },
-    ];
-    return inquirer.prompt(questions);
-  }
-
-  async createTemplates(answers) {
-    answers["APP_VERSION"] = "0.0.1";
-    env.load(path.join(this.context.cwd));
-    await generator(answers).generate(
-      APP_FOLDER.replace(".", "_"),
-      this.context.cwd,
-      {
-        prefix: APP_FOLDER,
-      }
-    );
-    debug(answers);
-    env.set(answers);
-    this.setDefaultEnvs(env);
-  }
-
-  async createReleaseFolder() {
-    await generator({}).generate(
-      "release/" + this.type,
-      path.join(this.context.cwd, APP_FOLDER),
-      {
-        prefix: "release",
-      }
-    );
-  }
-
-  async setDefaultEnvs(env) {
-    debug(TemplateConfig[this.type].defaultEnvs);
-    env.set(TemplateConfig[this.type].defaultEnvs);
-  }
-
-  async create() {
-    if (!this.type) {
-      this.type = await chooseTemplate();
-    }
-    const createConfig = async () => {
-      const answers = await this.askQuestions();
-      await this.createTemplates(answers);
-      await this.createReleaseFolder();
-    };
-    // .lazycat文件已存在时提示用户是否需要覆盖
-    await fsPromises
-      .access(
-        this.context.cwd + "/.lazycat/",
-        fs.constants.F_OK | fs.constants.W_OK
-      )
-      .then(
-        async () => {
-          const questions = [
-            {
-              name: "override",
-              type: "input",
-              default: "n",
-              message: "懒猫云已配置，是否覆盖(y/n): ",
-            },
-          ];
-          const answers = await inquirer.prompt(questions);
-          if (answers.override.toLowerCase() === "y") {
-            createConfig();
-          }
-        },
-        async () => {
-          createConfig();
-        }
-      );
-  }
-}
-
-export async function chooseTemplate() {
-  return (
-    await inquirer.prompt([
-      {
-        name: "type",
-        message: "选择项目构建模板",
-        type: "list",
-        choices: ["vue", "golang", "ionic_vue3"],
-      },
-    ])
-  )["type"];
-}

package/cmds/log.js

@@ -1,103 +0,0 @@
-import { readFileSync } from "fs";
-import { Client } from "ssh2";
-import os from "os";
-import path from "path";
-import process from "process";
-import { isValidApp, META_MARK } from "../lib/utils.js";
-import yaml from "js-yaml";
-import env, { sdkEnv } from "../lib/env.js";
-import chalk from "chalk";
-import { SSHClient, connectOptions } from "../lib/sdk.js";
-
-function StreamPromise(stream) {
-  let data = "";
-  return new Promise((resolve, reject) => {
-    stream
-      .on("data", (d) => {
-        data = d;
-      })
-      .on("close", (code, signal) => {
-        resolve(String(data));
-      })
-      .stderr.on("data", (data) => {
-        reject(String(data));
-      });
-  });
-}
-
-export async function monitor(projectName, options = {}) {
-  env.load(process.cwd());
-
-  await sdkEnv.ensure();
-
-  const sdk_url = sdkEnv.sdkUrl;
-
-  if (!sdk_url) {
-    console.log(chalk.red("无法连接SDK, 请确保已设置 DEFAULT_BOXNAME"));
-    process.exit(1);
-  }
-
-  const host = new URL(sdk_url).hostname;
-  if (projectName) {
-    await new Log(host, projectName).start();
-  } else {
-    const name = tryGuessProject(options.user);
-    // console.log(chalk.green("guess project name " + name));
-    await new Log(host, name).start();
-  }
-}
-
-function tryGuessProject(user) {
-  const { appDir, isTemplate } = isValidApp(process.cwd());
-  if (!appDir) {
-    console.log(chalk.red("无法识别为懒猫云应用"));
-    process.exit(1);
-  }
-
-  let info;
-  let appId;
-  if (isTemplate) {
-    info = yaml.load(readFileSync(path.join(appDir, "docker-compose.yml.in")));
-    appId = env.get("APP_ID");
-  } else {
-    info = yaml.load(readFileSync(path.join(appDir, "docker-compose.yml")));
-    appId = info[META_MARK]["id"];
-  }
-  return `lzc-${user || ""}-${appId}`;
-}
-
-class Log {
-  constructor(host, project) {
-    this.project = project;
-    this.host = host;
-  }
-
-  async start() {
-    const opts = await connectOptions(this.host);
-    const client = new SSHClient(opts);
-    try {
-      await client.connect();
-      let stream = await client.exec(
-        `docker-compose ls | grep -wE '^${this.project}'`
-      );
-
-      const result = await StreamPromise(stream);
-      if (result != "") {
-        stream = await client.exec(
-          `docker-compose -p ${this.project} logs -f`,
-          { pty: true }
-        );
-        stream.stdout.pipe(process.stdout);
-        stream.stderr.pipe(process.stdout);
-      } else {
-        client.close();
-      }
-    } catch (e) {
-      client.close();
-    }
-  }
-}
-
-export default {
-  monitor,
-};