Merge pull request #266 from chillenzer/add-pre-commit

Add pre commit

.clang-format

@@ -1,9 +1,7 @@
----
 # General options
 Language: Cpp
 Standard: c++20
 DisableFormat: false
-
 AccessModifierOffset: -4
 AlignAfterOpenBracket: AlwaysBreak
 AlignConsecutiveAssignments: false
@@ -35,7 +33,7 @@ BreakConstructorInitializers: BeforeComma
 BreakInheritanceList: BeforeComma
 BreakStringLiterals: true
 ColumnLimit: 119
-CommentPragmas:  '^ COMMENT pragma:'
+CommentPragmas: "^ COMMENT pragma:"
 CompactNamespaces: false
 ConstructorInitializerAllOnOneLineOrOnePerLine: true
 ConstructorInitializerIndentWidth: 4
@@ -46,8 +44,8 @@ DerivePointerAlignment: false
 ExperimentalAutoDetectBinPacking: false
 FixNamespaceComments: true
 IncludeBlocks: Regroup
-IncludeIsMainRegex: '(Test)?$'
-IncludeIsMainSourceRegex: ''
+IncludeIsMainRegex: "(Test)?$"
+IncludeIsMainSourceRegex: ""
 IndentCaseBlocks: true
 IndentCaseLabels: false
 IndentExternBlock: AfterExternBlock
@@ -56,8 +54,8 @@ IndentPPDirectives: AfterHash
 IndentWidth: 4
 IndentWrappedFunctionNames: false
 KeepEmptyLinesAtTheStartOfBlocks: false
-MacroBlockBegin: ''
-MacroBlockEnd:   ''
+MacroBlockBegin: ""
+MacroBlockEnd: ""
 MaxEmptyLinesToKeep: 2
 NamespaceIndentation: All
 PenaltyBreakAssignment: 2
@@ -84,7 +82,7 @@ SpaceBeforeRangeBasedForLoopColon: true
 SpaceInEmptyBlock: false
 SpaceInEmptyParentheses: false
 SpacesBeforeTrailingComments: 1
-SpacesInAngles:  false
+SpacesInAngles: false
 SpacesInConditionalStatement: false
 SpacesInContainerLiterals: false
 SpacesInCStyleCastParentheses: false
@@ -94,7 +92,6 @@ SpaceBeforeSquareBrackets: false
 TabWidth: 4
 UseCRLF: false
 UseTab: Never
-
 # Project specific options -- uncomment and modify as needed
 #IncludeCategories:
 #  - Regex:           '^"(llvm|llvm-c|clang|clang-c)/'
@@ -110,5 +107,3 @@ UseTab: Never
 # Future options - not supported in clang-format 11
 # BitFieldColonSpacing: Both
 # OperandAlignmentStyle: Align
-
-...

.clang-tidy

@@ -1,3 +1,2 @@
----
-Checks:            '*,-llvm-header-guard,-fuchsia-default-arguments-declarations,-cppcoreguidelines-no-malloc,-cppcoreguidelines-owning-memory,-misc-non-private-member-variables-in-classes'
-HeaderFilterRegex: '.*'
+Checks: "*, -llvm-header-guard, -fuchsia-default-arguments-declarations, -cppcoreguidelines-no-malloc, -cppcoreguidelines-owning-memory, -misc-non-private-member-variables-in-classes"
+HeaderFilterRegex: ".*"

.github/workflows/ci.yml

@@ -1,11 +1,16 @@
-name: Continuous Integration
-on: [push, pull_request]
+name: Pre-commit
+on:
+  pull_request:
+  push:
+    branches: [main, test-me-*]
 jobs:
-  clang-format:
+  main:
     runs-on: ubuntu-latest
     steps:
-      - uses: actions/checkout@v4
-      - uses: DoozyX/[email protected]
+      - uses: actions/checkout@v3
+      - uses: actions/setup-python@v4
         with:
-          exclude: "./thirdParty ./alpaka"
-          clangFormatVersion: 18
+          python-version: 3.x
+      - uses: pre-commit/[email protected]
+      - uses: pre-commit-ci/[email protected]
+        if: always()

.pre-commit-config.yaml

@@ -0,0 +1,45 @@
+minimum_pre_commit_version: 3.2.0 # necessitated by Lucas-C's hooks
+default_install_hook_types: [pre-commit, pre-push]
+exclude: |
+  (?x)^(
+      alpaka/.*|
+      thirdParty/.*
+  )$
+repos:
+  - repo: https://github.com/pre-commit/mirrors-clang-format
+    rev: v18.1.8
+    hooks:
+      - id: clang-format
+        files: \.(cpp|hpp)
+  - repo: https://github.com/pre-commit/pre-commit-hooks
+    rev: v4.5.0
+    hooks:
+      - id: no-commit-to-branch
+        args: [-b, dev]
+      - id: check-merge-conflict
+      - id: trailing-whitespace
+      - id: end-of-file-fixer
+      - id: check-toml
+      - id: check-yaml
+        args: ["--allow-multiple-documents"]
+      - id: mixed-line-ending
+      - id: check-executables-have-shebangs
+      - id: check-shebang-scripts-are-executable
+  - repo: https://github.com/Lucas-C/pre-commit-hooks
+    rev: v1.5.4
+    hooks:
+      - id: forbid-tabs
+      - id: remove-tabs
+      - id: forbid-crlf
+      - id: remove-crlf
+  - repo: meta
+    hooks:
+      - id: check-useless-excludes
+  - repo: https://github.com/google/yamlfmt
+    rev: v0.13.0
+    hooks:
+      - id: yamlfmt
+  - repo: https://github.com/adrienverge/yamllint
+    rev: v1.35.1
+    hooks:
+      - id: yamllint

.yamllint

@@ -0,0 +1,6 @@
+extends: default
+rules:
+  document-start: disable
+  truthy: disable
+  comments: disable
+  line-length: disable

.zenodo.json

@@ -49,4 +49,3 @@
     }
   ]
 }
-

CHANGELOG.md

@@ -6,7 +6,7 @@ Change Log / Release Log for mallocMC
 **Date:** 2021-02-18
 
 This release removes the native usage of CUDA by alpaka.
-Attention: This release depends on an unreleased [alpaka 0.5.0dev](https://github.com/alpaka-group/alpaka/commit/34870a73ecf702069465aa030fbdf301c4d22c61) 
+Attention: This release depends on an unreleased [alpaka 0.5.0dev](https://github.com/alpaka-group/alpaka/commit/34870a73ecf702069465aa030fbdf301c4d22c61)
 version before the heavy alpaka namespace refactoring.
 
 ### Changes to mallocMC 2.4.0crp
@@ -41,7 +41,7 @@ This release removes the Boost dependency and switched to C++11.
 
 **Bug fixes**
   - Choose the value for the -arch nvcc flag depending on CUDA version #164 #165
- 
+
 **Misc:**
   - Travis CI: GCC 5.5.0 + CUDA 9.1.85 #170
   - Adding headers to projects and applied clang-tidy #171

tests/verify_heap.cpp

@@ -97,7 +97,7 @@ auto main(int argc, char** argv) -> int
     {
         if(correct)
         {
-            std::cout << "\033[0;32mverification successful ✔\033[0m\n";
+            std::cout << "\033[0;32mverification successful \033[0m\n";
             return 0;
         }
         else