Merge pull request #8 from aliyun/feat/code-auto-completion

Feat/code auto completion
aliyun · Feb 5, 2024 · 455782c · 455782c
2 parents 9bf9326 + fc0faa5
commit 455782c
Show file tree

Hide file tree

Showing 13 changed files with 703 additions and 53 deletions.
diff --git a/README.md b/README.md
@@ -3,68 +3,99 @@
 [![Version](https://img.shields.io/visual-studio-marketplace/v/alibabacloud-openapi.vscode-alicloud-api)](https://marketplace.visualstudio.com/items?itemName=alibabacloud-openapi.vscode-alicloud-api)
 [![Installs](https://img.shields.io/visual-studio-marketplace/i/alibabacloud-openapi.vscode-alicloud-api)](https://marketplace.visualstudio.com/items?itemName=alibabacloud-openapi.vscode-alicloud-api)
 [![Ratings](https://img.shields.io/visual-studio-marketplace/r/alibabacloud-openapi.vscode-alicloud-api)](https://marketplace.visualstudio.com/items?itemName=alibabacloud-openapi.vscode-alicloud-api)
-![beta](https://img.shields.io/badge/beta-version)
 
-Alibaba Cloud API Toolkit 是一个轻量化的阿里云 API 工具，支持在 VS Code 中快速查阅阿里云产品的 API.
+The Alibaba Cloud API Toolkit for VSCode makes it easier to access Alibaba Cloud services.
 
-简体中文 | [English](./README.en-US.md)
+## Features                          
+* **Alicloud Product Subscription:** You can search for Alicloud products and subscribe to its APIs you want to use.
 
-## 功能
+* **API Searching:** You can search the Open API of Alibaba Cloud products to which you are subscribed.
 
-* **阿里云产品订阅：** 插件提供了一键订阅阿里云产品的功能，你可以通过 `ctrl+cmd+k` 搜索和订阅阿里云产品。
+* **API Document View:** Clicking on an API can navigate you to a new tab which displays the corresponding API document, 
+including descriptions, request parameters, response parameters and error codes.
 
-* **API 搜索:** 你可以通过 `ctrl+cmd+l` 搜索并查看已订阅的 API 文档。
-
-* **API 文档预览:** 点击 API 可以打开一个新的标签页，并显示对应的 API 文档，包括描述、请求参数、响应参数和错误码。在文档中点击调试按钮，可以链接到阿里云 OpenAPI 门户进行在线 API 试用。
-
-* **API 调试:** 你可以在插件中使用表单的方式调试阿里云 API，并查看结果。
+* **Call the API:** You can use the form to call the Alibaba Cloud API and see the response.
 
-* **SDK 代码示例:** 你可以在插件中获得 SDK 代码示例，并在编辑器中快速打开对应的 SDK 代码。
+* **SDK Code Sample:** You can get the SDK code samples and quickly open the corresponding SDK code in VS Code.
 
-* 更多功能正在开发中，敬请期待...
+* **Code Snippets:** You can use the code snippets to quickly generate the code.
 
-## 插件 UI 导览
+* More features are under development, please stay tuned.
 
-![VSCode Extension Guide](https://img.alicdn.com/imgextra/i1/O1CN01o9s4TT1GTq3oggW7K_!!6000000000624-0-tps-2456-1446.jpg)
+## Extension UI Guide
 
- * 产品搜索 `ctrl+cmd+k`
+![VSCode Extension Guide](https://img.alicdn.com/imgextra/i1/O1CN01rOmqbK1pOoGtdWxFO_!!6000000005351-0-tps-2462-1440.jpg)
 
+### Product Searching `ctrl+cmd+k`
+
 ![Product Searching](https://img.alicdn.com/imgextra/i1/O1CN01bcJ5DM1RpmnlOjDHK_!!6000000002161-0-tps-1202-798.jpg)
-
- * API 搜索 `ctrl+cmd+l`
+ 
+### API Searching `ctrl+cmd+l`
 
 ![API Serching](https://img.alicdn.com/imgextra/i1/O1CN01KaWkBF1UfCUkY0N3v_!!6000000002544-0-tps-1286-518.jpg)
 
-* API 调试 
-
-调试功能需要配置你的 AK/SK 信息，配置方法如下：
-1. 安装 [Alibaba Cloud CLI Tools](https://marketplace.visualstudio.com/items?itemName=alibabacloud-openapi.aliyuncli) 插件，
-2. 打开命令行安装 aliyun-cli `brew install aliyun-cli`，
-3. 输入 `aliyun configure` 命令，按照提示进行配置，
-4. 点击 VS Code 状态栏中的阿里云图标，管理你的 profiles，
-5. 更多信息请参考 [Alibaba Cloud CLI Documentation](https://github.com/aliyun/aliyun-cli?tab=readme-ov-file#configure)。
+### Call the API
+
+The feature requires you to configure your AK/SK information as follows: 
+1. Install [Alibaba Cloud CLI Tools](https://marketplace.visualstudio.com/items?itemName=alibabacloud-openapi.aliyuncli) extentions. 
+2. Install [aliyun-cli](https://github.com/aliyun/aliyun-cli?tab=readme-ov-file#installation).
+3. You can run the `aliyun configure` command for quick configuration. 
+```
+$ aliyun configure
+Configuring profile 'default' ...
+Aliyun Access Key ID [None]: <Your AccessKey ID>
+Aliyun Access Key Secret [None]: <Your AccessKey Secret>
+Default Region Id [None]: cn-hangzhou
+Default output format [json]: json
+Default Language [zh]: zh
+```
+4. Click the Alibaba Cloud icon in VS Code status bar to manage your profiles.
+![](https://img.alicdn.com/imgextra/i1/O1CN0144NU9N1L4G1cq89Uf_!!6000000001245-0-tps-248-46.jpg)
+![](https://img.alicdn.com/imgextra/i2/O1CN01btLUkc1ldEHJQ0w4S_!!6000000004841-0-tps-1206-190.jpg)
+5. More information please refer to the [Alibaba Cloud CLI Documentation](https://github.com/aliyun/aliyun-cli?tab=readme-ov-file#configure).
 
 ![API debug](https://img.alicdn.com/imgextra/i4/O1CN01F1qI7S1BunIFJPiAt_!!6000000000006-0-tps-2618-2050.jpg)
 
-* SDK 示例
-
+### SDK Code Sample
+You can generate the SDK Sample by using the debugger form and then open it in your editor.
+
 ![sdk demo](https://img.alicdn.com/imgextra/i1/O1CN01GVhWTl1waRdYmCn7E_!!6000000006324-0-tps-2630-2038.jpg)
 
+### Code Snippets
+You can use the code snippets to quickly generate the code. 
+
+Type your subscribed API into the editor and select the API snippet you want to generate.
+
+![code snippets](https://img.alicdn.com/imgextra/i3/O1CN01iKQA6u1KWMiVttyH0_!!6000000001171-1-tps-915-442.gif)
+Or use the keyboard shortcuts `ctrl+cmd+l` to search the API and select Insert snippets.
+
+![code snippets](https://img.alicdn.com/imgextra/i3/O1CN01dmGwmX1ZyVHozyKx4_!!6000000003263-1-tps-842-468.gif)
+
+## Feedback
+Submit bug reports and feature requests on [our Github repository](https://github.com/aliyun/alibabacloud-api-vscode-toolkit/issues)
+.
+
 ## Requirements
 - Need VS Code 1.75.0 or above.
 
 ## Release Notes
 
+### 0.0.6
+- Surpport code snippets.
+
+### 0.0.5
+- Added aliyun-cli installation instructions.
+
+### 0.0.3
+- Support API calling.
+- Support SDK code sample.
+
 ### 0.0.1 
 Initial release
 - Support product searching and subscription.
 - Support API searching.
 - Support API Document View.
 
-### 0.0.3
-- Support API calling.
-- Support SDK code sample.
-
 ## License
 
 See the [Apache License 2.0](./LICENSE).
diff --git a/README.zh_CN.md b/README.zh_CN.md
@@ -0,0 +1,104 @@
+# Alibaba Cloud API Toolkit
+
+[![Version](https://img.shields.io/visual-studio-marketplace/v/alibabacloud-openapi.vscode-alicloud-api)](https://marketplace.visualstudio.com/items?itemName=alibabacloud-openapi.vscode-alicloud-api)
+[![Installs](https://img.shields.io/visual-studio-marketplace/i/alibabacloud-openapi.vscode-alicloud-api)](https://marketplace.visualstudio.com/items?itemName=alibabacloud-openapi.vscode-alicloud-api)
+[![Ratings](https://img.shields.io/visual-studio-marketplace/r/alibabacloud-openapi.vscode-alicloud-api)](https://marketplace.visualstudio.com/items?itemName=alibabacloud-openapi.vscode-alicloud-api)
+![beta](https://img.shields.io/badge/beta-version)
+
+Alibaba Cloud API Toolkit 是一个轻量化的阿里云 API 工具，支持在 VS Code 中快速查阅阿里云产品的 API.
+
+简体中文 | [English](./README.md)
+
+## 功能
+
+* **阿里云产品订阅：** 插件提供了一键订阅阿里云产品的功能，你可以通过 `ctrl+cmd+k` 搜索和订阅阿里云产品。
+
+* **API 搜索:** 你可以通过 `ctrl+cmd+l` 搜索并查看已订阅的 API 文档。
+
+* **API 文档预览:** 点击 API 可以打开一个新的标签页，并显示对应的 API 文档，包括描述、请求参数、响应参数和错误码。
+
+* **API 调试:** 你可以在插件中使用表单的方式调试阿里云 API，并查看结果。
+
+* **SDK 代码示例:** 你可以在插件中获得 SDK 代码示例，并在编辑器中快速打开对应的 SDK 代码。
+
+* **Code Snippets:** 支持代码片段功能，帮助你快速编写 SDK 代码。
+
+* 更多功能正在开发中，敬请期待...
+
+## 插件 UI 导览
+
+![VSCode Extension Guide](https://img.alicdn.com/imgextra/i1/O1CN01o9s4TT1GTq3oggW7K_!!6000000000624-0-tps-2456-1446.jpg)
+
+### 产品搜索 `ctrl+cmd+k`
+
+![Product Searching](https://img.alicdn.com/imgextra/i1/O1CN01bcJ5DM1RpmnlOjDHK_!!6000000002161-0-tps-1202-798.jpg)
+
+### API 搜索 `ctrl+cmd+l`
+
+![API Serching](https://img.alicdn.com/imgextra/i1/O1CN01KaWkBF1UfCUkY0N3v_!!6000000002544-0-tps-1286-518.jpg)
+
+### API 调试 
+
+调试功能需要配置你的 AK/SK 信息，配置方法如下：
+1. 安装 [Alibaba Cloud CLI Tools](https://marketplace.visualstudio.com/items?itemName=alibabacloud-openapi.aliyuncli) 插件，
+2. 打开命令行安装 aliyun-cli `brew install aliyun-cli`，
+3. 输入 `aliyun configure` 命令，按照提示进行配置，
+```
+$ aliyun configure
+Configuring profile 'default' ...
+Aliyun Access Key ID [None]: <Your AccessKey ID>
+Aliyun Access Key Secret [None]: <Your AccessKey Secret>
+Default Region Id [None]: cn-hangzhou
+Default output format [json]: json
+Default Language [zh]: zh
+```
+4. 点击 VS Code 状态栏中的阿里云图标，管理你的 profiles，
+![](https://img.alicdn.com/imgextra/i1/O1CN0144NU9N1L4G1cq89Uf_!!6000000001245-0-tps-248-46.jpg)
+![](https://img.alicdn.com/imgextra/i2/O1CN01btLUkc1ldEHJQ0w4S_!!6000000004841-0-tps-1206-190.jpg)
+1. 更多信息请参考 [Alibaba Cloud CLI Documentation](https://github.com/aliyun/aliyun-cli?tab=readme-ov-file#configure)。
+
+![API debug](https://img.alicdn.com/imgextra/i4/O1CN01F1qI7S1BunIFJPiAt_!!6000000000006-0-tps-2618-2050.jpg)
+
+### SDK 示例
+你能够通过调试表单生成 SDK 代码示例，并在编辑器中打开对应的 SDK 代码。
+
+![sdk demo](https://img.alicdn.com/imgextra/i1/O1CN01GVhWTl1waRdYmCn7E_!!6000000006324-0-tps-2630-2038.jpg)
+
+### Code Snippets
+你能通过代码片段快速生成 SDK 代码示例。
+
+在编辑器输入你已订阅的 API 即可搜索到对应 API 的代码段。
+
+![code snippets](https://img.alicdn.com/imgextra/i3/O1CN01iKQA6u1KWMiVttyH0_!!6000000001171-1-tps-915-442.gif)
+
+或者你也可以通过快捷键 `ctrl+cmd+l` 搜索 API，然后选择插入代码段。
+
+![code snippets](https://img.alicdn.com/imgextra/i3/O1CN01dmGwmX1ZyVHozyKx4_!!6000000003263-1-tps-842-468.gif)
+
+## 反馈
+欢迎在我们的 [Github repository](https://github.com/aliyun/alibabacloud-api-vscode-toolkit/issues) 上提交你的问题和建议。
+
+## Requirements
+- Need VS Code 1.75.0 or above.
+
+## Release Notes
+
+### 0.0.6
+- Surpport code snippets.
+
+### 0.0.5
+- Added aliyun-cli installation instructions.
+
+### 0.0.3
+- Support API calling.
+- Support SDK code sample.
+
+### 0.0.1 
+Initial release
+- Support product searching and subscription.
+- Support API searching.
+- Support API Document View.
+
+## License
+
+See the [Apache License 2.0](./LICENSE).
diff --git a/package.json b/package.json
@@ -3,7 +3,7 @@
   "displayName": "Alibaba Cloud API Toolkit",
   "description": "The Alibaba Cloud API Toolkit for VSCode makes it easier to access Alibaba Cloud services.",
   "author": "Alibaba Cloud SDK Team",
-  "version": "0.0.4",
+  "version": "0.0.5",
   "private": true,
   "publisher": "alibabacloud-openapi",
   "license": "Apache-2.0",
@@ -20,6 +20,10 @@
   "main": "./dist/extension",
   "contributes": {
     "commands": [
+      {
+        "command": "alicloud.api.autoImport",
+        "title": "导入依赖"
+      },
       {
         "command": "alicloud.api.githubIssue",
         "title": "feedback",
@@ -59,6 +63,16 @@
         "icon": "$(add)",
         "title": "订阅更多产品"
       },
+      {
+        "command": "alicloud.api.searchProducts",
+        "icon": "$(search)",
+        "title": "搜索产品并订阅"
+      },
+      {
+        "command": "alicloud.api.addSubscription",
+        "icon": "$(add)",
+        "title": "订阅产品"
+      },
       {
         "command": "alicloud.api.removeSubscriptions",
         "icon": "$(notebook-delete-cell)",
@@ -163,6 +177,16 @@
         }
       ],
       "view/item/context": [
+        {
+          "command": "alicloud.api.addSubscription",
+          "when": "view == alicloudApiExplorer && viewItem == PRODUCT",
+          "group": "inline"
+        },
+        {
+          "command": "alicloud.api.searchProducts",
+          "when": "view == alicloudApiExplorer && viewItem == alicloudProducts",
+          "group": "inline"
+        },
         {
           "command": "alicloud.api.addSubscriptions",
           "when": "view == alicloudApiExplorer && viewItem == alicloudAPISubscriptions",

diff --git a/resources/product.svg b/resources/product.svg