This extension makes it easier to work with catkin-tools.
- Watches the build directory of the current catkin-tools workspace for changes in
- Implements a C/C++ configuration provider using these compile commands, enabling auto completion
- Provides catkin build tasks for
- Build all packages in the workspace
- Build the package containing the currently open file
- Provides Test Explorer client to handle GTest targets
Setup / Configuration
This extension activates itself only if there is a top level
.catkin_tools directory in your opened workspace.
In a standard catkin layout, this means that the opened workspace should look like the following:
If you do not want to list
devel, etc., we suggest you add them to
your workspace's exclude list in your
The folders for
log spaces can also be called differently, only the
src space is required.
This way, arbitrary catkin profiles are supported.
Make sure that your catkin_tools workspace is set up to generate
Make sure to
- use this extension as the configurationProvider for
- use the default intellisense mode.
This extensions registers itself as TestExplorer adapter.
For this, all
CMakeLists.txt are scanned for keywords hinting at the existence of
CTest based unit tests, e.g.
This is done with a list of regular expressions.
If you have a custom macro for registering tests, you can customize this behavior via the
in your workspace settings will list all
catkin_add_gtest tests and all tests matching
Make sure that
CMAKE_EXPORT_COMPILE_COMMANDS is set in your catkin projects, e.g. by configuring catkin with
catkin config --cmake-args -DCMAKE_BUILD_TYPE=Debug -DCMAKE_EXPORT_COMPILE_COMMANDS=ON
C/C++ Clang Command Adapter compatibility
Using this extension with C/C++ Clang Command Adapter auto completion causes too many symbols to show up in IntelliSense auto completion.
If you are using the extension, we suggest you set the option
in your workspace settings.
You can register catkin build as the default task like this: