feat: add pre-commit-hooks

Author: not-matthias

.github/workflows/ci.yml

@@ -7,9 +7,17 @@ on:
   workflow_dispatch:
 
 jobs:
+  lint:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+      - uses: pre-commit/[email protected]
+        with:
+          extra_args: --all-files
+
   tests:
     runs-on: ubuntu-latest
-    steps: 
+    steps:
       - name: Checkout code
         uses: actions/checkout@v3
 
@@ -29,7 +37,7 @@ jobs:
           make -j
 
       - name: Run tests
-        run: | 
+        run: |
           cd core/build-tests
           GTEST_OUTPUT=json:test-results/ ctest
 
@@ -104,7 +112,7 @@ jobs:
       - name: Build and run benchmarks
         run: |
           bazel build //examples/google_benchmark_bazel:my_benchmark --//core:codspeed_mode=${{ matrix.codspeed-mode }}
-  
+
       - name: Run the benchmarks
         uses: CodSpeedHQ/action@main
         if: matrix.codspeed-mode != 'off'

.pre-commit-config.yaml

@@ -0,0 +1,17 @@
+# See https://pre-commit.com for more information
+# See https://pre-commit.com/hooks.html for more hooks
+exclude: '^(google_benchmark/.*|core/instrument-hooks/.*|.*/build/.*|build/.*|core/include/valgrind\.h|core/include/callgrind\.h)'
+files: ^(core|examples)/.*$
+
+repos:
+  - repo: https://github.com/pre-commit/pre-commit-hooks
+    rev: v4.5.0
+    hooks:
+      - id: trailing-whitespace
+      - id: end-of-file-fixer
+      - id: check-added-large-files
+  - repo: https://github.com/cpp-linter/cpp-linter-hooks
+    rev: v0.6.1
+    hooks:
+      - id: clang-format
+        files: \.(cpp|cc|cxx|h|hpp)$

core/src/utils.h

@@ -10,4 +10,4 @@ std::string safe_getenv(const char* var_name);
 
 }  // namespace codspeed
 
-#endif  // CODSPEED_UTILS_H
+#endif  // CODSPEED_UTILS_H

examples/google_benchmark_cmake/fixture_bench.hpp

@@ -33,8 +33,8 @@ BENCHMARK_TEMPLATE_F(MyTemplatedFixture, IntTest, int)(benchmark::State &st) {
   for (auto _ : st) {
   }
 }
-BENCHMARK_TEMPLATE_DEFINE_F(MyTemplatedFixture, DoubleTest,
-                            double)(benchmark::State &st) {
+BENCHMARK_TEMPLATE_DEFINE_F(MyTemplatedFixture, DoubleTest, double)
+(benchmark::State &st) {
   for (auto _ : st) {
   }
 }
@@ -56,8 +56,8 @@ BENCHMARK_REGISTER_F(MyTemplate1, TestA);
 
 template <typename T, typename U>
 class MyTemplate2 : public benchmark::Fixture {};
-BENCHMARK_TEMPLATE2_DEFINE_F(MyTemplate2, TestB, int,
-                             double)(benchmark::State &st) {
+BENCHMARK_TEMPLATE2_DEFINE_F(MyTemplate2, TestB, int, double)
+(benchmark::State &st) {
   for (auto _ : st) {
   }
 }

examples/google_benchmark_cmake/template_bench.hpp

@@ -2,24 +2,27 @@
 #define TEMPLATE_BENCH_HPP
 
 #include <benchmark/benchmark.h>
+
 #include <cstring>
 #include <string>
 
 namespace test {
-template <class T> void BM_Template(benchmark::State &state) {
+template <class T>
+void BM_Template(benchmark::State &state) {
   std::vector<T> v;
   for (auto _ : state) {
     v.push_back(T());
   }
 }
 BENCHMARK_TEMPLATE(BM_Template, int);
 BENCHMARK_TEMPLATE(BM_Template, std::string);
-} // namespace test
+}  // namespace test
 
 //
 //
 
-template <typename T> void BM_Template1(benchmark::State &state) {
+template <typename T>
+void BM_Template1(benchmark::State &state) {
   T val = T();
   for (auto _ : state) {
     benchmark::DoNotOptimize(val++);
@@ -30,7 +33,8 @@ BENCHMARK_TEMPLATE1(BM_Template1, int);
 //
 //
 
-template <typename T, typename U> void BM_Template2(benchmark::State &state) {
+template <typename T, typename U>
+void BM_Template2(benchmark::State &state) {
   T t = T();
   U u = U();
   for (auto _ : state) {