cmake-language-server's Introduction

cmake-language-server

CMake LSP Implementation.

Alpha Stage, work in progress.

Features

Builtin command completion
Documentation for commands and variables on hover
Formatting

Commands

cmake-language-server: LSP server
cmake-format: CLI frontend for formatting

Installation

$ pip install cmake-language-server

Tested Clients

Neovim (neoclide/coc.nvim, prabirshrestha/vim-lsp)

Neovim

coc.nvim

  "languageserver": {
    "cmake": {
      "command": "cmake-language-server",
      "filetypes": ["cmake"],
      "rootPatterns": [
        "build/"
      ],
      "initializationOptions": {
        "buildDirectory": "build"
      }
    }
  }

vim-lsp

if executable('cmake-language-server')
  au User lsp_setup call lsp#register_server({
  \ 'name': 'cmake',
  \ 'cmd': {server_info->['cmake-language-server']},
  \ 'root_uri': {server_info->lsp#utils#path_to_uri(lsp#utils#find_nearest_parent_file_directory(lsp#utils#get_buffer_path(), 'build/'))},
  \ 'whitelist': ['cmake'],
  \ 'initialization_options': {
  \   'buildDirectory': 'build',
  \ }
  \})
endif

Configuration

buildDirectory This language server uses CMake's file API to get cached variables. The API communicates using <buildDirectory>/.cmake/api/. buildDirectory is relative path to the root uri of the workspace. To configure the build tree, you need to run the cmake command such as cmake .. -DFOO=bar.

Recommend Projects