beenull/ladybird
1
0
Fork 0
mirror of https://github.com/LadybirdBrowser/ladybird.git synced 2024-11-21 23:20:20 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions 6

Documentation: Update VSCode Configuration to minimize rebuilds

Browse source
This commit is contained in:
Andrew Kaster 2024-07-13 14:42:13 -06:00 committed by Andreas Kling
parent 53f4e98818
commit 182f83d456
Notes: sideshowbarker 2024-07-17 05:09:48 +09:00 
Author: https://github.com/ADKaster
Commit: https://github.com/LadybirdBrowser/ladybird/commit/182f83d456
Pull-request: https://github.com/LadybirdBrowser/ladybird/pull/618
Reviewed-by: https://github.com/awesomekling
1 changed files with 33 additions and 1 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

34
Documentation/VSCodeConfiguration.md
View file

@ -12,8 +12,31 @@ The recommended extensions for VS Code include:
## Configuration
To be compatible with `./Meta/ladybird.sh`, we must set CC and CXX to the correct compilers for *both* configure and build. This can be done in the `.vscode/settings.json` file.
```json
{
"cmake.configureEnvironment": {
"CC": "clang-18",
"CXX": "clang++-18"
},
"cmake.buildEnvironment": {
"CC": "clang-18",
"CXX": "clang++-18"
},
"clangd.path": "clangd-18"
}
```
Run `./Meta/ladybird.sh build` at least once to kick off downloading and building vcpkg dependencies.
The CMake Tools plugin should automatically detect the `CMakePresets.json` at the root of the repository.
Selecting and activating the `default` preset should be enough to get started.
Selecting and activating the `default` preset should be enough to get started after the initial build.
You can also use the `Debug` preset to build with debug symbols, or the `Sanitizer` preset to build with ASAN/UBSAN.
If building through VsCode itself causes vcpkg to rebuild the world, verify that the environment settings match the `CMAKE_CXX_COMPILER` line in the build directory's `CMakeCache.txt`.
For additional settings recommendations, see the [Settings](#settings) section below.
## Code comprehension
@ -130,6 +153,15 @@ These belong in the `.vscode/settings.json` of Serenity.
// git commit message length
"git.inputValidationLength": 72,
"git.inputValidationSubjectLength": 72,
"cmake.configureEnvironment": {
"CC": "clang-18",
"CXX": "clang++-18"
},
"cmake.buildEnvironment": {
"CC": "clang-18",
"CXX": "clang++-18"
},
"clangd.path": "clangd-18",
"clangd.arguments": [
"--header-insertion=never" // See https://github.com/clangd/clangd/issues/1247
]