Move linters to pre-commit (#298)

Author: christophfroehlich

.clang-format

@@ -1,17 +1,6 @@
 ---
 BasedOnStyle:  Google
 DerivePointerAlignment: false
-IncludeBlocks: Regroup
-IncludeCategories:
-  # Headers in "" with extension.
-  - Regex:  '"([A-Za-z0-9.\Q/-_\E])+"'
-    Priority: 1
-  # Headers in <> without extension.
-  - Regex:  '<([A-Za-z0-9\Q/-_\E])+>'
-    Priority: 2
-  # Headers in <> from specific external libraries.
-  - Regex:  '<(catch2|boost|rclcpp.*)\/'
-    Priority: 3
-  # Headers in <> with extension.
-  - Regex:  '<([A-Za-z0-9.\Q/-_\E])+>'
-    Priority: 4
+IncludeBlocks: Preserve
+InsertBraces: true
+---

.github/workflows/format.yaml

@@ -1,6 +1,3 @@
-# This is a format job. Pre-commit has a first-party GitHub action, so we use
-# that: https://github.com/pre-commit/action
-
 name: Format
 
 on:
@@ -12,17 +9,6 @@ on:
 
 jobs:
   pre-commit:
-    name: pre-commit
-    runs-on: ubuntu-latest
-    steps:
-      - uses: actions/checkout@v6
-      - uses: actions/setup-python@v6
-      - name: Install clang-format
-        run: sudo apt-get install clang-format
-      - uses: pre-commit/[email protected]
-        id: precommit
-      - name: Upload pre-commit changes
-        if: failure() && steps.precommit.outcome == 'failure'
-        uses: rhaschke/upload-git-patch-action@main
-        with:
-          name: pre-commit
+    uses: ros-controls/ros2_control_ci/.github/workflows/reusable-pre-commit.yml@master
+    with:
+      ros_distro: rolling

.pre-commit-config.yaml

@@ -34,6 +34,7 @@ repos:
       - id: check-vcs-permalinks
       - id: check-yaml
         exclude: generate_parameter_library_py/generate_parameter_library_py/test
+        args: ["--allow-multiple-documents"]
       - id: debug-statements
       - id: destroyed-symlinks
       - id: detect-private-key
@@ -75,3 +76,31 @@ repos:
     rev: v3.21.2
     hooks:
       - id: pyupgrade
+
+  - repo: local
+    hooks:
+      - id: ament_cppcheck
+        name: ament_cppcheck
+        description: Static code analysis of C/C++ files.
+        entry: env AMENT_CPPCHECK_ALLOW_SLOW_VERSIONS=1 ament_cppcheck
+        language: system
+        files: \.(h\+\+|h|hh|hxx|hpp|cuh|c|cc|cpp|cu|c\+\+|cxx|tpp|txx)$
+      - id: ament_cpplint
+        name: ament_cpplint
+        description: Static code analysis of C/C++ files.
+        entry: ament_cpplint
+        language: system
+        files: \.(h\+\+|h|hh|hxx|hpp|cuh|c|cc|cpp|cu|c\+\+|cxx|tpp|txx)$
+        args: ["--linelength=100", "--filter=-whitespace/newline"]
+      - id: ament_lint_cmake
+        name: ament_lint_cmake
+        description: Check format of CMakeLists.txt files.
+        entry: ament_lint_cmake
+        language: system
+        files: CMakeLists\.txt$
+      - id: ament_copyright
+        name: ament_copyright
+        description: Check if copyright notice is available in all files.
+        entry: ament_copyright
+        language: system
+        exclude: .*/conf\.py$

example/CMakeLists.txt

@@ -36,12 +36,6 @@ rclcpp_components_register_node(minimal_publisher
 )
 
 if(BUILD_TESTING)
-  find_package(ament_lint_auto REQUIRED)
-  set(ament_cmake_cpplint_FOUND TRUE) # Conflicts with clang-foramt
-  set(ament_cmake_flake8_FOUND TRUE) # Conflicts with black
-  set(ament_cmake_uncrustify_FOUND TRUE) # Conflicts with clang-format
-  ament_lint_auto_find_test_dependencies()
-
   find_package(ament_cmake_gtest REQUIRED)
   # example_test_gtest
   add_rostest_with_parameters_gtest(test_example_gtest test/example_test_gtest.cpp

example/include/generate_parameter_library_example/example_validators.hpp

@@ -28,11 +28,11 @@
 
 #pragma once
 
+#include <fmt/core.h>
+
 #include <string>
 
 #include <rclcpp/rclcpp.hpp>
-
-#include <fmt/core.h>
 #include <tl_expected/expected.hpp>
 
 namespace custom_validators {

example/include/generate_parameter_library_example/minimal_publisher.hpp

@@ -28,6 +28,8 @@
 
 #pragma once
 
+#include <memory>
+
 #include <rclcpp/rclcpp.hpp>
 #include <rclcpp_components/register_node_macro.hpp>
 
@@ -37,7 +39,8 @@ namespace admittance_controller {
 
 class MinimalPublisher : public rclcpp::Node {
  public:
-  MinimalPublisher(const rclcpp::NodeOptions& options = rclcpp::NodeOptions());
+  explicit MinimalPublisher(
+      const rclcpp::NodeOptions& options = rclcpp::NodeOptions());
 
  private:
   void timer_callback();

example/package.xml

@@ -20,9 +20,6 @@
 
   <buildtool_export_depend>ament_cmake_core</buildtool_export_depend>
 
-  <test_depend>ament_lint_auto</test_depend>
-  <test_depend>ament_lint_common</test_depend>
-
   <export>
     <build_type>ament_cmake</build_type>
   </export>

example/test/descriptor_test_gtest.cpp

@@ -29,13 +29,13 @@
 // Author: Chance Cardona
 //
 
+#include <limits>
+#include <memory>
+
 #include "generate_parameter_library_example/admittance_controller_parameters.hpp"
 #include "gtest/gtest.h"
 #include "rclcpp/rclcpp.hpp"
 
-#include <limits>
-#include <memory>
-
 class DescriptorTest : public ::testing::Test {
  public:
   void SetUp() {

example/test/example_test_gmock.cpp

@@ -29,12 +29,12 @@
 // Author: Denis Štogl
 //
 
+#include <memory>
+
 #include "generate_parameter_library_example/admittance_controller_parameters.hpp"
 #include "gmock/gmock.h"
 #include "rclcpp/rclcpp.hpp"
 
-#include <memory>
-
 class ExampleTest : public ::testing::Test {
  public:
   void SetUp() {

example/test/example_test_gtest.cpp

@@ -29,12 +29,12 @@
 // Author: Denis Štogl
 //
 
+#include <memory>
+
 #include "generate_parameter_library_example/admittance_controller_parameters.hpp"
 #include "gtest/gtest.h"
 #include "rclcpp/rclcpp.hpp"
 
-#include <memory>
-
 class ExampleTest : public ::testing::Test {
  public:
   void SetUp() {