Skip to content

Commit 04c8dbc

Browse files
authoredDec 12, 2023
update readme (#13)
* update readme * 0.0.25
1 parent a781d8b commit 04c8dbc

11 files changed

+25
-18
lines changed
 

‎README.md

+21-14
Original file line numberDiff line numberDiff line change
@@ -1,15 +1,18 @@
11
# TencentCloud Terraform
22

3-
The VSCode TIAT(Tencent Infrastructure Automation for Terraform)Terraform extension is designed to improve the efficiency of DevOps when using Terraform with Tencent Cloud. The extension provides TencentCloud Account login, resource explorer, code auto-complete, argument tips, and command support inside VSCode.
3+
The TIAT(Tencent Infrastructure Automation for Terraform)Terraform VS Code extension is designed to improve the efficiency of DevOps when using Terraform with Tencent Cloud. The extension provides TencentCloud Account login, resource explorer, code auto-complete, argument tips, and command palette inside VSCode.
4+
5+
![demo](./images/readme/demo-overview.gif)
46

57
## Features
68

79
This extension supports the following features:
810

911
- Login: log in Tencent Cloud with AKSK.
1012
- Terraform Commands: init, plan, apply, and destroy through the VSCode command Palette.
11-
- Auto Complete: provides code suggestions and auto-complete resource types, arguments, and options. Provides ways to go to resource documents.
13+
- Auto Complete: provides code suggestions and auto-complete resource types, arguments, and options.
1214
- Code Snippets/Example: provides a completed example code when typing the specified resource type.
15+
- Tips: provides `Go to Terraform definition` to preview resource documents natively instead of through the official website.
1316
- Import Resource: display the existing `CVM` resource and then import it as a tf file by [Terraformer](https://github.com/GoogleCloudPlatform/terraformer).
1417

1518
*TO-DO(Features to be supported in the future):*
@@ -20,7 +23,8 @@ This extension supports the following features:
2023
## Quick Start
2124
### 1.Login Tencent Cloud
2225
Provide Log in entry to Tencent Cloud.
23-
![login](./images/readme/login.png)
26+
![login](./images/readme/demo-login-logout.gif)
27+
2428
After logged, you can see your account and detail when hovering the status bar.
2529
![account_status](./images/readme/account_status.png)
2630

@@ -65,20 +69,24 @@ Open the Command Palette (`Command`+`Shift`+`P` on macOS and `Ctrl`+`Shift`+`P`
6569
</tbody>
6670
</table>
6771

72+
![demo-cmd](./images/readme/demo-cmd.gif)
6873

6974
### 3.Auto Complete
7075
When you typing the resource type, attribute, and options, there is a suggestions dialog.
76+
7177
#### Resource Type
72-
![auto_complete_resourcetype](./images/readme/auto_complete_resourcetype.png)
73-
#### Attribute
74-
![auto_complete_resourcetype](./images/readme/auto_complete_attr.png)
78+
![auto_complete_resType](./images/readme/demo-auto-complete-resType.gif)
79+
80+
#### Argument
81+
![auto_complete_argument](./images/readme/demo-auto-complete-argument.gif)
82+
7583
#### Options(demo)
7684
> NOTE: only support on `tencentcloud_instance` resource.
77-
![auto_complete_resourcetype](./images/readme/auto_complete_attr_options.png)
85+
![auto_complete_options](./images/readme/demo-auto-complete-options.gif)
7886

7987
### 4.Code Snippets/Example
8088
When you typing the `{` after a resource type and name, there is a example suggestions.
81-
![example](./images/readme/example.png)
89+
![example](./images/readme/demo-code-example.gif)
8290

8391
Press `Enter` to insert the whole example.
8492

@@ -91,11 +99,9 @@ Choose one resource to import it.
9199
After a few minutes, the import resource will be in the `generated` folder.
92100

93101
### 6.Resource definition
94-
When you place the cursor on a resource type, use the `go to definition` (`Command` on macOS) button to jump to this resource document of the terraform provider website.
102+
When you open a menu on a terraform resource, click the `Go to Terraform Definition` (`ctrl+shift+D` on macOS/Linux/Windows) item to open a preview panel to display the resource document locally.
95103

96-
![doc_definition](./images/readme/doc_definition.png)
97-
Or, put cursor under the resource type, press `Command`.
98-
![doc](./images/readme/doc.png)
104+
![doc_definition](./images/readme/demo-doc-res.gif)
99105

100106
## Requirements
101107

@@ -118,7 +124,8 @@ This extension requires:
118124
[MIT](LICENSE.md)
119125

120126
## Reference
121-
- [Source code of the tencentcloud terraform provider ](https://github.com/tencentcloudstack/terraform-provider-tencentcloud)
122-
- [Document of the tencentcloud terraform](https://registry.terraform.io/providers/tencentcloudstack/tencentcloud/latest)
127+
- [Document - TencnetCloud Terraform Registry](https://registry.terraform.io/providers/tencentcloudstack/tencentcloud/latest/docs)
128+
- [Repo - TencnetCloud Terraform Provider ](https://github.com/tencentcloudstack/terraform-provider-tencentcloud)
129+
- [Tencent Cloud Terraform extension - Visual Studio Marketplace](https://marketplace.visualstudio.com/items?itemName=Tencent-Cloud.vscode-tencentcloud-terraform)
123130

124131
**Enjoy!**
224 KB
Loading
148 KB
Loading
254 KB
Loading

‎images/readme/demo-cmd.gif

723 KB
Loading

‎images/readme/demo-code-example.gif

1.49 MB
Loading

‎images/readme/demo-doc-res.gif

1.53 MB
Loading

‎images/readme/demo-login-logout.gif

529 KB
Loading

‎images/readme/demo-overview.gif

5.88 MB
Loading

‎package-lock.json

+2-2
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

‎package.json

+2-2
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22
"name": "vscode-tencentcloud-terraform",
33
"displayName": "Tencent Cloud Terraform",
44
"description": "VS Code extension for developing with Terraform on Tencent Cloud",
5-
"version": "0.0.24",
5+
"version": "0.0.25",
66
"license": "MIT",
77
"publisher": "Tencent-Cloud",
88
"icon": "images/tc-tf-logo.png",
@@ -250,7 +250,7 @@
250250
"pretest": "npm run compile && npm run lint",
251251
"lint": "eslint src --ext ts",
252252
"test": "npm run compile",
253-
"vscode:prepublish": "npm run esbuild-base -- --sourcemap",
253+
"vscode:prepublish": "npm run esbuild-base -- --minify",
254254
"esbuild-base": "esbuild ./src/extension.ts --bundle --outfile=out/main.js --external:vscode --format=cjs --platform=node",
255255
"esbuild": "npm run esbuild-base -- --sourcemap",
256256
"esbuild-watch": "npm run esbuild-base -- --sourcemap --watch",

0 commit comments

Comments
 (0)
Please sign in to comment.