vscode-server使用clangd语言服务器阅读代码
vscode-server使用clangd语言服务器阅读代码
本文将详细介绍如何在vscode-server上使用clangd语言服务器进行代码阅读。通过本文,你将学会如何在服务器端安装vscode-server、配置remote-ssh插件、安装clangd插件、准备compile_commands.json文件以及配置clangd的设置。
服务器端安装vscode-server
首先需要查看本地PC端VS Code的版本,重点关注commit ID。接着根据commit ID,通过以下网址下载对应版本的vscode-server(即vscode-server-linux-x64.tar.gz):
https://update.code.visualstudio.com/commit:${commit_id}/server-linux-x64/stable
将下载好的vscode-server-linux-x64.tar.gz文件拷贝到编译服务器的家目录下,然后执行以下命令:
mkdir .vscode-server/bin
tar -xf ./vscode-server-linux-x64.tar.gz -C ./.vscode-server/bin/
mv ./.vscode-server/bin/vscode-server-linux-x64 ./.vscode-server/bin/${commit_id} #这里${commit_id}替换成自己的
使用remote-ssh插件远程连接编译服务器
远程连接编译服务器的具体步骤可以参考这里。正确连接后,在VS Code的设置界面可以看到"Remote [SSH: xxxxx]"的提示,说明连接成功。在这里可以配置vscode-server的相关设置项。
vscode-server安装clangd插件
插件的安装方式可以自行百度。如果编译服务器不能联网,可以在本地PC上先安装好,然后将插件从PC上的.vscode/extensions
目录拷贝到服务器的.vscode-server/extensions
目录下。成功安装后如下图所示:
其他插件可以根据需要自行安装。
安装clangd语言服务器
clangd是LLVM工具集的一部分,因此实际上需要安装的是LLVM。可以选择自行下载源码编译,也可以使用官方发布的版本直接使用。下载链接可以参考LLVM的官方网站。
对于Ubuntu 18.04系统,可以使用以下链接中的clang+llvm-15.0.0-powerpc64le-linux-ubuntu-18.04.6.tar.xz:
下载完成后,在编译服务器的软件安装目录下解压,进入文件夹后执行以下命令:
export LD_LIBRARY_PATH=/home/nx666/local/clangd/lib:$LD_LIBRARY_PATH
其中/home/nx666/local/clangd/lib
是刚刚解压出来的绝对路径,可以通过pwd
命令查看。
之后需要将clangd所在的路径配置到vscode-server中。图中显示的是clangd安装在root目录下的情况,读者需要根据自己的clangd安装路径进行设置,路径最后需要指定到可执行文件clangd。
准备compile_commands.json文件
clangd需要compile_commands.json文件中的信息来解析代码工程。对于使用make编译的代码,可以使用bear来生成compile_commands.json。可以自行编译bear,如果服务器环境与作者相似,可以参考这里获取相关工具。
指定clangd的配置信息
在.vscode/settings.json
文件中写入clangd的配置信息。需要注意以下几点:
--compile-commands-dir
:指定compile_commands.json文件所在目录,可以通过bear、cmake等方式生成。--query-driver
:指定交叉编译工具链的路径。
示例配置如下:
"clangd.arguments": [
"--compile-commands-dir=${workspaceFolder}/.vscode",
"--background-index",
"-j=12",
"--folding-ranges",
"--query-driver=/home/nx666/local/gcc-riscv/wch-riscv-embed-gcc/bin/riscv-none-embed*",
"--clang-tidy",
"--clang-tidy-checks=performance-*,bugprone-*",
"--all-scopes-completion",
"--completion-style=detailed",
"--function-arg-placeholders",
"--header-insertion=iwyu",
"--pch-storage=memory",
],
通过以上步骤,你就可以在vscode-server上使用clangd进行代码阅读了。这个配置特别适合需要远程开发和调试的场景,可以大大提高开发效率。