Support emitting realpaths in compile_commands.json

[andrewbraxton]

Clangd suffers from a collection of issues when it comes to symlinks in compile_commands.json, for example:

• Go-To-Definition does not resolve symlinks when used on symbols clangd/clangd#197
• Add option to have clangd resolve all symlinks? clangd/clangd#629
• LSP: symlink clangd problem neovim/neovim#31064 (comment)

There doesn't seem to be much inertia towards fixing this in clangd. My suggestion for bear is to have a way to resolve all symlinks and emit only realpaths in compile_commands.json, particularly for the "file" key which is important for go-to-definition functionality. This could come in the form of a flag called something like --resolve-symlinks, or maybe a field in the "output" section of the config file.

[rizsotto]

Thanks @andrewbraxton for this report.

Will implement this in the 4.0 version. My plan is to control this aspect from the config file.

[rizsotto]

@andrewbraxton question for you: is realpath needs to be absolute path? Or that could be relative too?

I am planning to make this as a configuration parameter. And I am wondering if this is represented in a single parameter or with multiple parameters. A single parameter could be: "keep the original", "make it relative", "make it absolute", "make it realpath". A multiple parameter could be something like: "relative", "absolute" and the other parameter can have values like: "realpath", "no change".

[andrewbraxton]

I don't have a preference for single vs multiple parameters, but in either case I'd probably always configure it to use absolute paths anyway. I'm not sure what the use case for using relative paths would be.

[Morozov-5F]

@andrewbraxton @rizsotto Would be really cool to have it configurable both for absolute and relative. My usecase is that I build the code under the docker container and due to several reasons I cannot match the filesystem layout in docker container and in the host system. So I would really prefer having the relative realpath in the compile_commands.json.