npm - esa-cli - Versions diffs - 0.0.5 → 1.0.0 - Mend

esa-cli 0.0.5 → 1.0.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.

Files changed (85) hide show

package/README.md +32 -149
package/dist/commands/commit/index.js +49 -104
package/dist/commands/commit/prodBuild.js +2 -3
package/dist/commands/common/constant.js +4 -4
package/dist/commands/common/utils.js +419 -0
package/dist/commands/config.js +2 -2
package/dist/commands/deploy/helper.js +43 -49
package/dist/commands/deploy/index.js +51 -174
package/dist/commands/deployments/delete.js +32 -22
package/dist/commands/deployments/index.js +4 -4
package/dist/commands/deployments/list.js +21 -34
package/dist/commands/dev/build.js +3 -3
package/dist/commands/dev/doProcess.js +5 -5
package/dist/commands/dev/ew2/cacheService.js +33 -0
package/dist/commands/dev/ew2/devEntry.js +2 -1
package/dist/commands/dev/ew2/devPack.js +31 -20
package/dist/commands/dev/ew2/kvService.js +50 -0
package/dist/commands/dev/ew2/mock/cache.js +99 -15
package/dist/commands/dev/ew2/mock/kv.js +142 -21
package/dist/commands/dev/ew2/server.js +163 -28
package/dist/commands/dev/index.js +17 -18
package/dist/commands/dev/mockWorker/devPack.js +19 -10
package/dist/commands/dev/mockWorker/server.js +7 -6
package/dist/commands/domain/add.js +4 -4
package/dist/commands/domain/delete.js +3 -3
package/dist/commands/domain/index.js +4 -4
package/dist/commands/domain/list.js +7 -7
package/dist/commands/init/helper.js +654 -21
package/dist/commands/init/index.js +88 -152
package/dist/commands/init/snippets/nextjs/next.config.mjs +6 -0
package/dist/commands/init/snippets/nextjs/next.config.ts +7 -0
package/dist/commands/init/snippets/react-router/react-router.config.ts +7 -0
package/dist/commands/init/template.jsonc +84 -0
package/dist/commands/init/types.js +1 -0
package/dist/commands/lang.js +2 -2
package/dist/commands/login/index.js +74 -34
package/dist/commands/logout.js +6 -6
package/dist/commands/route/add.js +101 -43
package/dist/commands/route/delete.js +6 -6
package/dist/commands/route/helper.js +9 -10
package/dist/commands/route/index.js +4 -4
package/dist/commands/route/list.js +4 -4
package/dist/commands/routine/delete.js +9 -8
package/dist/commands/routine/index.js +6 -5
package/dist/commands/routine/list.js +45 -39
package/dist/commands/site/index.js +3 -3
package/dist/commands/site/list.js +6 -7
package/dist/commands/utils.js +61 -25
package/dist/components/descriptionInput.js +1 -1
package/dist/components/filterSelector.js +1 -1
package/dist/components/mutiLevelSelect.js +19 -20
package/dist/components/mutiSelectTable.js +1 -1
package/dist/components/routeBuilder.js +68 -0
package/dist/components/selectInput.js +2 -3
package/dist/components/selectItem.js +1 -1
package/dist/docs/Commands_en.md +164 -117
package/dist/docs/Commands_zh_CN.md +155 -107
package/dist/docs/Config_en.md +70 -0
package/dist/docs/Config_zh_CN.md +68 -0
package/dist/i18n/index.js +2 -2
package/dist/i18n/locales.json +414 -82
package/dist/index.js +28 -13
package/dist/libs/api.js +3 -6
package/dist/libs/apiService.js +192 -69
package/dist/libs/git/index.js +86 -9
package/dist/libs/interface.js +0 -1
package/dist/libs/logger.js +162 -10
package/dist/libs/service.js +2 -2
package/dist/libs/templates/index.js +1 -1
package/dist/utils/checkAssetsExist.js +80 -0
package/dist/utils/checkDevPort.js +5 -19
package/dist/utils/checkEntryFileExist.js +10 -0
package/dist/utils/checkIsRoutineCreated.js +27 -21
package/dist/utils/checkVersion.js +119 -1
package/dist/utils/command.js +149 -0
package/dist/utils/compress.js +142 -0
package/dist/utils/download.js +8 -8
package/dist/utils/fileMd5.js +1 -1
package/dist/utils/fileUtils/index.js +136 -45
package/dist/utils/installDeno.js +4 -4
package/dist/utils/installEw2.js +9 -9
package/dist/utils/openInBrowser.js +1 -1
package/dist/utils/prompt.js +97 -0
package/package.json +23 -12
package/zh_CN.md +29 -154

package/README.md CHANGED Viewed

@@ -1,173 +1,56 @@
-# ESA CLI
+# Install/Update ESA CLI
-A CLI for operating Alibaba Cloud ESA EdgeRoutine (Edge Functions). It supports quick creation of edge functions, local debugging, version publishing and deployment, and trigger management.
+ESA CLI is a command-line tool for building with Alibaba Cloud ESA Functions and Pages.
-English | [简体中文](./zh_CN.md)
+<p>
+  <a href="https://discord.gg/xygV6MYx">
+    <img alt="Discord CN" 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 EN" src="https://img.shields.io/badge/Discord-English-5865F2?logo=discord&logoColor=white" />
+  </a>
+ </p>
-#### Reference
+## Install ESA CLI
-- [Edge Security Acceleration (ESA)](https://www.aliyun.com/product/esa)
-- [What is EdgeRoutine?](https://help.aliyun.com/document_detail/2710021.html)
+### Prerequisites
-> **Note**: **In version 0.0.2 and above, the local development mode of the ESA CLI has been replaced with the same runtime as the ESA edge functions, ensuring that its actual behavior now matches the live environment. We invite you to experience it.**
-ESA CLI is in public beta. If you encounter any issues or have any suggestions while using it, please feel free to submit an issue or a pull request.We are actively working to improve this tool and welcome any feedback. Thank you for your understanding and support!
+- Node.js: 18.x or higher (supports 18.x, 20.x, 22.x)
+- OS: macOS (x86, Apple Silicon), Linux
+- Recommended to use a Node version manager like Volta or nvm to avoid permission issues and easily switch Node.js versions.
 ## Installation
-Install and run the CLI using npm:
+To ensure consistent collaboration across your team, we recommend installing `esa-cli` as a dev dependency in your project. This helps everyone use the same version.
 ```bash
-$ npm install esa-cli -g    # Install globally
-$ esa -v                    # Check the version
+npm i -D esa-cli@latest
 ```
-## Usage
-### 1. Initialize Routine Project
+> [!TIP]
+> When `esa-cli` is not previously installed, `npx` will fetch and run the latest version from the registry.
-```bash
-& esa init
-```
+## Check your ESA CLI version
-The initialization command has a complete process guide. Follow the prompts to enter the project name and choose a template.
-### 2. Start a local server for developing your routine
-Local dev is the core feature of the CLI, offering a more convenient debugging experience compared to the Alibaba Cloud ESA console.
+**To check your ESA CLI version, run:**
 ```bash
-& cd <Project Name>
-& esa dev [options]
+npx esa-cli --version
+# or
+npx esa-cli -v
 ```
-#### Write Code
-In an EdgeRoutine project, the entry file is `src/index.js`, and the basic structure is as follows:
-```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));
-  }
-};
-```
-For more EdgeRoutine APIs and syntax, please refer to the [API Reference](https://help.aliyun.com/document_detail/2710024.html)
-#### Local Debugging
-After executing `esa dev`, the entry file will be automatically packaged and a local debugging service will be started. The interface looks like this:
-![dev png](https://github.com/aliyun/alibabacloud-esa-cli/blob/master/docs/dev.png)
-- Press `b` to open the debugging page in the browser.
-- Press `c` to clear the panel.
-- Press `x` to exit debugging.
-- You can use `esa dev --port <port>` to temporarily specify the port or use `esa config -l` to set the port by project configuration.
-### 3. Log in to Alibaba Cloud Account
-You need to log in to your Alibaba Cloud account to perform remote management operations.
-First, visit the [Alibaba Cloud RAM Console](https://ram.console.aliyun.com/manage/ak) to get your AccessKey ID and AccessKey Secret, then execute `esa login` and follow the prompts to enter them.
-```bash
-& esa login
-& esa logout
-```
-### 4. Create a Version
-After local debugging is complete, you need to create a code version for deployment.
-```bash
-& esa commit      # Create a Version
-```
-### 5. Deploy to Environment & Manage Versions and Deployments
-After the code version is created, it needs to be deployed to edge nodes.
+## Update ESA CLI
-Use the `esa deployments [script]` command to manage versions and deployments.
+**To update ESA CLI to the latest version, run:**
 ```bash
-& esa deploy              # Deploy versions to the target environment
-& esa deployments list    # View deployments
-& esa deployments delete <versionId>  # Delete a version
-```
-_Note: Deployed versions cannot be deleted._
-### 6. Manage Triggers
-Once deployed to the nodes, you can configure triggers to access your edge functions. There are two types of triggers:
-- Domain: After you associate the routine with a domain name, you can use the domain name to access the routine.
-- Route: After you add a route for requested URLs, the routine is called from the edge to respond to the request.
-```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. Manage Functions
-You can view and delete Routine functions through the CLI.
-```bash
-& esa routine list
-& esa routine delete <routineName>
-```
-## Commands
-see [Commands](./docs/Commands_en.md)
-## Config files
-### Global config file
-```toml
-endpoint = "" # ESA API Endpoint
-lang = "zh_CN" # language
-[auth]
-accessKeyId = "" # AccessKey ID
-accessKeySecret = "" # AccessKey Secret
-```
-### Project config file
-```toml
-name = "Hello World" # Project name
-description = "Hello World" # Project description
-entry = "src/index.js" # Entry file
-codeVersions = [ ] # Code version
-[dev]
-port = 18080 # Debug port
-localUpstream = '' # When debugging locally, the upstream source site will replace the current origin when returning to the source
+npm i -D esa-cli@latest
 ```
-## LICENSE
+## Related Documentation
-[The MIT License](./LICENSE)
+- [esa-cli command](./docs/Commands_en.md)
+- [ESA Configuration Guide](./docs/Config_en.md)
+- [Alibaba Cloud ESA Documentation](https://www.alibabacloud.com/help/en/edge-security-acceleration/esa/user-guide/what-is-er/)
+- [Functions and Pages API Reference](https://www.alibabacloud.com/help/en/edge-security-acceleration/esa/user-guide/api-documentation/)

package/dist/commands/commit/index.js CHANGED Viewed

@@ -7,16 +7,16 @@ var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, ge
         step((generator = generator.apply(thisArg, _arguments || [])).next());
     });
 };
-import { getProjectConfig, readEdgeRoutineFile } from '../../utils/fileUtils/index.js';
-import { checkDirectory, checkIsLoginSuccess } from '../utils.js';
-import { descriptionInput } from '../../components/descriptionInput.js';
-import { ApiService } from '../../libs/apiService.js';
-import prodBuild from './prodBuild.js';
-import logger from '../../libs/logger.js';
+import { exit } from 'process';
+import { intro, outro } from '@clack/prompts';
+import chalk from 'chalk';
 import t from '../../i18n/index.js';
+import logger from '../../libs/logger.js';
+import promptParameter from '../../utils/prompt.js';
+import { validateAndInitializeProject, generateCodeVersion } from '../common/utils.js';
 const commit = {
     command: 'commit [entry]',
-    describe: `📥 ${t('commit_describe').d('Commit your code, save as a new version')}`,
+    describe: `📦 ${t('commit_describe').d('Commit your code, save as a new version')}`,
     builder: (yargs) => {
         return yargs
             .option('minify', {
@@ -25,116 +25,61 @@ const commit = {
             type: 'boolean',
             default: false
         })
-            .positional('entry', {
-            describe: t('dev_entry_describe').d('Entry file of the Routine'),
-            type: 'string',
-            demandOption: false
+            .option('assets', {
+            alias: 'a',
+            describe: t('commit_option_assets').d('Assets directory'),
+            type: 'string'
+        })
+            .option('description', {
+            alias: 'd',
+            describe: t('commit_option_description').d('Description for Functions& Pages/version (skip interactive input)'),
+            type: 'string'
+        })
+            .option('name', {
+            alias: 'n',
+            describe: t('commit_option_name').d('Functions& Pages name'),
+            type: 'string'
         });
     },
     handler: (argv) => __awaiter(void 0, void 0, void 0, function* () {
-        handleCommit(argv);
+        yield handleCommit(argv);
+        exit();
     })
 };
 export default commit;
 export function handleCommit(argv) {
     return __awaiter(this, void 0, void 0, function* () {
-        if (!checkDirectory())
-            return;
-        const projectConfig = getProjectConfig();
-        if (!projectConfig)
-            return logger.notInProject();
-        if (!(yield checkIsLoginSuccess()))
+        var _a, _b;
+        intro(`Commit an application with ESA`);
+        const projectInfo = yield validateAndInitializeProject(argv === null || argv === void 0 ? void 0 : argv.name);
+        if (!projectInfo)
             return;
-        yield prodBuild(!!argv.minify, argv === null || argv === void 0 ? void 0 : argv.entry);
-        try {
-            const server = yield ApiService.getInstance();
-            const req = { Name: projectConfig.name };
-            const response = yield server.getRoutine(req, false);
-            let action = 'Creating';
-            let description;
-            if (!response) {
-                logger.log(`🙅 ${t('commit_er_not_exist').d('No routine found, creating a new one')}`);
-                description = yield descriptionInput(`🖊️ ${t('commit_er_description').d('Enter a description for the routine')}:`, false);
-            }
-            else {
-                logger.log(`🔄 ${t('commit_er_exist').d('Routine exists, updating the code')}`);
-                description = yield descriptionInput(`🖊️ ${t('commit_version_description').d('Enter a description for the version')}:`, false);
-                action = 'Updating';
-            }
-            const code = readEdgeRoutineFile() || '';
-            const edgeRoutine = {
-                name: projectConfig.name,
-                code,
-                description
-            };
-            if (action === 'Creating') {
-                yield createEdgeRoutine(edgeRoutine);
-            }
-            else {
-                if (!(yield uploadEdgeRoutineCode(edgeRoutine)))
-                    return;
-                yield releaseOfficialVersion(edgeRoutine);
-            }
-        }
-        catch (error) {
-            logger.error(`${t('common_error_occurred').d('An error occurred:')} ${error}`);
+        const { projectName } = projectInfo;
+        let description;
+        if (argv.description) {
+            description = argv.description;
         }
-    });
-}
-export function createEdgeRoutine(edgeRoutine) {
-    return __awaiter(this, void 0, void 0, function* () {
-        try {
-            const server = yield ApiService.getInstance();
-            const res = yield server.createRoutine(edgeRoutine);
-            const createResult = (res === null || res === void 0 ? void 0 : res.data.Status) === 'OK';
-            if (!createResult) {
-                logger.error(t('commit_create_er_fail').d('An error occurred while trying to create a routine'));
-                return false;
-            }
-            logger.success(t('commit_create_er_success').d('Routine created successfully.'));
-            return yield uploadEdgeRoutineCode(edgeRoutine);
-        }
-        catch (error) {
-            logger.error(`${t('common_error_occurred').d('An error occurred:')} ${error}`);
-            return false;
-        }
-    });
-}
-export function uploadEdgeRoutineCode(edgeRoutine) {
-    return __awaiter(this, void 0, void 0, function* () {
-        try {
-            const server = yield ApiService.getInstance();
-            const uploadResult = yield server.getRoutineStagingCodeUploadInfo(edgeRoutine);
-            if (!uploadResult) {
-                logger.error(t('commit_upload_fail').d('An error occurred while trying to upload your code'));
-                process.exit(0);
-            }
-            logger.success(t('commit_upload_success').d('Code uploaded successfully.'));
-            return true;
-        }
-        catch (error) {
-            logger.error('123');
-            logger.error(`${t('common_error_occurred').d('An error occurred:')} ${error}`);
-            process.exit(0);
+        else {
+            description = (yield promptParameter({
+                type: 'text',
+                question: t('commit_version_description').d('Enter a description for the version'),
+                label: 'Description',
+                defaultValue: ''
+            }));
         }
-    });
-}
-export function releaseOfficialVersion(edgeRoutine) {
-    return __awaiter(this, void 0, void 0, function* () {
-        var _a;
-        const param = {
-            Name: edgeRoutine.name,
-            CodeDescription: (_a = edgeRoutine.description) !== null && _a !== void 0 ? _a : ''
-        };
-        const server = yield ApiService.getInstance();
-        const commitResult = yield server.commitRoutineStagingCode(param);
-        if (commitResult) {
-            logger.success(t('commit_success').d('Code version committed successfully.'));
-            return true;
+        logger.startSubStep('Generating code version');
+        const res = yield generateCodeVersion(projectName, description, argv === null || argv === void 0 ? void 0 : argv.entry, argv === null || argv === void 0 ? void 0 : argv.assets, argv === null || argv === void 0 ? void 0 : argv.minify);
+        const { isSuccess } = res || {};
+        if (!isSuccess) {
+            logger.endSubStep('Generate version failed');
+            exit(1);
         }
-        else {
-            logger.error(t('commit_fail').d('An error occurred while trying to commit your code.'));
+        const codeVersion = (_b = (_a = res === null || res === void 0 ? void 0 : res.res) === null || _a === void 0 ? void 0 : _a.data) === null || _b === void 0 ? void 0 : _b.CodeVersion;
+        if (!codeVersion) {
+            logger.endSubStep('Missing CodeVersion in response');
             return false;
         }
+        logger.endSubStep(`Version generated: ${codeVersion}`);
+        outro(`Code version ${chalk.bold(codeVersion)} generated successfully`);
     });
 }

package/dist/commands/commit/prodBuild.js CHANGED Viewed

@@ -7,15 +7,14 @@ var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, ge
         step((generator = generator.apply(thisArg, _arguments || [])).next());
     });
 };
+import fs from 'fs';
+import path from 'path';
 import esbuild from 'esbuild';
 import { lessLoader } from 'esbuild-plugin-less';
-import path from 'path';
-import fs from 'fs';
 import { getRoot } from '../../utils/fileUtils/base.js';
 import { NODE_EXTERNALS } from '../common/constant.js';
 const userRoot = getRoot();
 const entry = path.resolve(userRoot, 'src/index.js');
-const outfile = path.resolve(userRoot, '.dev/pub.js');
 export default function () {
     return __awaiter(this, arguments, void 0, function* (minify = false, customEntry, outputPath) {
         const entryPoint = customEntry

package/dist/commands/common/constant.js CHANGED Viewed

@@ -2,21 +2,21 @@ import t from '../../i18n/index.js';
 export const getSummary = (routineName) => {
     return [
         {
-            title: t('summery_cd').d('Enter your routine project folder'),
+            title: t('summery_cd').d('Enter your project folder'),
             command: `💡 cd ${routineName}`
         },
         {
             title: t('summery_dev').d('Start a local development server for your project'),
-            command: '💡 esa dev'
+            command: '💡 esa-cli dev'
         },
         {
             title: t('summery_commit').d('Save a new version of code'),
-            command: '💡 esa commit'
+            command: '💡 esa-cli commit'
         },
         // Use Deploy or Release?
         {
             title: t('summery_deploy').d('Deploy your project to different environments'),
-            command: '💡 esa deploy'
+            command: '💡 esa-cli deploy'
         }
     ];
 };