Linking Conan Include to VS Code

Question

I'm currently using Conan on a C++ project using sqlite_orm as a dependency.

When using my personal include (like myClass.hpp for example) Visual Studio Code is able to provide auto-completion but with Conan's include, no auto-completion is possible.

I'm looking for a way to link the include path of Conan to my VSCode, any idea?

Can you provide an example of your CMake files to show what you have tried so far? — Kevin, Sep 24 '19 at 11:07

score 25 · Accepted Answer · answered Feb 29 '20 at 00:26

25

Add the following line in your project's .vscode/c_cpp_properties.json file

"includePath": ["${workspaceFolder}/**", "~/.conan/data/**"]

answered Feb 29 '20 at 00:26

CodingMedalist

366
3
4

2

Works but requires a restart of VSCode. – Samuel Jenks Jul 14 '20 at 03:09
For me it worked with vscode 1.48.0 without restarting. Thanks for this – hbobenicio Sep 02 '20 at 17:40
Doesn't work on windows. `C:/.conan` is the directory and it doesn't contain `data` . – Konrad Sep 24 '20 at 19:19
Oh and `~/.conan/data` doesn't contain any header files, they are all located in `C:/.conan/somehash/1/include` – Konrad Sep 25 '20 at 07:54
But adding `C:/.conan/**` doesn't work either. https://github.com/microsoft/vscode-cmake-tools/issues/1213 – Konrad Sep 25 '20 at 07:54
I'm gonna stick with VS19/CLion until this is fixed. – Konrad Sep 25 '20 at 07:54
1

for windows in JSON config file for all cpp projects `"C_Cpp.default.includePath": ["${workspaceFolder}/**","${env:USERPROFILE}/.conan/data/**"]` – sdykae Jun 06 '21 at 07:58

score 13 · Answer 2 · answered Jan 07 '22 at 05:13

Add set(CMAKE_EXPORT_COMPILE_COMMANDS ON) to your CMakeLists.txt (or add to cmake: cmake -DCMAKE_EXPORT_COMPILE_COMMANDS=ON ..) so a build/compile_commands.json will be generated.

VS Code (clion, etc) can utilize this file to support auto complete:

$ cat .vscode/c_cpp_properties.json
{
    "configurations": [
    {
        "name": "Linux",
            "defines": [],
            "compilerPath": "/usr/bin/g++",
            "cStandard": "c11",
            "cppStandard": "c++14",
            "intelliSenseMode": "clang-x64",
            "compileCommands": "${workspaceFolder}/build/compile_commands.json"
    }
    ],
    "version": 4
}

score 3 · Answer 3 · edited Sep 24 '19 at 12:22

3

Conan doesn't provide an extension for vscode yet, but you can try:

https://github.com/FIREFOXCYBER/conan-tools-vs-code

It's available on marketplace.

Otherwise, you can add manually the package folder path (e.g. ~/.conan/data/package/version/package/package_id/include) in your settings.

edited Sep 24 '19 at 12:22

Kevin

16,549
8
60
74

answered Sep 24 '19 at 12:08

uilianries

3,363
15
28

solosuper · Answer 4 · 2023-01-30T19:43:52.897

A combination of dvorak4tzx's and spanishgum's answers, combined with VS Code's option for Customizing default settings is the following option:

Generate a build/compile_commands.json eiter by adding to CMakeLists.txt:

set(CMAKE_EXPORT_COMPILE_COMMANDS ON)

or on the command line:

cmake -DCMAKE_EXPORT_COMPILE_COMMANDS=ON

And then insert into .vscode/settings.json:

"C_Cpp.default.compileCommands": "${workspaceFolder}/build/compile_commands.json",

Note: I experienced trouble if

"configurationProvider": "ms-vscode.cmake-tools"

was part of the c_cpp_properties.json. Without it, the IntelliSense works as expected.

I would argue that "includePath": ["${workspaceFolder}/**", "~/.conan/data/**"] is not desired, as you may have many versions of each library beneath ~/.conan/data.

Sources:

score 2 · Answer 5 · answered Sep 24 '19 at 14:35

After searching in the settings of VSCode, I found that you can change the path of your include in c_cpp_properties.json file that you can find in your .vscode folder

Adding the path you want in the includePath field allow you to choose your own include path

score 2 · Answer 6 · answered Jan 28 '21 at 03:05

I want to add that you can also use the .vscode/settings.json file as an alternative to .vscode/c_cpp_properties.json.

For example, I just set up a project with this:

{
  "C_Cpp.clang_format_path": "/usr/lib/llvm-10/bin/clang-format",
  "C_Cpp.default.includePath": [
    "~/.conan/data/**"
  ],
}

Linking Conan Include to VS Code

6 Answers6