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
+43-22Lines changed: 43 additions & 22 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -4,38 +4,59 @@ sidebar_position: 3
4
4
5
5
# IntelliJ IDEA
6
6
7
-
We provide two IntelliJ KCL plugins:
7
+
## Quick Start
8
8
9
-
-IntelliJ KCL: The basic version of the KCL plugin provides syntax highlighting and keyword completion. It is compatible with multiple versions of IntelliJ IDE.
10
-
- IntelliJ KCL LSP: This plugin is implemented based on the [Language Server Protocol（LSP)](https://code.visualstudio.com/api/language-extensions/language-server-extension-guide)and offers additional features such as diagnostics, completion, and hovering. However, due to certain limitations, it can only be used with specific versions.
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
-
> The integration with the Language Server Protocol is created as an extension to the paid IntelliJ-based IDEs. Therefore, plugins using Language Server integration are not available in Community releases of JetBrains products and Android Studio from Google.
13
-
> Starting with the 2023.2 release cycle, the LSP API is publicly available as part of the IntelliJ Platform in the following IDEs: IntelliJ IDEA Ultimate, WebStorm, PhpStorm, PyCharm Professional, DataSpell, RubyMine, CLion, Aqua, DataGrip, GoLand, Rider, and RustRover.
12
+
```bash
13
+
which kcl
14
+
which kcl-language-server
15
+
```
14
16
15
-
## IntelliJ KCL
17
+
On Windows:
16
18
17
-
The basic version of the KCL plugin can be directly downloaded and used from the IntelliJ Plugin Marketplace. It provides syntax highlighting and keyword completion.
18
-
19
+
```bash
20
+
where kcl
21
+
where kcl-language-server
22
+
```
19
23
20
-
## IntelliJ KCL LSP
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!
21
26
22
-
> Please note that the LSP version of the plugin may not be available in all versions of IntelliJ IDE.
-**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
+
-**Code Action:** Quick fix for some errors
38
+
-**InlayHint:** Display hints for variable type, functions, and schema arguments
28
39
29
-
Additionally, you need to install the [kcl-language-server](https://www.kcl-lang.io/docs/user_docs/getting-started/install#install-language-server)and verify that the `kcl-language-server` command is in your PATH. Here are the steps for different operating systems:
40
+
Other useful features such as diagnostics and testing are under development.
30
41
31
-
For macOS and Linux:
42
+
## Dependencies
32
43
33
-
```bash
34
-
which kcl-language-server
35
-
```
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.
36
45
37
-
For Windows:
46
+
The minimum required version for IntelliJ IDEA is 2022.1.
38
47
39
-
```bash
40
-
where kcl-language-server
41
-
```
48
+
## Known Issues
49
+
50
+
See [here](https://github.com/kcl-lang/kcl/issues).
51
+
52
+
## Ask for help
53
+
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
+
56
+
## Contributing
57
+
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
+15-15Lines changed: 15 additions & 15 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -6,39 +6,39 @@ 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
14
14
which kcl-language-server
15
15
```
16
16
17
-
In Windows:
17
+
On Windows:
18
18
19
19
```bash
20
20
where kcl
21
21
where kcl-language-server
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
-
See [here](https://github.com/kcl-lang/kcl/issues/524).
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)
> 与 Language Server Protocol 的集成是作为基于 IntelliJ 的付费 IDE 的扩展而创建的。 因此，使用 LSP 集成的插件在 JetBrains 产品和 Google 的 Android Studio 的社区版本中不可用。
14
-
> 从 2023.2 发布周期开始，LSP API 作为 IntelliJ 平台的一部分在以下 IDE 中公开提供：IntelliJ IDEA Ultimate、WebStorm、PhpStorm、PyCharm Professional、DataSpell、RubyMine、CLion、Aqua、DataGrip、GoLand、Rider 和 RustRover.
0 commit comments