added the exe param to formatting script, formatted workflow files

Author: SpectraL519

.github/workflows/clang.yaml

@@ -2,7 +2,7 @@ name: Clang
 on:
   push:
     branches:
-      - '*'
+      - "*"
     paths:
       - .github/workflows/clang.yaml
       - include/**
@@ -23,7 +23,7 @@ jobs:
 
       - name: Prepare
         env:
-          CC:  clang-17
+          CC: clang-17
           CXX: clang++-17
         run: |
           cmake -B build_clang -DBUILD_TESTS=ON -DCMAKE_CXX_COMPILER=$CXX -DCMAKE_C_COMPILER=$CC

.github/workflows/demo.yaml

@@ -2,7 +2,7 @@ name: demo
 on:
   push:
     branches:
-      - '*'
+      - "*"
     paths:
       - .github/workflows/demo.yaml
       - .gitmodules

.github/workflows/documentation.yaml

@@ -3,10 +3,10 @@ name: documentation
 on:
   pull_request:
     branches:
-      - '*'
+      - "*"
   push:
     tags:
-      - 'v*'
+      - "v*"
 
 jobs:
   build-doc:

.github/workflows/format.yaml

@@ -2,7 +2,7 @@ name: format
 on:
   push:
     branches:
-      - '*'
+      - "*"
     paths:
       - .github/workflows/format.yaml
       - scripts/format.py
@@ -31,4 +31,4 @@ jobs:
       - name: Test formatting
         shell: bash
         run: |
-          python3 scripts/format.py --check
+          python3 scripts/format.py --check -exe clang-format-18

.github/workflows/gcc.yaml

@@ -2,7 +2,7 @@ name: GCC
 on:
   push:
     branches:
-      - '*'
+      - "*"
     paths:
       - .github/workflows/gcc.yaml
       - include/**
@@ -23,7 +23,7 @@ jobs:
 
       - name: Prepare
         env:
-          CC:  gcc-13
+          CC: gcc-13
           CXX: g++-13
         run: |
           cmake -B build_gcc -DBUILD_TESTS=ON -DCMAKE_CXX_COMPILER=$CXX -DCMAKE_C_COMPILER=$CC

.github/workflows/license.yaml

@@ -2,7 +2,7 @@ name: license
 on:
   push:
     branches:
-      - '*'
+      - "*"
     paths:
       - .github/workflows/license.yaml
       - scripts/check_licence.py

.github/workflows/msvc.yaml

@@ -2,7 +2,7 @@ name: MSVC
 on:
   push:
     branches:
-      - '*'
+      - "*"
     paths:
       - .github/workflows/msvc.yaml
       - include/**

scripts/format.py

@@ -1,59 +1,66 @@
 import argparse
 import subprocess
 import sys
-from collections.abc import Iterable
 from pathlib import Path
 
 from common import find_files
 
 
 class DefaultParameters:
     modified_files: bool = False
-    search_paths: Iterable[str] = ["include", "source", "tests"]
-    file_patterns: Iterable[str] = ["*.cpp", "*.hpp", "*.c", "*.h"]
-    exclude_paths: Iterable[str] = ["tests/external"]
+    search_paths: list[str] = ["include", "tests"]
+    file_patterns: list[str] = ["*.cpp", "*.hpp", "*.c", "*.h"]
+    exclude_paths: list[str] = ["tests/external"]
     check: bool = False
+    clang_format_executable: str = "clang-format"
 
 
 def parse_args():
     parser = argparse.ArgumentParser()
     parser.add_argument(
-        "-m", "--modified-files",
-        type=bool,
+        "-m",
+        "--modified-files",
         default=DefaultParameters.modified_files,
         action=argparse.BooleanOptionalAction,
-        help="run clang-format only on the files modified since last pushed commit"
+        help="run clang-format only on the files modified since last pushed commit",
     )
     parser.add_argument(
-        "-p", "--search-paths",
+        "-p",
+        "--search-paths",
         type=str,
         default=DefaultParameters.search_paths,
         nargs="*",
-        action="extend",
-        help="list of search directory paths"
+        help="list of search directory paths",
     )
     parser.add_argument(
-        "-f", "--file-patterns",
+        "-f",
+        "--file-patterns",
         type=str,
         default=DefaultParameters.file_patterns,
         nargs="*",
-        action="extend",
-        help="list of file patterns to include"
+        help="list of file patterns to include",
     )
     parser.add_argument(
-        "-e", "--exclude-paths",
+        "-e",
+        "--exclude-paths",
         type=str,
         default=DefaultParameters.exclude_paths,
         nargs="*",
-        action="extend",
-        help="list of directory paths to exclude"
+        help="list of directory paths to exclude",
     )
     parser.add_argument(
-        "-c", "--check",
-        type=bool,
+        "-c",
+        "--check",
         default=DefaultParameters.check,
         action=argparse.BooleanOptionalAction,
-        help="run format check"
+        help="run format check",
+    )
+    parser.add_argument(
+        "-exe",
+        "--clang-format-executable",
+        type=str,
+        default=DefaultParameters.clang_format_executable,
+        help="path or name of the clang-format executable (default: clang-format)",
     )
 
     return vars(parser.parse_args())
@@ -66,7 +73,7 @@ def get_modified_files(files: set[Path]) -> set[Path]:
             check=True,
             stdout=subprocess.PIPE,
             stderr=subprocess.PIPE,
-            text=True
+            text=True,
         )
 
         modified_files = {Path(file) for file in result.stdout.splitlines() if file}
@@ -77,7 +84,7 @@ def get_modified_files(files: set[Path]) -> set[Path]:
         raise RuntimeError("Failed to retrieve the modified files.")
 
 
-def run_clang_format(files: set[Path], check: bool) -> int:
+def run_clang_format(clang_format_exec: str, files: set[Path], check: bool) -> int:
     n_files = len(files)
     if check:
         print(f"Files to check: {n_files}")
@@ -88,32 +95,35 @@ def run_clang_format(files: set[Path], check: bool) -> int:
     for i, file in enumerate(files):
         print(f"[{i + 1}/{n_files}] {file}")
 
-        cmd = ["clang-format-18", str(file)]
+        cmd = [clang_format_exec, str(file)]
         if check:
             cmd.extend(["--dry-run", "--Werror"])
         else:
             cmd.append("-i")
         result = subprocess.run(cmd, capture_output=True, text=True)
         if result.returncode != 0:
             return_code = result.returncode
-            print(f"[Format error]\n[stdout]\n{result.stdout}\n[stderr]\n{result.stderr}")
+            print(
+                f"[Format error]\n[stdout]\n{result.stdout}\n[stderr]\n{result.stderr}"
+            )
 
     print("Done!")
     return return_code
 
 
 def main(
     modified_files: bool,
-    search_paths: Iterable[str],
-    file_patterns: Iterable[str],
-    exclude_paths: Iterable[str],
-    check: bool
+    search_paths: list[str],
+    file_patterns: list[str],
+    exclude_paths: list[str],
+    check: bool,
+    clang_format_executable: str,
 ):
     files_to_format = find_files(search_paths, file_patterns, exclude_paths)
     if modified_files:
         files_to_format = get_modified_files(files_to_format)
 
-    sys.exit(run_clang_format(files_to_format, check))
+    sys.exit(run_clang_format(clang_format_executable, files_to_format, check))
 
 
 if __name__ == "__main__":