Added pre-commit Action and pre-commit formatting fixes

.github/workflows/ci.yml

@@ -97,4 +97,3 @@ jobs:
           set -x
           [[ ! -z "${{ matrix.config.asan_options }}" ]]  && export ASAN_OPTIONS="${{ matrix.config.asan_options }}"
           ctest --build-config Asan --output-on-failure --test-dir .build
-

.github/workflows/pre-commit.yml

@@ -0,0 +1,76 @@
+name: Lint Check (pre-commit)
+
+on:
+  # We have to use pull_request_target here as pull_request does not grant
+  # enough permission for reviewdog
+  pull_request_target:
+  push:
+
+jobs:
+  pre-commit-push:
+    name: Pre-Commit check on Push
+    runs-on: ubuntu-latest
+    if: ${{ github.event_name == 'push' }}
+
+    steps:
+      - name: Checkout repository
+        uses: actions/checkout@v4
+
+      - name: Set up Python
+        uses: actions/setup-python@v5
+        with:
+          python-version: 3.13
+
+        # We wish to run pre-commit on all files instead of the changes
+        # only made in the push commit.
+        #
+        # So linting error persists when there's formatting problem.
+      - uses: pre-commit/[email protected]
+
+  pre-commit-pr:
+    name: Pre-Commit check on PR
+    runs-on: ubuntu-latest
+    if: ${{ github.event_name == 'pull_request_target' }}
+
+    permissions:
+      contents: read
+      checks: write
+      issues: write
+      pull-requests: write
+
+    steps:
+      - name: Checkout repository
+        uses: actions/checkout@v4
+
+        # pull_request_target checkout the base of the repo
+        # We need to checkout the actual pr to lint the changes.
+      - name: Checkout pr
+        run: gh pr checkout ${{ github.event.number }}
+        env:
+          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+
+      - name: Set up Python
+        uses: actions/setup-python@v5
+        with:
+          python-version: 3.13
+
+        # we only lint on the changed file in PR.
+      - name: Get Changed Files
+        id: changed-files
+        uses: tj-actions/changed-files@v45
+
+        # See:
+        # https://github.com/tj-actions/changed-files?tab=readme-ov-file#using-local-git-directory-
+      - uses: pre-commit/[email protected]
+        id: run-pre-commit
+        with:
+          extra_args: --files ${{ steps.changed-files.outputs.all_changed_files }}
+
+        # Review dog posts the suggested change from pre-commit to the pr.
+      - name: suggester / pre-commit
+        uses: reviewdog/action-suggester@v1
+        if: ${{ failure() && steps.run-pre-commit.conclusion == 'failure' }}
+        with:
+          tool_name: pre-commit
+          level: warning
+          reviewdog_flags: "-fail-level=error"

.gitmodules

@@ -1 +0,0 @@
-

.pre-commit-config.yaml

@@ -0,0 +1,40 @@
+# See https://pre-commit.com for more information
+# See https://pre-commit.com/hooks.html for more hooks
+repos:
+  - repo: https://github.com/pre-commit/pre-commit-hooks
+    rev: v5.0.0
+    hooks:
+      - id: trailing-whitespace
+      - id: end-of-file-fixer
+      - id: check-yaml
+      - id: check-added-large-files
+
+    # Clang-format for C++
+    # This brings in a portable version of clang-format.
+    # See also: https://github.com/ssciwr/clang-format-wheel
+  - repo: https://github.com/pre-commit/mirrors-clang-format
+    rev: v19.1.4
+    hooks:
+      - id: clang-format
+        types_or: [c++, c]
+
+    # CMake linting and formatting
+  - repo: https://github.com/BlankSpruce/gersemi
+    rev: 0.17.1
+    hooks:
+      - id: gersemi
+        name: CMake linting
+
+    # Markdown linting
+    # Config file: .markdownlint.yaml
+  - repo: https://github.com/igorshubovych/markdownlint-cli
+    rev: v0.43.0
+    hooks:
+      - id: markdownlint
+
+  - repo: https://github.com/codespell-project/codespell
+    rev: v2.3.0
+    hooks:
+      - id: codespell
+        files: ^.*\.(cmake|cpp|hpp|txt|md|json|in|yaml|yml)$
+        args: ["--ignore-words", ".codespellignore" ]

CMakeLists.txt

@@ -5,10 +5,7 @@
 
 cmake_minimum_required(VERSION 3.27...3.31)
 
-project(
-  beman.iterator_interface
-  VERSION 0.0.0
-  LANGUAGES CXX)
+project(beman.iterator_interface VERSION 0.0.0 LANGUAGES CXX)
 
 # Local helpers: required to include CompilerFeatureTest.
 list(APPEND CMAKE_MODULE_PATH "${CMAKE_CURRENT_LIST_DIR}/cmake")
@@ -24,76 +21,83 @@ beman_iterator_check_deducing_this(COMPILER_SUPPORTS_DEDUCING_THIS)
 set(TARGETS_EXPORT_NAME ${CMAKE_PROJECT_NAME}Targets)
 
 option(
-  BEMAN_ITERATOR_INTERFACE_USE_DEDUCING_THIS
-  "Make use of C++23 \"deducing this\" feature (P0847R7). Turn this off for non-conforming compilers."
-  ${COMPILER_SUPPORTS_DEDUCING_THIS})
+    BEMAN_ITERATOR_INTERFACE_USE_DEDUCING_THIS
+    "Make use of C++23 \"deducing this\" feature (P0847R7). Turn this off for non-conforming compilers."
+    ${COMPILER_SUPPORTS_DEDUCING_THIS}
+)
 
 option(
-  BEMAN_ITERATOR_INTERFACE_BUILD_TESTS
-  "Enable building tests and test infrastructure. Default: ON. Values: {ON, OFF}."
-  ${PROJECT_IS_TOP_LEVEL})
-
-option(BEMAN_ITERATOR_INTERFACE_BUILD_EXAMPLES
-       "Enable building examples. Default: ON. Values: {ON, OFF}."
-       ${PROJECT_IS_TOP_LEVEL})
-
-if(BEMAN_ITERATOR_INTERFACE_USE_DEDUCING_THIS
-   AND NOT COMPILER_SUPPORTS_DEDUCING_THIS)
-  message(
-    WARNING
-      "Building with  C++23 \"deducing this\" feature (P0847R7) despite of the compiler's lack of actual support for it."
-  )
+    BEMAN_ITERATOR_INTERFACE_BUILD_TESTS
+    "Enable building tests and test infrastructure. Default: ON. Values: {ON, OFF}."
+    ${PROJECT_IS_TOP_LEVEL}
+)
+
+option(
+    BEMAN_ITERATOR_INTERFACE_BUILD_EXAMPLES
+    "Enable building examples. Default: ON. Values: {ON, OFF}."
+    ${PROJECT_IS_TOP_LEVEL}
+)
+
+if(
+    BEMAN_ITERATOR_INTERFACE_USE_DEDUCING_THIS
+    AND NOT COMPILER_SUPPORTS_DEDUCING_THIS
+)
+    message(
+        WARNING
+        "Building with  C++23 \"deducing this\" feature (P0847R7) despite of the compiler's lack of actual support for it."
+    )
 endif()
 
 configure_file(
-  "${PROJECT_SOURCE_DIR}/include/beman/iterator_interface/config.hpp.in"
-  "${PROJECT_BINARY_DIR}/include/beman/iterator_interface/config.hpp" @ONLY)
+    "${PROJECT_SOURCE_DIR}/include/beman/iterator_interface/config.hpp.in"
+    "${PROJECT_BINARY_DIR}/include/beman/iterator_interface/config.hpp"
+    @ONLY
+)
 
 if(BEMAN_ITERATOR_INTERFACE_BUILD_TESTS)
-  # Fetch GoogleTest
-  FetchContent_Declare(
-    googletest
-    EXCLUDE_FROM_ALL
-    GIT_REPOSITORY https://github.com/google/googletest.git
-    GIT_TAG e39786088138f2749d64e9e90e0f9902daa77c40 # release-1.15.0
-  )
-  FetchContent_MakeAvailable(googletest)
+    # Fetch GoogleTest
+    FetchContent_Declare(
+        googletest
+        EXCLUDE_FROM_ALL
+        GIT_REPOSITORY https://github.com/google/googletest.git
+        GIT_TAG
+            e39786088138f2749d64e9e90e0f9902daa77c40 # release-1.15.0
+    )
+    FetchContent_MakeAvailable(googletest)
 endif()
 
 # Create the library target and named header set for beman.iterator_interface
 add_library(beman.iterator_interface STATIC)
 add_library(beman::iterator_interface ALIAS beman.iterator_interface)
 
 target_sources(
-  beman.iterator_interface
-  PUBLIC FILE_SET
-         beman_iterator_interface_headers
-         TYPE
-         HEADERS
-         BASE_DIRS
-         ${PROJECT_BINARY_DIR}/include
-         ${PROJECT_SOURCE_DIR}/include
-         FILES
-         ${PROJECT_BINARY_DIR}/include/beman/iterator_interface/config.hpp)
+    beman.iterator_interface
+    PUBLIC
+        FILE_SET beman_iterator_interface_headers
+        TYPE HEADERS
+        BASE_DIRS ${PROJECT_BINARY_DIR}/include ${PROJECT_SOURCE_DIR}/include
+        FILES ${PROJECT_BINARY_DIR}/include/beman/iterator_interface/config.hpp
+)
 
 add_subdirectory(src/beman/iterator_interface)
 add_subdirectory(include/beman/iterator_interface)
 
 if(BEMAN_ITERATOR_INTERFACE_BUILD_TESTS)
-  enable_testing()
-  add_subdirectory(tests/beman/iterator_interface)
+    enable_testing()
+    add_subdirectory(tests/beman/iterator_interface)
 endif()
 
 if(BEMAN_ITERATOR_INTERFACE_BUILD_EXAMPLES)
-  add_subdirectory(examples)
+    add_subdirectory(examples)
 endif()
 
 # Coverage
 configure_file("cmake/gcovr.cfg.in" gcovr.cfg @ONLY)
 
 add_custom_target(
-  process_coverage
-  WORKING_DIRECTORY ${CMAKE_BINARY_DIR}
-  COMMENT "Running gcovr to process coverage results"
-  COMMAND mkdir -p coverage
-  COMMAND gcovr --config gcovr.cfg .)
+    process_coverage
+    WORKING_DIRECTORY ${CMAKE_BINARY_DIR}
+    COMMENT "Running gcovr to process coverage results"
+    COMMAND mkdir -p coverage
+    COMMAND gcovr --config gcovr.cfg .
+)