esa-cli 0.0.2-beta.21 → 0.0.2-beta.23

package/dist/utils/fileUtils/index.js

@@ -17,8 +17,31 @@ import { getDirName, getRoot } from './base.js';
 const projectConfigFile = 'esa.toml';
 const __dirname = getDirName(import.meta.url);
 const root = getRoot();
-export const projectConfigPath = path.join(root, projectConfigFile);
+// Function to get the actual project config file path (supports both .jsonc and .toml)
+export const getProjectConfigPath = (filePath = root) => {
+    const configFormats = ['esa.jsonc', 'esa.toml'];
+    for (const format of configFormats) {
+        const configPath = path.join(filePath, format);
+        if (fs.existsSync(configPath)) {
+            return configPath;
+        }
+    }
+    // Default to .jsonc if no config file exists
+    return path.join(filePath, 'esa.jsonc');
+};
+export const projectConfigPath = getProjectConfigPath();
 export const cliConfigPath = path.join(os.homedir(), '.esa/config/default.toml');
+// Function to get the actual config file path (supports both .toml and .jsonc)
+export const getCliConfigPath = () => {
+    const configDir = path.join(os.homedir(), '.esa/config');
+    const jsoncPath = path.join(configDir, 'default.jsonc');
+    const tomlPath = path.join(configDir, 'default.toml');
+    // Check if JSONC file exists first, then fallback to TOML
+    if (fs.existsSync(jsoncPath)) {
+        return jsoncPath;
+    }
+    return tomlPath;
+};
 export const hiddenConfigDir = path.join(os.homedir(), '.esa/config');
 export const generateHiddenConfigDir = () => {
     if (!fs.existsSync(hiddenConfigDir)) {
@@ -28,7 +51,7 @@ export const generateHiddenConfigDir = () => {
 export const generateToml = (path) => {
     if (!fs.existsSync(path)) {
         fs.writeFileSync(path, '', 'utf-8');
-        // 添加默认的endpoint
+        // Add default endpoint
         const defaultConfig = {
             endpoint: 'esa.cn-hangzhou.aliyuncs.com'
         };
@@ -37,20 +60,34 @@ export const generateToml = (path) => {
 };
 export const generateDefaultConfig = () => {
     generateHiddenConfigDir();
-    generateToml(cliConfigPath);
+    const configPath = getCliConfigPath();
+    generateToml(configPath);
 };
 export function updateProjectConfigFile(configUpdate_1) {
     return __awaiter(this, arguments, void 0, function* (configUpdate, filePath = root) {
-        const configPath = path.join(filePath, projectConfigFile);
+        const configPath = getProjectConfigPath(filePath);
         try {
             let configFileContent = yield fsPromises.readFile(configPath, 'utf8');
-            let config = toml.parse(configFileContent);
-            config = Object.assign(Object.assign({}, config), configUpdate);
-            const updatedConfigString = toml.stringify(config);
+            let config;
+            let updatedConfigString;
+            // Detect file format based on file extension
+            if (configPath.endsWith('.jsonc') || configPath.endsWith('.json')) {
+                // Handle JSONC format
+                const jsonContent = configFileContent.replace(/\/\*[\s\S]*?\*\/|\/\/.*$/gm, '');
+                config = JSON.parse(jsonContent);
+                config = Object.assign(Object.assign({}, config), configUpdate);
+                updatedConfigString = JSON.stringify(config, null, 2) + '\n';
+            }
+            else {
+                // Handle TOML format (default)
+                config = toml.parse(configFileContent);
+                config = Object.assign(Object.assign({}, config), configUpdate);
+                updatedConfigString = toml.stringify(config);
+            }
             yield fsPromises.writeFile(configPath, updatedConfigString);
         }
         catch (error) {
-            logger.error(`Error updating TOML file: ${error}`);
+            logger.error(`Error updating config file: ${error}`);
             logger.pathEacces(__dirname);
         }
     });
@@ -58,16 +95,30 @@ export function updateProjectConfigFile(configUpdate_1) {
 export function updateCliConfigFile(configUpdate) {
     return __awaiter(this, void 0, void 0, function* () {
         try {
-            let configFileContent = yield fsPromises.readFile(cliConfigPath, 'utf8');
-            let config = toml.parse(configFileContent);
-            config = Object.assign(Object.assign({}, config), configUpdate);
-            const updatedConfigString = toml.stringify(config);
-            yield fsPromises.writeFile(cliConfigPath, updatedConfigString);
+            const configPath = getCliConfigPath();
+            let configFileContent = yield fsPromises.readFile(configPath, 'utf8');
+            let config;
+            let updatedConfigString;
+            // Detect file format based on file extension
+            if (configPath.endsWith('.jsonc') || configPath.endsWith('.json')) {
+                // Handle JSONC format
+                const jsonContent = configFileContent.replace(/\/\*[\s\S]*?\*\/|\/\/.*$/gm, '');
+                config = JSON.parse(jsonContent);
+                config = Object.assign(Object.assign({}, config), configUpdate);
+                updatedConfigString = JSON.stringify(config, null, 2) + '\n';
+            }
+            else {
+                // Handle TOML format (default)
+                config = toml.parse(configFileContent);
+                config = Object.assign(Object.assign({}, config), configUpdate);
+                updatedConfigString = toml.stringify(config);
+            }
+            yield fsPromises.writeFile(configPath, updatedConfigString);
         }
         catch (error) {
-            logger.error(`Error updating TOML file: ${error}`);
+            logger.error(`Error updating config file: ${error}`);
             logger.pathEacces(__dirname);
-            throw new Error('Login error');
+            throw new Error('Config update error');
         }
     });
 }
@@ -88,7 +139,6 @@ export function readConfigFile(configPath) {
             }
         }
         catch (error) {
-            console.log(error);
             logger.error(`Error parsing config file: ${error}`);
             return null;
         }
@@ -96,7 +146,8 @@ export function readConfigFile(configPath) {
     return null;
 }
 export function getCliConfig() {
-    const res = readConfigFile(cliConfigPath);
+    const configPath = getCliConfigPath();
+    const res = readConfigFile(configPath);
     if (!res) {
         return null;
     }
@@ -133,7 +184,7 @@ export function getConfigurations() {
     }
 }
 export function generateConfigFile(projectName_1, initConfigs_1, targetDir_1) {
-    return __awaiter(this, arguments, void 0, function* (projectName, initConfigs, targetDir, configFormat = 'toml', notFoundStrategy) {
+    return __awaiter(this, arguments, void 0, function* (projectName, initConfigs, targetDir, configFormat = 'jsonc', notFoundStrategy) {
         var _a, _b;
         const outputDir = targetDir !== null && targetDir !== void 0 ? targetDir : process.cwd();
         const currentDirName = path.basename(outputDir);

package/dist/utils/installDeno.js

@@ -66,7 +66,7 @@ export function installDeno() {
             default:
                 installCommand = `sh ${p}/install.sh`;
         }
-        logger.warn(t('install_runtime_tip').d(`🔔 Runtime must be installed to use esa dev. Installing...`));
+        logger.warn(t('install_runtime_tip').d(`🔔 Runtime must be installed to use esa-cli dev. Installing...`));
         try {
             execSync(installCommand, { stdio: 'inherit' });
             logger.success(t('install_runtime_success').d(`Runtime installed.`));

package/dist/utils/installEw2.js

@@ -43,7 +43,7 @@ export function preCheckEw2() {
         try {
             yield fsAccess(EW2BinPath, fs.constants.X_OK);
             if (!manifestRes.isLatest) {
-                logger.warn(t('install_runtime_update_tip').d(`🔔 Runtime must be update to use esa dev. Installing...`));
+                logger.warn(t('install_runtime_update_tip').d(`🔔 Runtime must be update to use esa-cli dev. Installing...`));
                 return yield installVersion(manifestRes.remoteManifest);
             }
             return true;
@@ -55,7 +55,7 @@ export function preCheckEw2() {
                 return false;
             }
             if (err.code === 'ENOENT' || err.code === 'EPERM') {
-                logger.warn(t('install_runtime_tip').d(`🔔 Runtime must be installed to use esa dev. Installing...`));
+                logger.warn(t('install_runtime_tip').d(`🔔 Runtime must be installed to use esa-cli dev. Installing...`));
                 return yield installVersion(manifestRes.remoteManifest);
             }
             logger.error(err.message);

package/package.json

@@ -1,11 +1,12 @@
 {
   "name": "esa-cli",
-  "version": "0.0.2-beta.21",
+  "version": "0.0.2-beta.23",
   "description": "A CLI for operating Alibaba Cloud ESA EdgeRoutine (Edge Functions).",
   "main": "bin/enter.cjs",
   "type": "module",
   "bin": {
-    "esa": "bin/enter.cjs"
+    "esa": "bin/enter.cjs",
+    "esa-cli": "bin/enter.cjs"
   },
   "files": [
     "bin",

package/zh_CN.md

@@ -1,176 +1,50 @@
-# ESA CLI
+# 安装/更新 ESA CLI
 
-用于操作阿里云 ESA EdgeRoutine（边缘函数） 的 CLI，支持快速创建边缘函数、本地调试、版本发布与部署、触发器管理。
+ESA CLI 是用于构建阿里云 ESA Functions 与 Pages 的命令行工具。
 
-简体中文 | [English](./README.md)
+<p>
+  <a href="https://discord.gg/xygV6MYx">
+    <img alt="Discord 中文" src="https://img.shields.io/badge/Discord-中文-5865F2?logo=discord&logoColor=white" />
+  </a>
+  <a href="https://discord.gg/YeFg4yUA" style="margin-left:8px;">
+    <img alt="Discord English" src="https://img.shields.io/badge/Discord-English-5865F2?logo=discord&logoColor=white" />
+  </a>
+ </p>
 
-#### 参考
+## 安装 ESA CLI
 
-- [边缘安全加速(ESA)](https://www.aliyun.com/product/esa)
-- [边缘函数概述](https://help.aliyun.com/document_detail/2710021.html)
+### 前置条件
 
-> **注意**: **ESA CLI 在0.0.2以上版本的本地开发模式替换成了ESA边缘函数相同的Runtime，目前实际表现与线上相同，欢迎体验！**
-
-ESA CLI 处于公测阶段，如果您在使用中遇到任何问题，或者有任何建议，请随时提交 issue 或 pull request。
-我们正在积极改进，并欢迎任何反馈。感谢您的理解与支持！
+- Node.js：18.x 或更高（支持 18.x、20.x、22.x）
+- 操作系统：macOS (Apple Silicon)、Linux
+- 推荐使用 Volta 或 nvm 等 Node 版本管理工具，避免权限问题并便于切换版本
 
 ## 安装
 
-使用npm安装并运行CLI命令：
-
-```bash
-$ npm install esa-cli -g    # 全局安装
-$ esa -v                    # 查看版本
-```
-
-## 使用指南
-
-### 1. 初始化Routine项目
+为确保团队协作的一致性，建议在项目中将 `esa-cli` 安装为开发依赖，以便团队成员使用相同版本。
 
-```bash
-& esa init
 ```
-
-初始化命令有完整的流程引导，根据提示输入项目名称、选择模板即可。
-
-### 2. 开始本地调试
-
-本地调试功能是 CLI 的核心，提供了比阿里云 ESA 控制台更便捷的调试体验。
-
-```bash
-& cd <Project Name>
-& esa dev [options]
+npm i -D esa-cli@latest
 ```
 
-#### 编写代码
+当尚未安装 `esa-cli` 时，`npx` 会从注册表拉取并运行最新版本。
 
-在EdgeRoutine 项目中，入口文件为 `src/index.js`，基本结构如下：
+## 查看 ESA CLI 版本
 
-```javascript
-const html = `<!DOCTYPE html>
-<body>
-  <h1>Hello World!</h1>
-</body>`;
-
-async function handleRequest(request) {
-  return new Response(html, {
-    headers: {
-      'content-type': 'text/html;charset=UTF-8'
-    }
-  });
-}
-
-export default {
-  async fetch(event) {
-    return event.respondWith(handleRequest(event));
-  }
-};
 ```
-
-更多 EdgeRoutine 的 API 与语法，请参考[API文档](https://help.aliyun.com/document_detail/2710024.html)
-
-#### 本地调试
-
-执行 `esa dev` 后，会自动打包入口文件，并启动本地调试服务，界面样式如下：
-
-![调试界面](https://github.com/aliyun/alibabacloud-esa-cli/blob/master/docs/dev.png)
-
-- 在界面上按 `b` 即可在浏览器中打开调试页面。
-- 在界面上按 `c` 可以清空面板。
-- 在界面上按 `x` 可以退出调试。
-- 可以用 `esa dev --port <port>` 临时指定端口，也可以使用 `esa config -l` 按照项目配置端口。
-
-### 3. 登录阿里云账号
-
-需要先登录阿里云账号，才能进行远程管理操作。
-
-首先请访问[阿里云RAM控制台](https://ram.console.aliyun.com/manage/ak)获取您的AccessKey ID和AccessKey Secret，再执行`esa login`根据提示输入。
-
-```bash
-& esa login        # 登录
-& esa logout       # 登出
+npx esa-cli --version
+# 或
+npx esa-cli -v
 ```
 
-### 4. 生成版本
-
-当本地调试完成后，需要生成一个代码版本用于部署。
+## 更新 ESA CLI
 
-```bash
-& esa commit      # 生成版本
 ```
-
-### 5. 部署到环境 & 管理版本与部署
-
-当代码版本生成后，需要部署到边缘节点。
-
-通过`esa deployments [script]`命令可以管理版本与部署情况。
-
-```bash
-& esa deploy              # 根据提示选择版本、目标环境即可部署
-& esa deployments list    # 查看部署情况
-& esa deployments delete <versionId>  # 删除版本
-```
-
-_注意：已经被部署的版本无法删除。_
-
-### 6. 管理触发器
-
-当被部署到节点后，您可以配置触发器，通过触发器可以访问您的边缘函数。触发器有两种：
-
-- 域名：为您的函数绑定域名，该域名必须是您ESA站点的子域名，您可以通过域名直接访问到该函数，此时边缘函数将作为该域名的源站。
-- 路由：为您的ESA站点绑定函数路由，访问该路由可触发边缘函数执行，此时边缘函数可以和站点的源站进行通信。
-
-```bash
-# 域名
-& esa domain list
-& esa domain add <domainName>     # 需要是您的已备案域名
-& esa domain delete <domainName>
-
-# 路由
-& esa route list
-& esa route add [route] [site]
-& esa route delete <route>
-```
-
-### 7. 管理函数
-
-可以通过CLI查看、删除Routine函数。
-
-```bash
-& esa routine list    # 查看函数
-& esa routine delete <routineName>  # 删除函数
-```
-
-## 命令
-
-查看[命令](./docs/Commands.md)
-
-## 配置文件
-
-### 全局配置
-
-```toml
-endpoint = "" # ESA API Endpoint
-lang = "zh_CN" # 语言
-
-[auth]
-accessKeyId = "" # AccessKey ID
-accessKeySecret = "" # AccessKey Secret
-```
-
-### 项目配置
-
-```toml
-name = "Hello World" # 项目名称
-description = "Hello World" # 项目描述
-entry = "src/index.js" # 入口文件
-codeVersions = [ ] # 代码版本
-
-[dev]
-port = 18080 # 调试端口
-localUpstream = '' # 本地调试上游源站，会替换掉回源时当前的origin
+npm i -D esa-cli@latest
 ```
 
-## LICENSE
+## 相关文档
 
-[The MIT License](./LICENSE)
+- [esa-cli 命令](./docs/Commands_zh_CN.md)
+- [阿里云 ESA 文档](https://help.aliyun.com/document_detail/2710021.html)
+- [Functions 和 Pages API 参考](https://help.aliyun.com/document_detail/2710024.html)