esa-cli 1.0.0 → 1.0.2-beta.0

package/dist/docs/Commands_zh_CN.md

@@ -1,272 +1,384 @@
-## 命令一览
+## ESA CLI 命令
 
-### esa-cli init [name]
+**ESA CLI 提供多种命令来管理您的阿里云 ESA Functions & Pages。**
 
-初始化一个函数和Pages项目（支持框架或模板）。
+**init** - 从各种 Web 框架和模板创建新项目。**
+\*\***dev** - 启动本地开发服务器。** \***\*commit** - 提交代码并保存为新版本。**
+\*\***deploy** - 将您的 Functions & Pages 部署到阿里云。** \***\*deployments** - 管理您的部署和版本。**
+\*\***project** - 管理您的 Functions & Pages 项目。** \***\*site** - 列出您已激活的站点。**
+\*\***domain** - 管理您的 Functions & Pages 的域名绑定。** \***\*route** - 管理您的 Functions & Pages 的路由绑定。**
+\*\***login** - 使用您的阿里云账户授权 ESA CLI。** \***\*logout** - 移除 ESA CLI 访问您账户的授权。**
+\*\***config** - 修改您的本地或全局配置。** \***\*lang** - 设置 CLI 的语言。
+
+### 如何运行 ESA CLI 命令
+
+**如果你是通过全局安装的esa-cli，如果需要运行请参考以下命令**
+
+**安装方式**
 
-```bash
-esa-cli init [name]
+```
+npm i esa-cli@latest -g
 ```
 
-- 位置参数：
-  - name：项目名
+**执行命令**
 
-- 选项：
-  - -f, --framework string：选择前端框架（react/vue/nextjs...）
-  - -l, --language string：选择语言（typescript/javascript）。可选：typescript | javascript
-  - -t, --template string：指定模板名称
-  - -y, --yes boolean：对所有交互询问选择“是”（默认 false），模版采用helloworld
-  - --git boolean：在项目中初始化 git
-  - --deploy boolean：初始化完成后自动部署
+```
+esa-cli <COMMAND> <SUBCOMMAND> [PARAMETERS] [OPTIONS]
+```
 
 ---
 
-### esa-cli dev [entry]
+**如果你是在项目中本地安装 ESA CLI（而不是全局安装），运行 ESA CLI 的方式将取决于您的具体设置和包管理器。**
 
-启动本地开发服务器。
+```
+npx esa-cli <COMMAND> <SUBCOMMAND> [PARAMETERS] [OPTIONS]
+```
+
+**您可以将经常使用的 ESA CLI 命令添加为项目 package.json 文件中的脚本：**
 
-```bash
-esa-cli dev [entry]
+```
+{
+  ...
+  "scripts": {
+    "deploy": "esa-cli deploy",
+    "dev": "esa-cli dev"
+  }
+  ...
+}
 ```
 
-- 位置参数：
-  - entry：函数和Pages入口文件
+**然后您可以使用您选择的包管理器运行它们：**
 
-- 选项：
-  - -p, --port number：监听端口
-  - -m, --minify boolean：开发模式下压缩代码（默认 false）
-  - --refresh-command string：保存自动刷新前执行的命令
-  - --local-upstream string：在本地开发中作为源站的主机
-  - --debug boolean：输出调试日志（默认 false）
+```
+npm run deploy
+```
 
 ---
 
-### esa-cli commit [entry]
+## init
 
-提交代码并保存为新版本。
+**通过模板创建新项目。可选择各种 Web 框架和模板。默认安装依赖项，可选择立即部署您的项目。**
 
-```bash
-esa-cli commit [entry]
 ```
+esa-cli init [<NAME>] [OPTIONS]
+```
+
+**NAME\***可选（默认：工作目录名称）\*
+**Functions & Pages 项目的名称。这既是目录名称，也是生成的 ESA CLI 配置中的 name 属性。**
+
+**--framework, -f\***可选\*
+**选择前端框架（react/vue/nextjs...）**
+
+**--language, -l\***可选\*
+**选择编程语言（typescript/javascript）。可选：typescript | javascript**
+
+**--template, -t\***可选\*
+**指定模板名称**
+
+**--yes, -y\***可选\*
+**对所有交互询问选择"是"（默认 false），模版采用helloworld**
 
-- 选项：
-  - -m, --minify boolean：提交前压缩代码（默认 false）
-  - -a, --assets string：静态资源目录
-  - -d, --description string：版本/例程描述（跳过交互输入）
-  - -n, --name string：函数和Pages名称
+**--git\***可选\*
+**在项目中初始化 git**
+
+**--deploy\***可选\*
+**初始化完成后自动部署**
 
 ---
 
-### esa-cli deploy [entry]
+## dev
 
-生成一个代码版本，并同时部署项目到仿真和线上环境
+**启动本地开发服务器。**
 
-```bash
-esa-cli deploy [entry]
 ```
+esa-cli dev [<ENTRY>] [OPTIONS]
+```
+
+**ENTRY\***可选\*
+**函数和Pages入口文件**
+
+**--port, -p\***可选\*
+**监听端口**
+
+**--minify, -m\***可选\*
+**开发模式下压缩代码（默认 false）**
 
-- 选项：
-  - entry 可选参数，默认以 `esa.jsonc`中entry配置为准
-  - -v, --version string：指定要部署的版本（跳过交互选择）
-  - -e, --environment string：部署环境。可选：staging | production
-  - -n, --name string：函数和Pages名称
-  - -a, --assets string：静态资源目录（例如：./dist）
-  - -d, --description string：版本描述
-  - -m, --minify boolean：是否压缩代码
+**--refresh-command\***可选\*
+**保存自动刷新前执行的命令**
+
+**--local-upstream\***可选\*
+**在本地开发中作为源站的主机**
+
+**--debug\***可选\*
+**输出调试日志（默认 false）**
 
 ---
 
-### esa-cli deployments list
+## commit
 
-列出当前函数和Pages下所有代码版本。
+**提交代码并保存为新版本。**
 
-```bash
-esa-cli deployments list
 ```
+esa-cli commit [<ENTRY>] [OPTIONS]
+```
+
+**ENTRY\***可选\*
+**函数和Pages入口文件**
+
+**--minify, -m\***可选\*
+**提交前压缩代码（默认 false）**
 
-无额外选项。
+**--assets, -a\***可选\*
+**静态资源目录**
+
+**--description, -d\***可选\*
+**版本/例程描述（跳过交互输入）**
+
+**--name, -n\***可选\*
+**函数和Pages名称**
 
 ---
 
-### esa-cli deployments delete [deploymentId...]
+## deploy
 
-删除当前函数和Pages的一个或多个代码版本。
+**生成一个代码版本，并同时部署项目到仿真和线上环境。**
 
-```bash
-esa-cli deployments delete [deploymentId...]
 ```
+esa-cli deploy [<ENTRY>] [OPTIONS]
+```
+
+**ENTRY\***可选\*
+**函数和Pages入口文件，默认以 **`esa.jsonc`中entry配置为准
+
+**--version, -v\***可选\*
+**指定要部署的版本（跳过交互选择）**
+
+**--environment, -e\***可选\*
+**部署环境。可选：staging | production**
 
-- 位置参数：
-  - deploymentId...：要删除的部署版本ID（可一次传多个）
+**--name, -n\***可选\*
+**函数和Pages名称**
+
+**--assets, -a\***可选\*
+**静态资源目录（例如：./dist）**
+
+**--description, -d\***可选\*
+**版本描述**
+
+**--minify, -m\***可选\*
+**是否压缩代码**
 
 ---
 
-### esa-cli project list
+## deployments
 
-列出账号下所有的函数和Pages。
+**管理您的部署和版本。**
 
-```bash
-esa-cli project list
+### deployments list
+
+**列出当前函数和Pages下所有代码版本。**
+
+```
+esa-cli deployments list
+```
+
+### deployments delete
+
+**删除当前函数和Pages的一个或多个代码版本。**
+
+```
+esa-cli deployments delete [<DEPLOYMENT_ID>...] [OPTIONS]
 ```
 
-无额外选项。
+**DEPLOYMENT_ID\***必需\*
+**要删除的部署版本ID（可一次传多个）**
 
 ---
 
-### esa-cli project delete <projectName>
+## project
+
+**管理您的 Functions & Pages 项目。**
+
+### project list
+
+**列出账号下所有的函数和Pages。**
+
+```
+esa-cli project list
+```
 
-删除指定函数和Pages。
+### project delete
 
-```bash
-esa-cli project delete <projectName>
+**删除指定函数和Pages。**
+
+```
+esa-cli project delete <PROJECT_NAME> [OPTIONS]
 ```
 
-- 位置参数：
-  - projectName：要删除的函数或Pages名称
+**PROJECT_NAME\***必需\*
+**要删除的函数或Pages名称**
 
 ---
 
-### esa-cli site list
+## site
+
+**列出您已激活的站点。**
 
-列出账号下所有已激活站点。
+### site list
 
-```bash
+**列出账号下所有已激活站点。**
+
+```
 esa-cli site list
 ```
 
-无额外选项。
-
 ---
 
-### esa-cli domain add <domain>
+## domain
 
-绑定域名到当前函数和Pages。
+**管理您的 Functions & Pages 的域名绑定。**
 
-```bash
-esa-cli domain add <domain>
+### domain add
+
+**绑定域名到当前函数和Pages。**
+
+```
+esa-cli domain add <DOMAIN> [OPTIONS]
 ```
 
-- 位置参数：
-  - domain：要绑定的域名
+**只有在该账号下激活的站点才能绑定**
 
----
+**DOMAIN\***必需\*
+**要绑定的域名（在该账号站点下已激活）**
 
-### esa-cli domain list
+### domain list
 
-查看当前函数和Pages所有已绑定域名。
+**查看当前函数和Pages所有已绑定域名。**
 
-```bash
+```
 esa-cli domain list
 ```
 
-无额外选项。
-
----
-
-### esa-cli domain delete <domain>
+### domain delete
 
-删除当前函数和Pages下已绑定域名。
+**删除当前函数和Pages下已绑定域名。**
 
-```bash
-esa-cli domain delete <domain>
+```
+esa-cli domain delete <DOMAIN> [OPTIONS]
 ```
 
-- 位置参数：
-  - domain：要删除绑定的域名
+**DOMAIN\***必需\*
+**要删除绑定的域名**
 
 ---
 
-#### esa-cli route add
+## route
+
+**管理您的 Functions & Pages 的路由绑定。**
+
+### route add
 
-为当前函数和Pages绑定一个路由。
+**为当前函数和Pages绑定一个路由。**
 
-```bash
-esa-cli route add [route] [site] [--alias <routeName>] [--route <route>] [--site <site>]
+```
+esa-cli route add [<ROUTE>] [<SITE>] [OPTIONS]
 ```
 
-- 位置参数（可选）：
-  - route：路由值，例如：example.com/_ 或 _.example.com/\*
-  - site：站点名称，例如：example.com
+**ROUTE\***可选\*
+**路由值，例如：example.com/_ 或 _.example.com/\***
 
-- 选项：
-  - -r, --route string：路由值，例如：example.com/\*
-    - 主机名支持以 `*` 开头表示后缀匹配（如：`*.example.com`）
-    - 路径支持以 `*` 结尾表示前缀匹配（如：`/api/*`）
-  - -s, --site string：站点名称（需为已激活站点）
-  - -a, --alias string：路由名称（别名） 例如：apple、orange等
+**SITE\***可选\*
+**站点名称，例如：example.com**
 
----
+**只有在该账号下激活的站点才能绑定**
 
-### esa-cli route list
+**--route, -r\***可选*路由值，例如：example.com/*
 
-查看函数和Pages所有已绑定路由。
+- **主机名支持以 **`*` 开头表示后缀匹配（如：`*.example.com`）
+- **路径支持以 **`*` 结尾表示前缀匹配（如：`/api/*`）
 
-```bash
-esa-cli route list
-```
+**--site, -s\***可选\*
+**站点名称（需为账户下已激活站点）**
 
-无额外选项。
+**--alias, -a\***可选\*
+**路由名称（别名）例如：apple、orange等**
 
----
+### route list
+
+**查看当前函数和Pages下所有已绑定路由。**
 
-### esa-cli route delete <routeName>
+```
+esa-cli route list
+```
 
-删除函数和Pages下已绑定路由。
+### route delete
 
-```bash
-esa-cli route delete <routeName>
+**删除函数和Pages下已绑定路由。**
+
+```
+esa-cli route delete <ROUTE_NAME> [OPTIONS]
 ```
 
-- 位置参数：
-  - routeName：要删除的路由名称
+**ROUTE_NAME\***必需\*
+**要删除的路由名称**
 
 ---
 
-### esa-cli login
+## login
 
-登录。
+**使用您的阿里云账户授权 ESA CLI。**
 
-```bash
-esa-cli login
 ```
+esa-cli login [OPTIONS]
+```
+
+**--access-key-id, --ak\***可选\*
+**AccessKey ID (AK)**
+
+**--access-key-secret, --sk\***可选\*
+**AccessKey Secret (SK)**
+
+**--endpoint, -e\***可选\*
+**API 端点 URL 例子: esa.cn-hangzhou.aliyuncs.com**
 
-- 选项：
-  - --access-key-id, --ak string：AccessKey ID (AK)
-  - --access-key-secret, --sk string：AccessKey Secret (SK)
-- 从环境变量中读取process.env
-  - ESA_ACCESS_KEY_ID
-  - ESA_ACCESS_KEY_SECRET
+**环境变量**从环境变量中读取：
+
+- **ESA_ACCESS_KEY_ID**
+- **ESA_ACCESS_KEY_SECRET**
+- **ESA_ENDPOINT**
 
 ---
 
-### esa-cli logout
+## logout
 
-退出登录。
+**移除 ESA CLI 访问您账户的授权。**
 
-```bash
+```
 esa-cli logout
 ```
 
 ---
 
-### esa-cli config [-l | -g]
+## config
 
-修改本地或全局配置。
+**修改您的本地或全局配置。**
 
-```bash
-esa-cli config [--local] [--global]
+```
+esa-cli config [OPTIONS]
 ```
 
-- 选项：
-  - -l, --local boolean：编辑本地配置文件（默认 false）
-  - -g, --global boolean：编辑全局配置文件（默认 false）
+**--local, -l\***可选\*
+**编辑本地配置文件（默认 false）**
+
+**--global, -g\***可选\*
+**编辑全局配置文件（默认 false）**
 
 ---
 
-### esa-cli lang
+## lang
 
-设置 CLI 语言。
+**设置 CLI 的语言。**
 
-```bash
+```
 esa-cli lang
 ```

package/dist/docs/Config_en.md

@@ -8,13 +8,15 @@ This document describes the structure, parameters, and example of the ESA (Edge
 
 ### Parameter description
 
-| **Parameter**   | **Description**                                                                                                                              |
-| --------------- | -------------------------------------------------------------------------------------------------------------------------------------------- |
-| **name**        | Target project name. If it exists, deployment goes into it; otherwise, a new project is created.                                             |
-| **description** | Project description. Optional, used to briefly document the purpose or functionality.                                                        |
-| **entry**       | Dynamic function entry file path, e.g.,`./src/index.ts`. Optional, set only when using a function.                                           |
-| **assets**      | Static asset hosting configuration (each Pages project supports only one set of static assets). Includes `directory` and `notFoundStrategy`. |
-| **dev**         | Local development configuration. Optional; used to set dev server port and proxy.                                                            |
+| **Parameter**      | **Description**                                                                                                                              |
+| ------------------ | -------------------------------------------------------------------------------------------------------------------------------------------- |
+| **name**           | Target project name. If it exists, deployment goes into it; otherwise, a new project is created.                                             |
+| **description**    | Project description. Optional, used to briefly document the purpose or functionality.                                                        |
+| **buildCommand**   | Build command for the project, e.g.,`npm run build`. Only effective when importing from ESA console GitHub repository, not when using CLI.   |
+| **installCommand** | Install dependencies command, e.g.,`npm install`. Only effective when importing from ESA console GitHub repository, not when using CLI.      |
+| **entry**          | Dynamic function entry file path, e.g.,`./src/index.ts`. Optional, set only when using a function.                                           |
+| **assets**         | Static asset hosting configuration (each Pages project supports only one set of static assets). Includes `directory` and `notFoundStrategy`. |
+| **dev**            | Local development configuration. Optional; used to set dev server port and proxy.                                                            |
 
 #### Field structure
 
@@ -22,6 +24,10 @@ This document describes the structure, parameters, and example of the ESA (Edge
   - Project name. Required.
 - **description**: `string`
   - Project description. Optional.
+- **buildCommand**: `string`
+  - Build command for the project, e.g., `npm run build`. Only effective when importing from ESA console GitHub repository, not when using CLI.
+- **installCommand**: `string`
+  - Install dependencies command, e.g., `npm install`. Only effective when importing from ESA console GitHub repository, not when using CLI.
 - **entry**: `string`
   - Dynamic function entry file path, e.g., `./src/index.ts`. Optional.
 - **assets**: `object`

package/dist/docs/Config_zh_CN.md

@@ -8,13 +8,15 @@
 
 ### 参数说明
 
-| **参数**        | **说明**                                                                                             |
-| --------------- | ---------------------------------------------------------------------------------------------------- |
-| **name**        | 目标项目名称。若项目已存在，则部署到该项目；若不存在，则以此名称创建新项目。                         |
-| **description** | 项目描述，可选字段，用于简要说明项目功能或用途。                                                     |
-| **entry**       | 动态函数入口文件路径，例如 `./src/index.ts`。可选字段，用于指定动态函数的入口。                      |
-| **assets**      | 静态资源托管配置（每个 Pages 项目仅支持一组静态资源）。包含 `directory` 和 `notFoundStrategy` 字段。 |
-| **dev**         | 本地开发工具配置，可选字段，用于设置开发服务器端口和代理地址。                                       |
+| **参数**           | **说明**                                                                                             |
+| ------------------ | ---------------------------------------------------------------------------------------------------- |
+| **name**           | 目标项目名称。若项目已存在，则部署到该项目；若不存在，则以此名称创建新项目。                         |
+| **description**    | 项目描述，可选字段，用于简要说明项目功能或用途。                                                     |
+| **buildCommand**   | 项目构建命令，例如 `npm run build`。仅在通过ESA控制台 GitHub 仓库导入时生效，使用 CLI 时不生效。     |
+| **installCommand** | 安装依赖命令，例如 `npm install`。仅在通过ESA控制台 GitHub 仓库导入时生效，使用 CLI 时不生效。       |
+| **entry**          | 动态函数入口文件路径，例如 `./src/index.ts`。可选字段，用于指定动态函数的入口。                      |
+| **assets**         | 静态资源托管配置（每个 Pages 项目仅支持一组静态资源）。包含 `directory` 和 `notFoundStrategy` 字段。 |
+| **dev**            | 本地开发工具配置，可选字段，用于设置开发服务器端口和代理地址。                                       |
 
 #### 字段结构
 
@@ -22,6 +24,10 @@
   - 项目名称，必填字段，用于标识项目。
 - **description**: `string`
   - 项目描述，可选字段，用于记录项目的功能或用途。
+- **buildCommand**: `string`
+  - 项目构建命令，例如 `npm run build`。仅在通过 GitHub 仓库导入时生效，使用 CLI 时不生效。
+- **installCommand**: `string`
+  - 安装依赖命令，例如 `npm install`。仅在通过 GitHub 仓库导入时生效，使用 CLI 时不生效。
 - **entry**: `string`
   - 动态函数入口文件路径，例如 `./src/index.ts`。可选字段，仅在需要动态函数时配置。
 - **assets?**: `object`

package/dist/i18n/locales.json

@@ -1310,5 +1310,13 @@
   "kv_parse_failed": {
     "en": "kv.json parse failed, use empty local kv store.",
     "zh_CN": "kv.json 解析失败，使用空本地 kv 存储。"
+  },
+  "not_active": {
+    "en": "Functions and Pages is not active, please activate it first. Visit: https://esa.console.aliyun.com/edge/pages to activate.",
+    "zh_CN": "函数和 Pages 未激活，请先激活。访问：https://esa.console.aliyun.com/edge/pages 激活。"
+  },
+  "login_option_endpoint": {
+    "en": "Endpoint",
+    "zh_CN": "Endpoint"
   }
 }

package/dist/libs/apiService.js

@@ -74,7 +74,15 @@ export class ApiService {
                 };
                 const response = yield this.client.callApi(params, request, runtime);
                 if (response.statusCode === 200) {
-                    return { success: true };
+                    if (response.body.Status === 'Running') {
+                        return { success: true };
+                    }
+                    else {
+                        return {
+                            success: false,
+                            message: t('not_active').d('Functions and Pages is not active, please activate it first. Visit: https://esa.console.aliyun.com/edge/pages to activate.')
+                        };
+                    }
                 }
                 else if (response.statusCode === 403) {
                     return {

package/dist/utils/compress.js

@@ -32,7 +32,7 @@ import t from '../i18n/index.js';
 import logger from '../libs/logger.js';
 import { checkEdgeRoutineType, EDGE_ROUTINE_TYPE } from './checkAssetsExist.js';
 import { getProjectConfig, readEdgeRoutineFile } from './fileUtils/index.js';
-const compress = (scriptEntry_1, assetsDir_1, ...args_1) => __awaiter(void 0, [scriptEntry_1, assetsDir_1, ...args_1], void 0, function* (scriptEntry, assetsDir, minify = false, projectPath) {
+const compress = (scriptEntry_1, assetsDir_1, ...args_1) => __awaiter(void 0, [scriptEntry_1, assetsDir_1, ...args_1], void 0, function* (scriptEntry, assetsDir, minify = false, projectPath, noBundle = false) {
     var _a;
     let code;
     const zip = new AdmZip();
@@ -94,8 +94,14 @@ const compress = (scriptEntry_1, assetsDir_1, ...args_1) => __awaiter(void 0, [s
     if (routineType === EDGE_ROUTINE_TYPE.JS_ONLY ||
         routineType === EDGE_ROUTINE_TYPE.JS_AND_ASSETS) {
         const buildEntry = path.resolve(projectPath !== null && projectPath !== void 0 ? projectPath : '', entry !== null && entry !== void 0 ? entry : '');
-        yield prodBuild(minify, buildEntry, projectPath);
-        code = readEdgeRoutineFile(projectPath);
+        if (noBundle) {
+            // Skip esbuild bundling, use original entry source directly
+            code = fs.readFileSync(buildEntry, 'utf-8');
+        }
+        else {
+            yield prodBuild(minify, buildEntry, projectPath);
+            code = readEdgeRoutineFile(projectPath);
+        }
         zip.addFile(`routine/index.js`, Buffer.from(code || ''));
         fileList.push('routine/index.js');
         const relativeEntry = path

package/dist/utils/fileUtils/index.js

@@ -139,7 +139,7 @@ export function readConfigFile(configPath) {
         }
         catch (error) {
             logger.error(`Error parsing config file: ${error}`);
-            return null;
+            process.exit(1);
         }
     }
     return null;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "esa-cli",
-  "version": "1.0.0",
+  "version": "1.0.2-beta.0",
   "description": "A CLI for operating Alibaba Cloud ESA Functions and Pages.",
   "main": "bin/enter.cjs",
   "type": "module",