mirror of
https://github.com/LadybirdBrowser/ladybird.git
synced 2024-09-11 21:37:58 +03:00
Meta: Add .clangd config file (with project-recommended defaults)
This change also removes parts of the existing docs that explain how to create a .clangd file with the project-recommended defaults. (Those docs are no longer necessary — since this change adds a .clangd file to the repo, containing those same defaults).
This commit is contained in:
parent
65d8d205ee
commit
b832837106
Notes:
sideshowbarker
2024-07-16 21:45:42 +09:00
Author: https://github.com/sideshowbarker 🔰 Commit: https://github.com/LadybirdBrowser/ladybird/commit/b832837106 Pull-request: https://github.com/LadybirdBrowser/ladybird/pull/526 Reviewed-by: https://github.com/ADKaster ✅
6
.clangd
Normal file
6
.clangd
Normal file
@ -0,0 +1,6 @@
|
|||||||
|
CompileFlags:
|
||||||
|
CompilationDatabase: Build/ladybird
|
||||||
|
|
||||||
|
Diagnostics:
|
||||||
|
UnusedIncludes: None
|
||||||
|
MissingIncludes: None
|
@ -4,20 +4,10 @@ Emacs can be configured with `lsp-mode` and `clangd` to work well.
|
|||||||
|
|
||||||
### clangd
|
### clangd
|
||||||
|
|
||||||
The official clangd extension can be used for C++ comprehension. You
|
The official clangd extension can be used for C++ comprehension.
|
||||||
can use the following `.clangd` file placed in the project root:
|
|
||||||
|
|
||||||
```yaml
|
Run cmake (`Meta/ladybird.sh run ladybird` or similar) at least once for clangd
|
||||||
CompileFlags:
|
to work, as doing so will generate the `Build/ladybird/compile_commands.json`
|
||||||
CompilationDatabase: Build/ladybird
|
|
||||||
|
|
||||||
Diagnostics:
|
|
||||||
UnusedIncludes: None
|
|
||||||
MissingIncludes: None
|
|
||||||
```
|
|
||||||
|
|
||||||
Run cmake (`Meta/ladybird.sh run ladybird` or similar) at least once for this
|
|
||||||
to work, as it will generate the `Build/ladybird/compile_commands.json`
|
|
||||||
that is needed by `clangd`.
|
that is needed by `clangd`.
|
||||||
|
|
||||||
### lsp-mode
|
### lsp-mode
|
||||||
|
@ -1,17 +1,5 @@
|
|||||||
# Helix Configuration
|
# 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 Ladybird.
|
Helix comes with support for `clangd` and `clang-format` out of the box! However, you also need to configure the clangd server to not insert headers improperly. To do this, create a `.helix/languages.toml` file in the project root:
|
||||||
|
|
||||||
The following `.clangd` should be placed in the project root:
|
|
||||||
```yaml
|
|
||||||
CompileFlags:
|
|
||||||
CompilationDatabase: Build/ladybird
|
|
||||||
|
|
||||||
Diagnostics:
|
|
||||||
UnusedIncludes: None
|
|
||||||
MissingIncludes: None
|
|
||||||
```
|
|
||||||
|
|
||||||
You also need to configure the clangd server to not insert headers improperly. To do this, create a `.helix/languages.toml` file in the project root:
|
|
||||||
```toml
|
```toml
|
||||||
[language-server.ladybird]
|
[language-server.ladybird]
|
||||||
command = "clangd"
|
command = "clangd"
|
||||||
|
@ -7,17 +7,7 @@ project:
|
|||||||
2. With [coc.nvim](https://github.com/neoclide/coc.nvim) (from scratch, potentially out of date)
|
2. With [coc.nvim](https://github.com/neoclide/coc.nvim) (from scratch, potentially out of date)
|
||||||
|
|
||||||
For both setups, make sure you ran `./Meta/ladybird.sh run ladybird` at least
|
For both setups, make sure you ran `./Meta/ladybird.sh run ladybird` at least
|
||||||
once. Additionally, clangd should be configured with the following (in the
|
once.
|
||||||
`.clangd` file at the root of the project):
|
|
||||||
|
|
||||||
```yaml
|
|
||||||
CompileFlags:
|
|
||||||
CompilationDatabase: Build/ladybird
|
|
||||||
|
|
||||||
Diagnostics:
|
|
||||||
UnusedIncludes: None
|
|
||||||
MissingIncludes: None
|
|
||||||
```
|
|
||||||
|
|
||||||
## With nvim-lspconfig
|
## With nvim-lspconfig
|
||||||
|
|
||||||
|
@ -24,19 +24,6 @@ Clangd has the best support for modern compilers, especially if configured as no
|
|||||||
The official clangd extension can be used for C++ comprehension. It is recommended in general, as it is most likely to work on all platforms.
|
The official clangd extension can be used for C++ comprehension. It is recommended in general, as it is most likely to work on all platforms.
|
||||||
|
|
||||||
clangd uses ``compile_commands.json`` files to understand the project. CMake will generate these in Build/ladybird.
|
clangd uses ``compile_commands.json`` files to understand the project. CMake will generate these in Build/ladybird.
|
||||||
Depending on which configuration you use most, set the CompilationDatabase configuration item in the below ``.clangd`` file accordingly. It goes at the root of your checkout (``ladybird/.clangd``):
|
|
||||||
|
|
||||||
```yaml
|
|
||||||
CompileFlags:
|
|
||||||
CompilationDatabase: Build/ladybird
|
|
||||||
|
|
||||||
Diagnostics:
|
|
||||||
UnusedIncludes: None
|
|
||||||
MissingIncludes: None
|
|
||||||
```
|
|
||||||
|
|
||||||
The UnusedIncludes and MissingIncludes flags are used to disable the [Include Cleaner](https://clangd.llvm.org/design/include-cleaner) feature of newer clangd releases.
|
|
||||||
It can be re-enabled if you don't mind the noisy inlay hints and problems in the problem view.
|
|
||||||
|
|
||||||
Run ``./Meta/ladybird.sh run ladybird`` at least once to generate the ``compile_commands.json`` file.
|
Run ``./Meta/ladybird.sh run ladybird`` at least once to generate the ``compile_commands.json`` file.
|
||||||
|
|
||||||
|
Loading…
Reference in New Issue
Block a user