mirror of https://github.com/LadybirdBrowser/ladybird.git synced 2024-11-21 23:20:20 +00:00

sideshowbarker b832837106 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).

2024-07-09 04:40:52 -06:00

6.3 KiB

Raw Blame History

Neovim Project Configuration

There are two documented ways to support clangd in Neovim for the Ladybird project:

With nvim-lspconfig (assumes existing setup)
With coc.nvim (from scratch, potentially out of date)

For both setups, make sure you ran ./Meta/ladybird.sh run ladybird at least once.

With nvim-lspconfig

Note: This guide assumes Lua is being used, but can easily be adapted to VimScript.

If you have an nvim-lspconfig, setup already, registering clangd is similar to other LSPs:

require('lspconfig').clangd.setup {
  -- If you have an on_attach function, this is where you'd put it. If not, 
  -- you can delete this line.
  -- on_attach = ...,

  -- This is where you'd put capabilities (i.e. if you're useing nvim-cmp)
  -- capabilities = ...,

  -- If you have another clangd installation, put it here. Note that we use 
  -- clangd version 18 for the Ladybird project.
  -- cmd = { '/path/to/clangd' },
}

A base setup call should be enough to register the LSP, but if false-negative LSP errors occur upon opening Neovim, make sure your clangd installation is at least version 18.

With coc.nvim

Note: This guide assumes VimScript is being used, but can easily be adapted to Lua. It also starts from scratch.

Neovim can be configured to use the coc-clangd plugin to provide code-completion as well as inline git blame using vim-plug. Formatting can also be configured with formatter.nvim.

Install vim-plug

See https://github.com/junegunn/vim-plug.

Install coc.nvim

The config file for neovim is at ~/.config/nvim/init.vim or if set $XDG_CONFIG_HOME/nvim/init.vim.

Add the Plugin:

Plug 'neoclide/coc.nvim', { 'branch': 'release' }

Run :PlugInstall inside nvim.

Install coc-clangd via CocInstall

:CocInstall coc-clangd

Note

: This guide is tested with clangd version 14.0.6 and 15.0.6.

In case you have not installed clangd already install it with :CocCommand clangd.install.

This will install a separate version of clangd just for neovim.

Configure coc-clangd in coc-settings.json

Use the following settings to ensure that coc-clangd works out of the box.

Note

: You might want to adjust the clangd.fallbackFlags depending on your build system and customize the inlayHints.sep based on your preference.

{
    "clangd.fallbackFlags": ["-std=c++23"],
    "semanticTokens.enable": true,
    "inlayHint.subSeparator": "︴",
    "inlayHints.enableParameter": true,
    "clangd.inlayHints.sep": "⇝"
}

To change the coc-settings.json go to the file ~/.config/nvim/coc-settings.json or type :CocConfig in the command line.

Note

: In case you already had another c++ language server configured in the coc-settings.json you might want to nuke it first and work towards your desired config by adding the other parts back in to avoid conflicts.

Note

: If you have configured clangd as a languageServer in coc-settings.json, you should remove it to avoid running clangd twice!

Note

: clangd.inlayHints.sep breaks on clangd 15.0.6.

Formatting

For code formatting the formatter plugin can be used.

Plug 'mhartington/formatter.nvim'

Configuration

To use the formatter plugin one needs to opt-in to specific formatters. An example lua configuration which uses clang-format for cpp files:

require("formatter").setup{
    filetype = {
        cpp = {
            require("formatter.filetypes.cpp").clangformat
        }
    }
}

Install git blame (Optional)

Plug 'f-person/git-blame.nvim'