Skip to content

Commit d06e67c

Browse files
committed
feat: add Helix IDE configuration instructions
1 parent 78e5e47 commit d06e67c

File tree

1 file changed

+72
-0
lines changed
  • versioned_docs/version-0.11/tools/Ide

1 file changed

+72
-0
lines changed
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,72 @@
1+
---
2+
sidebar_position: 4
3+
---
4+
5+
# Helix
6+
7+
## Quick Start
8+
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+
12+
```bash
13+
which kcl
14+
which kcl-language-server
15+
```
16+
17+
On Windows:
18+
19+
```bash
20+
where kcl
21+
where kcl-language-server
22+
```
23+
24+
- **Step 2.** Amend your Helix `languages.toml` file:
25+
```toml
26+
[[language]]
27+
name = "kcl"
28+
scope = "source.k"
29+
file-types = ["kcl", { glob = "*.k" } ]
30+
roots = ["kcl.mod"]
31+
language-servers = ["kcl-lsp"]
32+
33+
[language-server.kcl-lsp]
34+
command = "kcl-language-server"
35+
```
36+
- **Step 3.** Reopen Helix, create a KCL file, and begin your KCL journey!
37+
38+
## Features
39+
40+
This extension provides comprehensive coding assistance based on the Language Server Protocol.
41+
42+
<!-- - **Highlighting:** Syntax and semantic highlighting -->
43+
- **Code Completion:** Completion for keywords, variable names, attributes, and more
44+
<!-- - **Goto definition:** Navigate to the definition of schema, variables, schema attributes, and imported packages -->
45+
- **Structure:** View the main definition (schema definition) and variables in KCL files
46+
- **Hover:** View identifier information (type and schema documentation)
47+
- **Diagnostics:** Detect warnings and errors in KCL files
48+
- **Code Action:** Quick fix for some errors
49+
- **InlayHint:** Display hints for variable type, functions, and schema arguments
50+
- **Format:** Format a KCL file or snippet code
51+
52+
Other useful features such as diagnostics and testing are under development.
53+
54+
## Dependencies
55+
56+
We recommend using the latest version of KCL.
57+
58+
## Known Issues
59+
60+
See [here](https://github.com/kcl-lang/kcl/issues).
61+
62+
## Ask for help
63+
64+
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.
65+
66+
## Contributing
67+
68+
We are actively working to enhance KCL development on Helix. 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.
69+
70+
## License
71+
72+
Apache License 2.0

0 commit comments

Comments
 (0)