coda-cli 1.0.0

package/src/cli-api/index.js

@@ -0,0 +1,22 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.event = exports.request = exports.packages = exports.git = exports.fs = exports.date = exports.data = exports.childProcess = void 0;
+const cmd_1 = require("./cmd");
+Object.defineProperty(exports, "childProcess", { enumerable: true, get: function () { return cmd_1.childProcess; } });
+const data_1 = __importDefault(require("./data"));
+exports.data = data_1.default;
+const date_1 = __importDefault(require("./date"));
+exports.date = date_1.default;
+const fs_1 = __importDefault(require("./fs"));
+exports.fs = fs_1.default;
+const git_1 = __importDefault(require("./git"));
+exports.git = git_1.default;
+const packages_1 = __importDefault(require("./packages"));
+exports.packages = packages_1.default;
+const request_1 = __importDefault(require("./request"));
+exports.request = request_1.default;
+const event_1 = __importDefault(require("./event"));
+exports.event = event_1.default;

package/src/cli-api/index.ts

@@ -0,0 +1,10 @@
+import {childProcess} from './cmd';
+import data from './data';
+import date from './date';
+import fs from './fs';
+import git from './git';
+import packages from './packages';
+import request from './request';
+import event from './event';
+
+export {childProcess, data, date, fs, git, packages, request, event};

package/src/cli-api/packages.js

@@ -0,0 +1,69 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.Packages = void 0;
+const npm_check_updates_1 = __importDefault(require("npm-check-updates"));
+const semver_1 = __importDefault(require("semver"));
+const request_1 = __importDefault(require("./request"));
+exports.Packages = {
+    /**
+     * 更新 npm 包
+     * @param path package.json 文件路径
+     * @param reject 排除不需要更新的包（支持字符串或字符串数组）
+     * @returns 返回更新后的依赖配置对象
+     */
+    async update(path, reject) {
+        const upgraded = await (0, npm_check_updates_1.default)({
+            packageFile: path,
+            upgrade: true,
+            install: 'always',
+            reject: reject,
+        });
+        return upgraded;
+    },
+    /**
+     * 检查 CLI 版本
+     * @param url CLI 发布的仓库/地址
+     * @param localVersion 安装在 npm 全局目录下的本地 CLI 版本
+     * @returns 若有新版本则返回包含名称和新版本号的对象，否则返回空对象
+     */
+    async checkVersion(url, localVersion) {
+        let response = await request_1.default.ajax(url, 'get');
+        if (response.status === 'success') {
+            let remoteVersion = response.data['version']
+                ? response.data['version']
+                : response.data['dist-tags']['latest'];
+            let res = semver_1.default.lt(localVersion, remoteVersion);
+            if (res) {
+                return {
+                    name: response.data.name,
+                    version: remoteVersion,
+                };
+            }
+            else {
+                return {};
+            }
+        }
+        else {
+            return {};
+        }
+    },
+    /**
+     * 查询 npm 包的最新版本
+     * @param url npm 仓库地址
+     * @param defaultVersion 网络错误时使用的默认版本号
+     * @returns 返回版本号字符串
+     */
+    async getLatestVersion(url, defaultVersion) {
+        let data = await request_1.default.ajax(url, 'get');
+        if (data.status === 'success') {
+            return data.data['version'];
+        }
+        else {
+            return defaultVersion;
+        }
+    },
+};
+exports.default = exports.Packages;

package/src/cli-api/packages.ts

@@ -0,0 +1,73 @@
+import ncu from 'npm-check-updates';
+import semver from 'semver';
+import Request from './request';
+
+/**
+ * 版本检查结果接口
+ */
+export interface VersionInfo {
+  name?: string;
+  version?: string;
+}
+
+export const Packages = {
+  /**
+   * 更新 npm 包
+   * @param path package.json 文件路径
+   * @param reject 排除不需要更新的包（支持字符串或字符串数组）
+   * @returns 返回更新后的依赖配置对象
+   */
+  async update(path: string, reject?: string | string[]): Promise<any> {
+    const upgraded = await ncu({
+      packageFile: path,
+      upgrade: true,
+      install: 'always',
+      reject: reject,
+    });
+
+    return upgraded;
+  },
+
+  /**
+   * 检查 CLI 版本
+   * @param url CLI 发布的仓库/地址
+   * @param localVersion 安装在 npm 全局目录下的本地 CLI 版本
+   * @returns 若有新版本则返回包含名称和新版本号的对象，否则返回空对象
+   */
+  async checkVersion(url: string, localVersion: string): Promise<VersionInfo> {
+    let response = await Request.ajax(url, 'get');
+    if (response.status === 'success') {
+      let remoteVersion = response.data['version']
+        ? response.data['version']
+        : response.data['dist-tags']['latest'];
+      let res = semver.lt(localVersion, remoteVersion);
+      if (res) {
+        return {
+          name: response.data.name,
+          version: remoteVersion,
+        };
+      } else {
+        return {};
+      }
+    } else {
+      return {};
+    }
+  },
+
+  /**
+   * 查询 npm 包的最新版本
+   * @param url npm 仓库地址
+   * @param defaultVersion 网络错误时使用的默认版本号
+   * @returns 返回版本号字符串
+   */
+  async getLatestVersion(url: string, defaultVersion: string): Promise<string> {
+    let data = await Request.ajax(url, 'get');
+    if (data.status === 'success') {
+      return data.data['version'];
+    } else {
+      return defaultVersion;
+    }
+  },
+};
+
+export default Packages;

package/src/cli-api/request.js

@@ -0,0 +1,55 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.Request = void 0;
+const axios_1 = __importDefault(require("axios"));
+exports.Request = {
+    /**
+     * HTTP 请求方法
+     * @param url 请求链接
+     * @param method HTTP 请求方法 (如 GET, POST 等)
+     * @param params 请求参数
+     * @param headers 请求头
+     * @param timeout 超时时间（毫秒）
+     * @returns 返回包含状态和数据的 Promise 对象
+     */
+    ajax(url, method, params, headers, timeout) {
+        const config = {
+            url: url,
+            method: method,
+        };
+        if (params) {
+            config.data = params;
+        }
+        if (headers) {
+            config.headers = headers;
+        }
+        axios_1.default.defaults.timeout = timeout ? timeout : 10000;
+        return new Promise(resolve => {
+            (0, axios_1.default)(config)
+                .then(response => {
+                if (response.status === 200) {
+                    resolve({
+                        status: 'success',
+                        data: response.data,
+                    });
+                }
+                else {
+                    resolve({
+                        status: 'error',
+                        data: response.data?.message || '未知错误',
+                    });
+                }
+            })
+                .catch(error => {
+                resolve({
+                    status: 'error',
+                    data: error.message,
+                });
+            });
+        });
+    },
+};
+exports.default = exports.Request;

package/src/cli-api/request.ts

@@ -0,0 +1,67 @@
+import axios, {Method, AxiosRequestConfig} from 'axios';
+
+/**
+ * 请求结果接口
+ */
+export interface AjaxResult {
+  status: 'success' | 'error';
+  data: any;
+}
+
+export const Request = {
+  /**
+   * HTTP 请求方法
+   * @param url 请求链接
+   * @param method HTTP 请求方法 (如 GET, POST 等)
+   * @param params 请求参数
+   * @param headers 请求头
+   * @param timeout 超时时间（毫秒）
+   * @returns 返回包含状态和数据的 Promise 对象
+   */
+  ajax(
+    url: string,
+    method: Method | string,
+    params?: any,
+    headers?: Record<string, any>,
+    timeout?: number,
+  ): Promise<AjaxResult> {
+    const config: AxiosRequestConfig = {
+      url: url,
+      method: method,
+    };
+
+    if (params) {
+      config.data = params;
+    }
+    if (headers) {
+      config.headers = headers;
+    }
+
+    axios.defaults.timeout = timeout ? timeout : 10000;
+
+    return new Promise(resolve => {
+      axios(config)
+        .then(response => {
+          if (response.status === 200) {
+            resolve({
+              status: 'success',
+              data: response.data,
+            });
+          } else {
+            resolve({
+              status: 'error',
+              data: response.data?.message || '未知错误',
+            });
+          }
+        })
+        .catch(error => {
+          resolve({
+            status: 'error',
+            data: error.message,
+          });
+        });
+    });
+  },
+};
+
+export default Request;

package/src/cli-core/cli.js

@@ -0,0 +1,135 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.cli = cli;
+const ora_1 = __importDefault(require("ora"));
+const chalk_1 = __importDefault(require("chalk"));
+const inquirer_1 = __importDefault(require("inquirer"));
+/**
+ * CLI 交互与日志工具函数
+ */
+function cli() {
+    const spinner = (0, ora_1.default)({
+        interval: 70,
+    });
+    function clean() {
+        spinner.stop();
+        spinner.text = '';
+    }
+    return {
+        /**
+         * 为 CLI 提示添加交互问题
+         * @param questions 使用 inquirer 配置，请参阅文档 https://www.npmjs.com/package/inquirer
+         * @returns 返回 Promise 对象
+         */
+        addQuestions(questions) {
+            return Promise.resolve(inquirer_1.default.prompt(questions));
+        },
+        /**
+         * 加载中动画方法集合
+         */
+        loading: {
+            /**
+             * 开始加载动画
+             * @param text 提示文本
+             */
+            start(text) {
+                clean();
+                spinner.start(`${text}\n`);
+            },
+            /**
+             * 显示成功状态
+             * @param text 提示文本
+             */
+            succeed(text) {
+                clean();
+                spinner.succeed(text);
+            },
+            /**
+             * 显示失败状态
+             * @param text 提示文本
+             */
+            fail(text) {
+                clean();
+                spinner.fail(text);
+            },
+            /**
+             * 显示警告状态
+             * @param text 提示文本
+             */
+            warn(text) {
+                clean();
+                spinner.warn(text);
+            },
+            /**
+             * 显示信息状态
+             * @param text 提示文本
+             */
+            info(text) {
+                clean();
+                spinner.info(text);
+            },
+            /**
+             * 清除加载状态
+             */
+            clean,
+        },
+        /**
+         * 控制台日志输出方法集合
+         */
+        log: {
+            /**
+             * 输出普通信息日志
+             * @param msg 消息文本
+             * @param datas 附加数据
+             */
+            info(msg, ...datas) {
+                console.log(chalk_1.default.gray.bold(msg, ...datas));
+            },
+            /**
+             * 输出成功日志
+             * @param msg 消息文本
+             * @param datas 附加数据
+             */
+            success(msg, ...datas) {
+                console.log(chalk_1.default.green.bold(msg, ...datas));
+            },
+            /**
+             * 输出错误日志
+             * @param msg 消息文本
+             * @param datas 附加数据
+             */
+            error(msg, ...datas) {
+                console.log(chalk_1.default.red.bold(msg, ...datas));
+            },
+            /**
+             * 输出警告日志
+             * @param msg 消息文本
+             * @param datas 附加数据
+             */
+            warn(msg, ...datas) {
+                console.log(chalk_1.default.hex('#FF8880').bold(msg, ...datas));
+            },
+            /**
+             * 深度打印 JSON 对象
+             * @param obj JSON 对象
+             */
+            printObject(obj) {
+                console.dir(obj, { depth: null });
+            },
+            /**
+             * 仅在调试模式下打印。如果使用此方法，需设置 process.env['DEBUG_ENV'] = 'true'
+             * @param msg 消息文本
+             * @param datas 附加数据
+             */
+            debug(msg, ...datas) {
+                if (process.env['DEBUG_ENV'] === 'true') {
+                    console.log(chalk_1.default.blue.bold(msg, ...datas));
+                }
+            },
+        },
+    };
+}
+exports.default = cli;

package/src/cli-core/cli.ts

@@ -0,0 +1,145 @@
+import ora from 'ora';
+import chalk from 'chalk';
+import inquirer, {Answers, PromptSession} from 'inquirer';
+
+/**
+ * CLI 交互与日志工具函数
+ */
+export function cli() {
+  const spinner = ora({
+    interval: 70,
+  });
+
+  function clean(): void {
+    spinner.stop();
+    spinner.text = '';
+  }
+
+  return {
+    /**
+     * 为 CLI 提示添加交互问题
+     * @param questions 使用 inquirer 配置，请参阅文档 https://www.npmjs.com/package/inquirer
+     * @returns 返回 Promise 对象
+     */
+    addQuestions(questions: PromptSession): Promise<Answers> {
+      return Promise.resolve(inquirer.prompt(questions));
+    },
+
+    /**
+     * 加载中动画方法集合
+     */
+    loading: {
+      /**
+       * 开始加载动画
+       * @param text 提示文本
+       */
+      start(text: string): void {
+        clean();
+        spinner.start(`${text}\n`);
+      },
+
+      /**
+       * 显示成功状态
+       * @param text 提示文本
+       */
+      succeed(text: string): void {
+        clean();
+        spinner.succeed(text);
+      },
+
+      /**
+       * 显示失败状态
+       * @param text 提示文本
+       */
+      fail(text: string): void {
+        clean();
+        spinner.fail(text);
+      },
+
+      /**
+       * 显示警告状态
+       * @param text 提示文本
+       */
+      warn(text: string): void {
+        clean();
+        spinner.warn(text);
+      },
+
+      /**
+       * 显示信息状态
+       * @param text 提示文本
+       */
+      info(text: string): void {
+        clean();
+        spinner.info(text);
+      },
+
+      /**
+       * 清除加载状态
+       */
+      clean,
+    },
+
+    /**
+     * 控制台日志输出方法集合
+     */
+    log: {
+      /**
+       * 输出普通信息日志
+       * @param msg 消息文本
+       * @param datas 附加数据
+       */
+      info(msg: string, ...datas: any[]): void {
+        console.log(chalk.gray.bold(msg, ...datas));
+      },
+
+      /**
+       * 输出成功日志
+       * @param msg 消息文本
+       * @param datas 附加数据
+       */
+      success(msg: string, ...datas: any[]): void {
+        console.log(chalk.green.bold(msg, ...datas));
+      },
+
+      /**
+       * 输出错误日志
+       * @param msg 消息文本
+       * @param datas 附加数据
+       */
+      error(msg: string, ...datas: any[]): void {
+        console.log(chalk.red.bold(msg, ...datas));
+      },
+
+      /**
+       * 输出警告日志
+       * @param msg 消息文本
+       * @param datas 附加数据
+       */
+      warn(msg: string, ...datas: any[]): void {
+        console.log(chalk.hex('#FF8880').bold(msg, ...datas));
+      },
+
+      /**
+       * 深度打印 JSON 对象
+       * @param obj JSON 对象
+       */
+      printObject(obj: any): void {
+        console.dir(obj, {depth: null});
+      },
+
+      /**
+       * 仅在调试模式下打印。如果使用此方法，需设置 process.env['DEBUG_ENV'] = 'true'
+       * @param msg 消息文本
+       * @param datas 附加数据
+       */
+      debug(msg: string, ...datas: any[]): void {
+        if (process.env['DEBUG_ENV'] === 'true') {
+          console.log(chalk.blue.bold(msg, ...datas));
+        }
+      },
+    },
+  };
+}
+
+export default cli;

package/src/cli-core/index.js

@@ -0,0 +1,51 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.Publish = exports.Subscribe = exports.ChildProcess = exports.CLI = exports.Wait = exports.Base = void 0;
+const cli_1 = __importDefault(require("./cli"));
+const queue_1 = __importDefault(require("./queue"));
+const cli_api_1 = require("../cli-api");
+Object.defineProperty(exports, "ChildProcess", { enumerable: true, get: function () { return cli_api_1.childProcess; } });
+const watcher_1 = require("./watcher");
+Object.defineProperty(exports, "Subscribe", { enumerable: true, get: function () { return watcher_1.Subscribe; } });
+Object.defineProperty(exports, "Publish", { enumerable: true, get: function () { return watcher_1.Publish; } });
+const lang_1 = require("../service/lang");
+// 默认的生命周期阶段数组
+const defaultLifecycle = ['init', 'prompt', 'default', 'writing', 'install', 'end'];
+const Wait = (0, queue_1.default)();
+exports.Wait = Wait;
+const CLI = (0, cli_1.default)();
+exports.CLI = CLI;
+// 开始显示核心启动加载提示
+CLI.loading.start(lang_1.Lang.BUILDIN.CORE_STRTUP);
+const Base = {
+    // 状态对象
+    state: {},
+    /**
+     * 扩展并注册运行时生命周期任务
+     * @param runtimeLifecycle 运行时生命周期对象
+     */
+    extends(runtimeLifecycle) {
+        defaultLifecycle.forEach(task => {
+            if (Object.prototype.hasOwnProperty.call(runtimeLifecycle, task)) {
+                const taskFn = runtimeLifecycle[task];
+                if (taskFn) {
+                    Wait.enqueue(taskFn);
+                }
+            }
+        });
+        CLI.loading.succeed(lang_1.Lang.BUILDIN.CORE_STRTUP_DONE);
+        Wait.next();
+    },
+};
+exports.Base = Base;
+exports.default = {
+    Base,
+    Wait,
+    CLI,
+    ChildProcess: cli_api_1.childProcess,
+    Subscribe: watcher_1.Subscribe,
+    Publish: watcher_1.Publish,
+};

package/src/cli-core/index.ts

@@ -0,0 +1,58 @@
+import cli from './cli';
+import queue from './queue';
+import {childProcess as ChildProcess} from '../cli-api';
+import {Subscribe, Publish} from './watcher';
+import {Lang} from '../service/lang';
+
+/**
+ * 生命周期任务函数类型
+ */
+type LifecycleTask = () => void;
+
+/**
+ * 运行时生命周期配置接口
+ */
+type RuntimeLifecycle = Partial<Record<string, LifecycleTask>>;
+
+// 默认的生命周期阶段数组
+const defaultLifecycle = ['init', 'prompt', 'default', 'writing', 'install', 'end'];
+
+const Wait = queue();
+const CLI = cli();
+
+// 开始显示核心启动加载提示
+CLI.loading.start(Lang.BUILDIN.CORE_STRTUP);
+
+const Base = {
+  // 状态对象
+  state: {} as Record<string, any>,
+
+  /**
+   * 扩展并注册运行时生命周期任务
+   * @param runtimeLifecycle 运行时生命周期对象
+   */
+  extends(runtimeLifecycle: RuntimeLifecycle): void {
+    defaultLifecycle.forEach(task => {
+      if (Object.prototype.hasOwnProperty.call(runtimeLifecycle, task)) {
+        const taskFn = runtimeLifecycle[task];
+        if (taskFn) {
+          Wait.enqueue(taskFn);
+        }
+      }
+    });
+
+    CLI.loading.succeed(Lang.BUILDIN.CORE_STRTUP_DONE);
+    Wait.next();
+  },
+};
+
+export {Base, Wait, CLI, ChildProcess, Subscribe, Publish};
+
+export default {
+  Base,
+  Wait,
+  CLI,
+  ChildProcess,
+  Subscribe,
+  Publish,
+};