autoware_lint_common

A custom version of ament_lint_common for Autoware.

Usage

Add dependencies of ament_lint_auto and autoware_lint_common to your package as below.

package.xml:

<test_depend>ament_lint_auto</test_depend>
<test_depend>autoware_lint_common</test_depend>

CMakeLists.txt:

if(BUILD_TESTING)
  find_package(ament_lint_auto REQUIRED)
  ament_lint_auto_find_test_dependencies()
endif()

For ROS 2 messages and services, you need to remove the ADD_LINTER_TESTS argument in the rosidl_generate_interfaces() function in the CMakelists.txt file.

Then, the following linters will run during colcon test.

• ament_cmake_copyright
• ament_cmake_cppcheck
• ament_cmake_lint_cmake
• ament_cmake_xmllint

Design

The original ament_lint_common contains other formatters/linters like ament_cmake_uncrustify, ament_cmake_cpplint and ament_cmake_flake8. However, we don’t include them because it’s more useful to run them with pre-commit as MoveIt does.

For example, the benefits are:

• We can use any version of tools independent of ament’s version.
• We can easily integrate into IDE.
• We can easily check all the files in the repository without writing test_depend in each package.
• We can run formatters/linters without building, which makes error detection faster.

Ideally, we think other linters should be moved to pre-commit as well, so we’ll try to support them in the future.

Changelog for package autoware_lint_common

1.0.0 (2024-05-02)

• Merge pull request #1 from youtalk/import-from-autoware-common feat: import from autoware_common
• Merge branch 'autoware-lint-common' into import-from-autoware-common
• move to autoware_lint_common
• Contributors: Yutaka Kondo