You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: docs/tools/Ide/intellij.md
+17-17Lines changed: 17 additions & 17 deletions
Original file line number
Diff line number
Diff line change
@@ -6,8 +6,8 @@ sidebar_position: 3
6
6
7
7
## Quick Start
8
8
9
-
-**Step 1.**[Install KCL](https://kcl-lang.io/docs/user_docs/getting-started/install) on your system. Please check that `kcl` and `kcl-language-server` are installed and have been added to your PATH:
10
-
In MacOs and Linux:
9
+
-**Step 1.**[Install KCL](https://kcl-lang.io/docs/user_docs/getting-started/install)on your system. Please ensure that `kcl` and `kcl-language-server` are installed and added to your PATH:
10
+
On MacOS and Linux:
11
11
12
12
```bash
13
13
which kcl
@@ -21,41 +21,41 @@ sidebar_position: 3
21
21
where kcl-language-server
22
22
```
23
23
24
-
-**Step 2.** Install the [KCL plugin](https://plugins.jetbrains.com/plugin/23378-kcl) from Jetbrains Plugins Marketplace.
25
-
-**Step 3.** Reopen IntelliJ IDEA and create a KCL file and begin your KCL tour!
24
+
-**Step 2.** Install the [KCL plugin](https://plugins.jetbrains.com/plugin/23378-kcl) from the Jetbrains Plugins Marketplace.
25
+
-**Step 3.** Reopen IntelliJ IDEA, create a KCL file, and begin your KCL journey!
26
26
27
27
## Features
28
28
29
-
This extension provides many coding assistance based on Language Server Protocol.
29
+
This extension provides comprehensive coding assistance based on the Language Server Protocol.
30
30
31
-
-**Highlight:** Syntax and semantic highlight
32
-
-**Completion:** Completion for keywords, variable name, attributes and more
33
-
-**Goto definition:**Goto definition of schema, variable, schema attribute, and import pkg
34
-
-**Structure:**Main definition(schema def) and variables in KCL file
35
-
-**Hover:**Identifier information (type and schema documentation)
36
-
-**Diagnostics:**Warnings and errors in KCL file
31
+
-**Highlighting:** Syntax and semantic highlighting
32
+
-**Code Completion:** Completion for keywords, variable names, attributes, and more
33
+
-**Goto definition:**Navigate to the definition of schema, variables, schema attributes, and imported packages
34
+
-**Structure:**View the main definition(schema definition) and variables in KCL files
35
+
-**Hover:**View identifier information (type and schema documentation)
36
+
-**Diagnostics:**Detect warnings and errors in KCL files
37
37
-**Code Action:** Quick fix for some errors
38
-
-**InlayHint:**Hint for variable type, function and schema args
38
+
-**InlayHint:**Display hints for variable type, functions, and schema arguments
39
39
40
-
Other useful features such as diagnostics and testing are in developing.
40
+
Other useful features such as diagnostics and testing are under development.
41
41
42
42
## Dependencies
43
43
44
-
We recommend that you use the latest version of KCL, but the minimum required version for this extension is 0.4.6. If you are using an earlier version, the extension may not work properly.
44
+
We recommend using the latest version of KCL, but the minimum required version for this extension is 0.4.6. If you are using an earlier version, the extension may not work properly.
45
45
46
-
The minimun required version for IntelliJ IDEA is 2022.1
46
+
The minimum required version for IntelliJ IDEA is 2022.1.
47
47
48
48
## Known Issues
49
49
50
50
See [here](https://github.com/kcl-lang/kcl/issues).
51
51
52
52
## Ask for help
53
53
54
-
If the extension isn't working as you expect, please contact us with [community](https://kcl-lang.io/docs/community/intro/support) for help.
54
+
If the extension does not behave as expected, please reach out to us through the [community](https://kcl-lang.io/docs/community/intro/support) for assistance.
55
55
56
56
## Contributing
57
57
58
-
We are working actively on improving the KCL development on VS Code. All kinds of contributions are welcomed. You can refer to our [contribution guide](https://kcl-lang.io/docs/community/contribute). It introduces how to build and run the extension locally, and describes the process of sending a contribution.
58
+
We are actively working to enhance KCL development on VS Code. We welcome all types of contributions. You can consult our [contribution guide](https://kcl-lang.io/docs/community/contribute), which explains how to build and run the extension locally and describes the contribution process.
Copy file name to clipboardExpand all lines: docs/tools/Ide/vs-code.md
+13-13Lines changed: 13 additions & 13 deletions
Original file line number
Diff line number
Diff line change
@@ -6,8 +6,8 @@ sidebar_position: 1
6
6
7
7
## Quick Start
8
8
9
-
-**Step 1.**[Install KCL](https://kcl-lang.io/docs/user_docs/getting-started/install) on your system. Please check that `kcl` and `kcl-language-server` are installed and have been added to your PATH:
10
-
In MacOs and Linux:
9
+
-**Step 1.**[Install KCL](https://kcl-lang.io/docs/user_docs/getting-started/install)on your system. Please ensure that `kcl` and `kcl-language-server` are installed and added to your PATH:
10
+
On MacOS and Linux:
11
11
12
12
```bash
13
13
which kcl
@@ -22,23 +22,23 @@ sidebar_position: 1
22
22
```
23
23
24
24
-**Step 2.** Install the [KCL extension](https://marketplace.visualstudio.com/items?itemName=kcl.kcl-vscode-extension) for Visual Studio Code. This extension requires the VS Code 1.50+.
25
-
-**Step 3.** Reopen VS Code and create a KCL file and begin your KCL tour!
25
+
-**Step 3.** Reopen VS Code, create a KCL file, and begin your KCL journey!
26
26
27
27
## Features
28
28
29
29
This extension provides some coding assistance, including the following features:
> Tips: You can enhance the effect of diagnostics by installing another extension: [Error Lens](https://marketplace.visualstudio.com/items?itemName=usernamehw.errorlens).
@@ -47,26 +47,26 @@ This extension provides some coding assistance, including the following features
Other useful features such as refactoring and testing are in development.
54
54
55
55
## Dependencies
56
56
57
-
We recommend that you use the latest version of KCL, but the minimum required version for this extension is 0.4.6. If you are using an earlier version, the extension may not work properly.
57
+
We recommend using the latest version of KCL, but the minimum required version for this extension is 0.4.6. If you are using an earlier version, the extension may not work properly.
58
58
59
59
## Known Issues
60
60
61
61
See [here](https://github.com/kcl-lang/kcl/issues).
62
62
63
63
## Ask for help
64
64
65
-
If the extension isn't working as you expect, please contact us with [community](https://kcl-lang.io/docs/community/intro/support) for help.
65
+
If the extension does not behave as expected, please reach out to us through the [community](https://kcl-lang.io/docs/community/intro/support) for assistance.
66
66
67
67
## Contributing
68
68
69
-
We are working actively on improving the KCL development on VS Code. All kinds of contributions are welcomed. You can refer to our [contribution guide](https://kcl-lang.io/docs/community/contribute). It introduces how to build and run the extension locally, and describes the process of sending a contribution.
69
+
We are actively working to enhance KCL development on VS Code. We welcome all types of contributions. You can consult our [contribution guide](https://kcl-lang.io/docs/community/contribute), which explains how to build and run the extension locally and describes the contribution process.
The KCL Extension extension provides some coding assistance, e.g., highlight, goto definition, completion, hover, outline, and diagnostics. You can go [here](/docs/tools/Ide/vs-code) for more information about the installation.
207
+
The KCL Extension provides comprehensive coding assistance, offering features such as highlighting, go-to definition, completion, hover, outline, and diagnostics. For more information about the installation, please visit [here](/docs/tools/Ide/vs-code)
0 commit comments