ROS2 配置 linter 的代码格式化工具为 clang-format

ROS2 提供的测试框架提供代码静态检查功能(linter),在使用 ros2 pkg create 命令(完整命令如下,供参考)创建空白项目时,会默认启用代码静态检查。

bash 复制代码
ros2 pkg create --build-type ament_cmake hello_world --dependencies rclcpp rclpy

生成的 package.xml 存在以下代码行。

xml 复制代码
<test_depend>ament_lint_auto</test_depend>
<test_depend>ament_lint_common</test_depend>

生成的 CMakeLists.txt 存在以下代码行。

cmake 复制代码
find_package(ament_lint_auto REQUIRED)
# the following line skips the linter which checks for copyrights
# comment the line when a copyright and license is added to all source files
set(ament_cmake_copyright_FOUND TRUE)
# the following line skips cpplint (only works in a git repo)
# comment the line when this package is in a git repo and when
# a copyright and license is added to all source files
set(ament_cmake_cpplint_FOUND TRUE)
ament_lint_auto_find_test_dependencies()

然而,以上默认配置在检查代码格式化时,使用的工具是 uncrustify,这导致了我们的 .clang-format 文件无法被用于测试,colcon test 会因为代码格式不匹配而产生意外的失败用例。

如果希望使用 clang-format 而非 uncrustify,需要进行以下操作。

  1. 安装 ros-${ROS_DISTRO}-ament-cmake-clang-format

    bash 复制代码
    sudo apt install ros-${ROS_DISTRO}-ament-cmake-clang-format

    需要注意的是,还有一个包叫作 ros-${ROS_DISTRO}-ament-clang-format,它被以上包依赖,所以无需手动安装。

    如果因为某些原因你的环境变量没有 ROS_DISTRO,请将以上命令中的 ${ROS_DISTRO} 替换为你的 ROS 发行版,以 humble 为例,完整命令如下。

    bash 复制代码
    sudo apt install ros-humble-ament-cmake-clang-format
  2. CMakeLists.txt 中禁用 uncrustify。

    仿照已有的样板代码,增加下面的代码。

    cmake 复制代码
    set(ament_cmake_uncrustify_FOUND TRUE)
  3. package.xml 中增加 ament-clang-format 依赖。

    xml 复制代码
    <test_depend>ament_clang_format</test_depend>
  4. CMakeLists.txt 中配置要使用的 .clang-format 文件。参见 docs.ros.org/en/ros2_pac...

    cmake 复制代码
    set(ament_cmake_clang_format_CONFIG_FILE "${CMAKE_CURRENT_SOURCE_DIR}/.clang-format")

    以上语句需要在 ament_lint_auto_find_test_dependencies() 之前设置。

CMakeLists.txt 修改后的内容如下,供参考。

cmake 复制代码
find_package(ament_lint_auto REQUIRED)
# the following line skips the linter which checks for copyrights
# comment the line when a copyright and license is added to all source files
set(ament_cmake_copyright_FOUND TRUE)
# the following line skips cpplint (only works in a git repo)
# comment the line when this package is in a git repo and when
# a copyright and license is added to all source files
set(ament_cmake_cpplint_FOUND TRUE)
set(ament_cmake_uncrustify_FOUND TRUE)
set(ament_cmake_clang_format_CONFIG_FILE "${CMAKE_CURRENT_SOURCE_DIR}/.clang-format")
ament_lint_auto_find_test_dependencies()
相关推荐
Dobby_054 小时前
【面试题】C++系列(一)
c++·面经
一拳一个呆瓜4 小时前
【MFC】对话框节点属性:Language(语言)
c++·mfc
点云侠5 小时前
解决Visual Studio 2022编译工程速度慢的问题
开发语言·c++·ide·算法·计算机视觉·visual studio
ajassi20006 小时前
开源 C++ QT Widget 开发(十三)IPC通讯--本地套接字 (Local Socket)
linux·c++·qt·开源
Q741_1476 小时前
C++ 前缀和 高频笔试考点 实用技巧 牛客 DP34 [模板] 前缀和 题解 每日一题
开发语言·c++·算法·前缀和·牛客网
YaoYuan93237 小时前
C++ 容器——unordered_xxx
c++
凤年徐7 小时前
C++类和对象(上):从设计图到摩天大楼的构建艺术
c语言·开发语言·c++·类和对象
一只鱼^_8 小时前
牛客周赛 Round 108
数据结构·c++·算法·动态规划·图论·广度优先·推荐算法
愚润求学9 小时前
【贪心算法】day6
c++·算法·leetcode·贪心算法