Add clang-format config and basic pre-commit workflow (#87)

* Extend .gitignore to LSP related tooling

* Add .clang-format config from k4-project-template

* Add pre-commit configuration

* [pre-commit] Pre-commit whitespace fixes

* [clang-format] Fix all clang-format issues

Co-authored-by: Valentin Volkl <[email protected]>

Author: tmadlener

.clang-format

@@ -0,0 +1,92 @@
+---
+Language:        Cpp
+AccessModifierOffset: -2
+AlignAfterOpenBracket: Align
+AlignConsecutiveAssignments: true
+AlignConsecutiveDeclarations: true
+AlignEscapedNewlinesLeft: true
+AlignOperands:   true
+AlignTrailingComments: true
+AllowAllParametersOfDeclarationOnNextLine: true
+AllowShortBlocksOnASingleLine: false
+AllowShortCaseLabelsOnASingleLine: false
+AllowShortFunctionsOnASingleLine: true
+AllowShortIfStatementsOnASingleLine: false
+AllowShortLoopsOnASingleLine: false
+AlwaysBreakAfterDefinitionReturnType: None
+AlwaysBreakAfterReturnType: None
+AlwaysBreakBeforeMultilineStrings: true
+AlwaysBreakTemplateDeclarations: false
+BinPackArguments: true
+BinPackParameters: true
+BraceWrapping:   
+  AfterClass:      false
+  AfterControlStatement: false
+  AfterEnum:       false
+  AfterFunction:   false
+  AfterNamespace:  false
+  AfterObjCDeclaration: false
+  AfterStruct:     false
+  AfterUnion:      false
+  BeforeCatch:     false
+  BeforeElse:      false
+  IndentBraces:    false
+BreakBeforeBinaryOperators: None
+BreakBeforeBraces: Attach
+BreakBeforeTernaryOperators: true
+BreakConstructorInitializersBeforeComma: false
+BreakAfterJavaFieldAnnotations: false
+BreakStringLiterals: true
+ColumnLimit:     120
+CommentPragmas:  '^ IWYU pragma:'
+ConstructorInitializerAllOnOneLineOrOnePerLine: true
+ConstructorInitializerIndentWidth: 4
+ContinuationIndentWidth: 4
+Cpp11BracedListStyle: true
+DerivePointerAlignment: false
+DisableFormat:   false
+ExperimentalAutoDetectBinPacking: false
+ForEachMacros:   [ foreach, Q_FOREACH, BOOST_FOREACH ]
+IncludeCategories: 
+  - Regex:           '^<.*\.h>'
+    Priority:        1
+  - Regex:           '^<.*'
+    Priority:        2
+  - Regex:           '.*'
+    Priority:        3
+IncludeIsMainRegex: '([-_](test|unittest))?$'
+IndentCaseLabels: true
+IndentWidth:     2
+IndentWrappedFunctionNames: false
+KeepEmptyLinesAtTheStartOfBlocks: false
+MacroBlockBegin: ''
+MacroBlockEnd:   ''
+MaxEmptyLinesToKeep: 1
+NamespaceIndentation: All
+ObjCBlockIndentWidth: 2
+ObjCSpaceAfterProperty: false
+ObjCSpaceBeforeProtocolList: false
+PenaltyBreakBeforeFirstCallParameter: 1
+PenaltyBreakComment: 300
+PenaltyBreakFirstLessLess: 120
+PenaltyBreakString: 1000
+PenaltyExcessCharacter: 1000000
+PenaltyReturnTypeOnItsOwnLine: 200
+PointerAlignment: Left
+ReflowComments:  false
+SortIncludes:    true
+SpaceAfterCStyleCast: false
+SpaceBeforeAssignmentOperators: true
+SpaceBeforeParens: ControlStatements
+SpaceInEmptyParentheses: false
+SpacesBeforeTrailingComments: 2
+SpacesInAngles:  false
+SpacesInContainerLiterals: false
+SpacesInCStyleCastParentheses: false
+SpacesInParentheses: false
+SpacesInSquareBrackets: false
+Standard:        Cpp11
+TabWidth:        4
+UseTab:          Never
+JavaScriptQuotes: Leave
+...

.github/pre-commit.yml

@@ -0,0 +1,22 @@
+name: pre-commit
+
+on: [push, pull_request]
+
+jobs:
+  pre-commit:
+    runs-on: ubuntu-latest
+    steps:
+    - uses: actions/checkout@v2
+    - uses: cvmfs-contrib/github-action-cvmfs@v2
+    - uses: aidasoft/run-lcg-view@v3
+      with:
+        release-platform: LCG_101/x86_64-centos7-clang12-opt
+        run: |
+          export PYTHONPATH=$(python -m site --user-site):$PYTHONPATH
+          export PATH=/root/.local/bin:$PATH
+          pip install --upgrade --user pip
+          pip install argparse --user
+          pip install pre-commit --user
+          pre-commit run --show-diff-on-failure \
+            --color=always \
+            --all-files

.github/scripts/clang-format-hook

@@ -0,0 +1,21 @@
+#!/usr/bin/env bash
+
+# Thin wrapper around clang-format for easier to parse output from the
+# pre-commit hook.
+#
+# Needs to work with multiple input files as pre-commit passes multiple files to
+# the "executables"
+
+# Make sure that diff is actually recent enough (diffutils >= 3.4) to support
+# colored output
+COLOR_OUTPUT=$(diff --color=always <(echo) <(echo) > /dev/null 2>&1 && echo "--color=always")
+
+success=0
+for file in ${@}; do
+    if ! $(clang-format --style=file --Werror --dry-run ${file} > /dev/null 2>&1); then
+        echo "Necessary changes for: '${file}' (run 'clang-format --style=file -i ${file}' to fix it)"
+        diff ${COLOR_OUTPUT} -u ${file} <(clang-format --style=file ${file}) | tail -n +3
+        success=1
+    fi
+done
+exit ${success}

.gitignore

@@ -57,3 +57,5 @@ CTestTestfile.cmake
 CPackSourceConfig.cmake
 CPackConfig.cmake
 cmake_install.cmake
+/compile_commands.json
+/.clangd/

.pre-commit-config.yaml

@@ -0,0 +1,14 @@
+repos:
+  - repo: https://github.com/pre-commit/pre-commit-hooks
+    rev: v3.4.0
+    hooks:
+      - id: mixed-line-ending
+      - id: trailing-whitespace
+        exclude: (doc/ReleaseNotes.md)
+  - repo: local
+    hooks:
+      - id: clang-format
+        name: clang-format
+        entry: .github/scripts/clang-format-hook
+        types: [c++]
+        language: system

README.md

@@ -13,17 +13,17 @@ k4FWCore is a Gaudi package that  provides the PodioDataService, that allows to
 Component wrapping the PodioDataService to handle PODIO types and collections.
 
 
-#### PodioInput 
+#### PodioInput
 
-Algorithm to read data from input file(s) on disk. 
+Algorithm to read data from input file(s) on disk.
 
 #### PodioOutput
 
 Algorithm to write data to output file on disk.
 
 #### FWFloatProducer
 
-Algorithm with a simple float as output, for testing and adding parameters to jobs. 
+Algorithm with a simple float as output, for testing and adding parameters to jobs.
 
 
 ## Dependencies
@@ -36,7 +36,7 @@ Algorithm with a simple float as output, for testing and adding parameters to jo
 
 ## Installation and downstream usage.
 
-k4FWCore is a cmake project. After setting up the dependencies (use for example `source /cvmfs/sw.hsf.org/key4hep/setup.sh`) 
+k4FWCore is a cmake project. After setting up the dependencies (use for example `source /cvmfs/sw.hsf.org/key4hep/setup.sh`)
 
 
 ```

k4FWCore/CMakeLists.txt

@@ -31,7 +31,7 @@ install(TARGETS k4FWCore k4FWCorePlugins
   COMPONENT dev)
 
 
-add_test(NAME WriteTest 
+add_test(NAME WriteTest
          WORKING_DIRECTORY ${PROJECT_SOURCE_DIR}
          COMMAND ${CMAKE_BINARY_DIR}/run ${PROJECT_SOURCE_DIR}/k4FWCore/scripts/k4run k4FWCore/test/options/simple_write.py)
 

k4FWCore/components/FCCDataSvc.h

@@ -6,7 +6,6 @@
 
 /// an alias to k4DataSvc for backwards compatibility
 class FCCDataSvc : public PodioDataSvc {
-
 public:
   /// Standard Constructor
   FCCDataSvc(const std::string& name, ISvcLocator* svc);

k4FWCore/components/PodioInput.cpp

@@ -11,11 +11,13 @@ DECLARE_COMPONENT(PodioInput)
 PodioInput::PodioInput(const std::string& name, ISvcLocator* svcLoc) : GaudiAlgorithm(name, svcLoc) {}
 
 StatusCode PodioInput::initialize() {
-  if (GaudiAlgorithm::initialize().isFailure()) return StatusCode::FAILURE;
+  if (GaudiAlgorithm::initialize().isFailure())
+    return StatusCode::FAILURE;
 
   // check whether we have the PodioEvtSvc active
   m_podioDataSvc = dynamic_cast<PodioDataSvc*>(evtSvc().get());
-  if (nullptr == m_podioDataSvc) return StatusCode::FAILURE;
+  if (nullptr == m_podioDataSvc)
+    return StatusCode::FAILURE;
 
   auto idTable = m_podioDataSvc->getCollectionIDs();
   for (auto& name : m_collectionNames) {
@@ -45,6 +47,7 @@ StatusCode PodioInput::execute() {
 }
 
 StatusCode PodioInput::finalize() {
-  if (GaudiAlgorithm::finalize().isFailure()) return StatusCode::FAILURE;
+  if (GaudiAlgorithm::finalize().isFailure())
+    return StatusCode::FAILURE;
   return StatusCode::SUCCESS;
 }

k4FWCore/components/PodioInput.h

@@ -11,15 +11,14 @@
 // from k4FWCore:
 class PodioDataSvc;
 
-/** @class PodioInput 
+/** @class PodioInput
  *
  *  Class that allows to read ROOT files written with PodioOutput
  *
  *  @author J. Lingemann
  */
 
 class PodioInput : public GaudiAlgorithm {
-
 public:
   /// Constructor.
   PodioInput(const std::string& name, ISvcLocator* svcLoc);