Skip to content

构建与打包

本节介绍如何为生产环境构建项目以及如何打包以进行分发。

构建项目

要为生产环境构建所有包,请从项目根目录运行以下命令:

bash
npm run build

此命令将按正确的顺序(shared -> web-ui -> cli)构建所有工作区。该过程包括将所有 TypeScript 编译为 JavaScript,并将构建好的前端应用程序复制到 cli 包中,以便为其提供服务。

打包与分发

要将整个应用程序(CLI 和 Web UI)捆绑到一个可分发的独立文件中,您可以使用 package 脚本。这对于与同事共享应用程序或进行部署非常理想。

  1. 创建软件包: 从项目根目录运行以下命令:

    bash
    npm run package
  2. 查找输出文件: 此命令将在 packages/cli 目录内创建一个 .tgz 文件(例如 gendoc-cli-1.0.0.tgz)。

  3. 安装并运行: 任何人都可以通过运行以下命令从该文件安装应用程序:

    bash
    # 示例路径,请使用 .tgz 文件的实际路径
    npm install -g ./packages/cli/gendoc-cli-1.0.0.tgz

    安装后,gendoc 命令将在其终端中全局可用。

Released under the MIT License.