system/serenity
system/serenity
1
0
Fork 0
mirror of https://github.com/SerenityOS/serenity synced 2024-07-22 02:26:11 +00:00
Code Issues Actions 5 Packages Projects Releases Wiki Activity

Documentation: Add instructions for configuring the Helix editor

Browse source
This commit is contained in:
Caoimhe 2023-06-03 00:04:11 +01:00 committed by Andreas Kling
parent 052ca0a246
commit 9ed9a95c15
1 changed files with 18 additions and 0 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

18
Documentation/HelixConfiguration.md Normal file
View file

@ -0,0 +1,18 @@
# Helix Configuration
Helix comes with support for `clangd` and `clang-format` out of the box! However, a small bit of configuration is needed for it to work correctly with SerenityOS.
The following `.clangd` should be placed in the project root:
```yaml
CompileFlags:
CompilationDatabase: Build/x86_64 # Or whatever architecture you're targeting, e.g. aarch64
Add: [-D__serenity__]
```
You also need to configure the clangd server to detect headers properly from the Serenity toolchain. To do this, create a `.helix/languages.toml` file in the project root:
```toml
[[language]]
name = "cpp"
language-server = { command = "clangd", args=["--query-driver=/path/to/serenity/Toolchain/Local/**/*", "--header-insertion=never"] }
```
> Make sure to replace `/path/to/serenity` with the actual path in the snippet above!