Add C++ and CMake pre-commit hooks (#8)

* ci: add C++ and CMake pre-commit hooks with GitHub Actions workflow

* chore(lint): fix cpplint and ament_lint warnings in headers

* chore(lint): disable cpplint include order check to align with clang-format

Author: kluge7

.github/workflows/pre-commit.yml

@@ -0,0 +1,11 @@
+name: pre-commit
+
+on:
+  pull_request:
+  workflow_dispatch:
+jobs:
+  call_reusable_workflow:
+    uses: vortexntnu/vortex-ci/.github/workflows/reusable-pre-commit.yml@main
+    with:
+        ros_distro: 'humble'
+        config_path: '.pre-commit-config-local.yaml'

.pre-commit-config-local.yaml

@@ -0,0 +1,51 @@
+# To install:
+#
+#     pip install pre-commit identify
+#
+# To use:
+#
+#     pre-commit run --all-files -c .pre-commit-config-local.yaml
+#
+# Or to install it for automatic checks on commit:
+#
+#     pre-commit install -c .pre-commit-config-local.yaml
+#
+# To update this file:
+#
+#     pre-commit autoupdate -c .pre-commit-config-local.yaml
+#
+# See https://pre-commit.com/ for documentation
+#
+# NOTE: This configuration uses local hooks specific to ROS2 (ament_* linters)
+
+repos:
+  # C++ hooks
+  - 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)$
+  - repo: local
+    hooks:
+      - 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,-legal/copyright,-build/include_order"
+        ]
+  # CMake hooks
+  - repo: local
+    hooks:
+      - id: ament_lint_cmake
+        name: ament_lint_cmake
+        description: Check format of CMakeLists.txt files.
+        entry: ament_lint_cmake
+        language: system
+        files: CMakeLists\.txt$

.pre-commit-config.yaml

@@ -1,3 +1,7 @@
+# To install:
+#
+#     pip install pre-commit identify
+#
 # To use:
 #
 #     pre-commit run -a
@@ -15,7 +19,7 @@
 repos:
   # Standard hooks
   - repo: https://github.com/pre-commit/pre-commit-hooks
-    rev: v5.0.0
+    rev: v6.0.0
     hooks:
       - id: check-added-large-files
       - id: check-ast
@@ -35,7 +39,7 @@ repos:
       - id: requirements-txt-fixer
   # Python hooks
   - repo: https://github.com/astral-sh/ruff-pre-commit
-    rev: v0.12.2
+    rev: v0.14.3
     hooks:
       - id: ruff-format
       - id: ruff

image-filtering/include/image_filters/image_filtering_ros.hpp

@@ -1,18 +1,20 @@
-#ifndef IMAGE_FILTERING_ROS_HPP
-#define IMAGE_FILTERING_ROS_HPP
+#ifndef IMAGE_FILTERS__IMAGE_FILTERING_ROS_HPP_
+#define IMAGE_FILTERS__IMAGE_FILTERING_ROS_HPP_
 
 #include <cv_bridge/cv_bridge.h>
 #include <spdlog/spdlog.h>
+#include <memory>
 #include <rclcpp/parameter_event_handler.hpp>
 #include <rclcpp/qos.hpp>
 #include <rclcpp/rclcpp.hpp>
 #include <sensor_msgs/msg/image.hpp>
+#include <string>
 #include "image_processing.hpp"
 
 class ImageFilteringNode : public rclcpp::Node {
    public:
     explicit ImageFilteringNode(const rclcpp::NodeOptions& options);
-    ~ImageFilteringNode() {};
+    ~ImageFilteringNode() {}
 
    private:
     /**
@@ -109,4 +111,4 @@ class ImageFilteringNode : public rclcpp::Node {
     std::string filter_;
 };
 
-#endif  // IMAGE_FILTERING_ROS_HPP
+#endif  // IMAGE_FILTERS__IMAGE_FILTERING_ROS_HPP_

image-filtering/include/image_filters/image_processing.hpp

@@ -1,5 +1,5 @@
-#ifndef IMAGE_PROCESSING_HPP
-#define IMAGE_PROCESSING_HPP
+#ifndef IMAGE_FILTERS__IMAGE_PROCESSING_HPP_
+#define IMAGE_FILTERS__IMAGE_PROCESSING_HPP_
 
 #include <iostream>
 #include <map>
@@ -9,6 +9,7 @@
 #include <opencv2/imgcodecs.hpp>
 #include <opencv2/imgproc.hpp>
 #include <opencv2/xphoto.hpp>
+#include <string>
 
 struct FlipParams {
     int flip_code;
@@ -131,7 +132,7 @@ void otsu_segmentation_filter(const FilterParams& params,
                               const cv::Mat& original,
                               cv::Mat& output);
 
-const static std::map<std::string, FilterFunction> filter_functions = {
+static const std::map<std::string, FilterFunction> filter_functions = {
     {"no_filter", no_filter},
     {"flip", flip_filter},
     {"sharpening", sharpening_filter},
@@ -142,4 +143,4 @@ const static std::map<std::string, FilterFunction> filter_functions = {
     {"ebus", ebus_filter},
     {"otsu", otsu_segmentation_filter}};
 
-#endif  // IMAGE_PROCESSING_HPP
+#endif  // IMAGE_FILTERS__IMAGE_PROCESSING_HPP_

image-filtering/src/image_filtering_ros.cpp

@@ -149,7 +149,6 @@ void ImageFilteringNode::image_callback(
             spdlog::error("Received empty image, skipping processing.");
             return;
         }
-
     } catch (cv_bridge::Exception& e) {
         spdlog::error("cv_bridge exception: {}", e.what());
         return;