Add pre-commit config with linting for C++ and Python (#121)

* Add pre-commit config with linting for C++ and python

* Some ruff fixes

* [pre-commit.ci] auto fixes from pre-commit.com hooks

for more information, see https://pre-commit.ci

---------

Co-authored-by: pre-commit-ci[bot] <66853113+pre-commit-ci[bot]@users.noreply.github.com>

Author: ianthomas23

.clang-format

@@ -0,0 +1,89 @@
+# From https://github.com/man-group/sparrow with sparrow-specific regexes removed.
+
+BasedOnStyle: Mozilla
+
+AccessModifierOffset: '-4'
+AlignAfterOpenBracket: BlockIndent
+AlignEscapedNewlines: Left
+AllowAllArgumentsOnNextLine: false
+AllowAllParametersOfDeclarationOnNextLine: false
+AllowShortBlocksOnASingleLine: false
+AllowShortCaseLabelsOnASingleLine: false
+AllowShortFunctionsOnASingleLine: false
+AllowShortIfStatementsOnASingleLine: false
+# Forbid one line lambdas because clang-format makes a weird split when
+# single instructions lambdas are too long.
+AllowShortLambdasOnASingleLine: Empty
+AllowShortLoopsOnASingleLine: false
+AlwaysBreakAfterDefinitionReturnType: None
+AlwaysBreakAfterReturnType: None
+AlwaysBreakTemplateDeclarations: Yes
+BinPackArguments: false
+BinPackParameters: false
+BreakBeforeBinaryOperators: NonAssignment
+BreakBeforeBraces: Allman
+BreakBeforeTernaryOperators: true
+BreakConstructorInitializers: BeforeComma
+BreakInheritanceList: AfterComma
+BreakStringLiterals: false
+ColumnLimit: '110'
+ConstructorInitializerIndentWidth: '4'
+ContinuationIndentWidth: '4'
+Cpp11BracedListStyle: true
+DerivePointerAlignment: false
+DisableFormat: false
+EmptyLineAfterAccessModifier: Always
+EmptyLineBeforeAccessModifier: Always
+ExperimentalAutoDetectBinPacking: true
+IncludeBlocks: Regroup
+IncludeCategories:
+- Regex: <[^.]+>
+  Priority: 1
+- Regex: <.+>
+  Priority: 2
+- Regex: '".+"'
+  Priority: 5
+IndentCaseLabels: true
+IndentPPDirectives: AfterHash
+IndentWidth: '4'
+IndentWrappedFunctionNames: false
+InsertBraces: true
+InsertTrailingCommas: Wrapped
+KeepEmptyLinesAtTheStartOfBlocks: false
+LambdaBodyIndentation: Signature
+Language: Cpp
+MaxEmptyLinesToKeep: '2'
+NamespaceIndentation: All
+ObjCBlockIndentWidth: '4'
+ObjCSpaceAfterProperty: false
+ObjCSpaceBeforeProtocolList: false
+PackConstructorInitializers: Never
+PenaltyBreakAssignment: 100000
+PenaltyBreakBeforeFirstCallParameter: 0
+PenaltyBreakComment: 10
+PenaltyBreakOpenParenthesis: 0
+PenaltyBreakTemplateDeclaration: 0
+PenaltyExcessCharacter: 10
+PenaltyIndentedWhitespace: 0
+PenaltyReturnTypeOnItsOwnLine: 10
+PointerAlignment: Left
+QualifierAlignment: Custom  # Experimental
+QualifierOrder: [inline, static, constexpr, const, volatile, type]
+ReflowComments: true
+SeparateDefinitionBlocks: Always
+SortIncludes: CaseInsensitive
+SortUsingDeclarations: true
+SpaceAfterCStyleCast: true
+SpaceAfterTemplateKeyword: true
+SpaceBeforeAssignmentOperators: true
+SpaceBeforeParens: ControlStatements
+SpaceInEmptyParentheses: false
+SpacesBeforeTrailingComments: '2'
+SpacesInAngles: false
+SpacesInCStyleCastParentheses: false
+SpacesInContainerLiterals: false
+SpacesInParentheses: false
+SpacesInSquareBrackets: false
+Standard: c++20
+TabWidth: '4'
+UseTab: Never

.pre-commit-config.yaml

@@ -0,0 +1,31 @@
+repos:
+  - repo: https://github.com/pre-commit/pre-commit-hooks
+    rev: v6.0.0
+    hooks:
+      - id: check-merge-conflict
+      - id: check-toml
+      - id: check-yaml
+      - id: debug-statements
+      - id: end-of-file-fixer
+      - id: mixed-line-ending
+      - id: trailing-whitespace
+
+  - repo: https://github.com/asottile/pyupgrade
+    rev: v3.21.2
+    hooks:
+      - id: pyupgrade
+        args: ['--py312-plus']
+
+  - repo: https://github.com/pre-commit/mirrors-clang-format
+    rev: v21.1.2
+    hooks:
+      - id: clang-format
+        args: [--style=file]
+        exclude_types: [javascript,json]
+
+  - repo: https://github.com/astral-sh/ruff-pre-commit
+    rev: v0.14.0
+    hooks:
+      - id: ruff-check
+        args: [--fix]
+      - id: ruff-format

README.md

@@ -29,6 +29,12 @@ The CLI is tested using `python`. From the top-level directory:
 pytest -v
 ```
 
+`pre-commit` runs automatically on `git commit`. To run it manually use:
+
+```bash
+pre-commit run --all-files
+```
+
 # WebAssembly build and deployment
 
 The `wasm` directory contains everything needed to build the local `git2cpp` source code as an

dev-environment.yml

@@ -6,6 +6,7 @@ dependencies:
   - libgit2
   - cmake
   - pkg-config
+  - pre-commit
   - python
   - pytest
   - termcolor-cpp

docs/create_markdown.py

@@ -26,7 +26,7 @@ def sanitise_line(line):
     return line
 
 
-# Process a single subcommand, adding new subcommands found to to_process.
+# Process a single subcommand, adding new subcommands found to to_process.
 def process(args, to_process):
     cmd = args + ["--help"]
     cmd_string = " ".join(cmd)
@@ -37,7 +37,7 @@ def process(args, to_process):
     p = subprocess.run(cmd, capture_output=True, text=True, check=True)
 
     # Write output markdown file, identifying subcommands at the same time to provide
-    # links to the subcommand markdown files.
+    # links to the subcommand markdown files.
     subcommands = []
     with open(filename, "w") as f:
         f.write(f"({filename})=\n")  # Target for links.
@@ -52,7 +52,9 @@ def process(args, to_process):
                 if match:
                     subcommand = match.group(2)
                     subcommand_filename = get_filename(args + [subcommand])
-                    line = match.group(1) + f"[{subcommand}]({subcommand_filename})" + match.group(3)
+                    line = (
+                        match.group(1) + f"[{subcommand}]({subcommand_filename})" + match.group(3)
+                    )
                     subcommands.append(subcommand)
             elif line.startswith("SUBCOMMANDS:"):
                 in_subcommand_section = True
@@ -74,10 +76,10 @@ def process(args, to_process):
 
 
 if __name__ == "__main__":
-    # Modify the PATH so that git2cpp is found by name, as using a full path will cause the help
+    # Modify the PATH so that git2cpp is found by name, as using a full path will cause the help
     # pages to write that full path.
-    git2cpp_dir = Path(__file__).parent.parent / 'build'
-    os.environ["PATH"] = f'{git2cpp_dir}{os.pathsep}{os.environ["PATH"]}'
+    git2cpp_dir = Path(__file__).parent.parent / "build"
+    os.environ["PATH"] = f"{git2cpp_dir}{os.pathsep}{os.environ['PATH']}"
 
     to_process = [["git2cpp"]]
     while len(to_process) > 0:

pyproject.toml

@@ -0,0 +1,6 @@
+# This is not a python project but it contains python tests so here are settings for python linting.
+[tool.ruff]
+line-length = 100
+target-version = "py312"
+[tool.ruff.format]
+line-ending = "lf"

src/main.cpp

@@ -1,10 +1,9 @@
-#include <CLI/CLI.hpp>
 #include <cmath>
-#include <git2.h>  // For version number only
 #include <iostream>
 
-#include "utils/git_exception.hpp"
-#include "version.hpp"
+#include <CLI/CLI.hpp>
+#include <git2.h>  // For version number only
+
 #include "subcommand/add_subcommand.hpp"
 #include "subcommand/branch_subcommand.hpp"
 #include "subcommand/checkout_subcommand.hpp"
@@ -21,12 +20,14 @@
 #include "subcommand/rebase_subcommand.hpp"
 #include "subcommand/remote_subcommand.hpp"
 #include "subcommand/reset_subcommand.hpp"
+#include "subcommand/revlist_subcommand.hpp"
+#include "subcommand/revparse_subcommand.hpp"
+#include "subcommand/rm_subcommand.hpp"
 #include "subcommand/stash_subcommand.hpp"
 #include "subcommand/status_subcommand.hpp"
 #include "subcommand/tag_subcommand.hpp"
-#include "subcommand/revparse_subcommand.hpp"
-#include "subcommand/revlist_subcommand.hpp"
-#include "subcommand/rm_subcommand.hpp"
+#include "utils/git_exception.hpp"
+#include "version.hpp"
 
 int main(int argc, char** argv)
 {
@@ -69,7 +70,8 @@ int main(int argc, char** argv)
 
         if (version->count())
         {
-            std::cout << "git2cpp version " << GIT2CPP_VERSION_STRING << " (libgit2 " << LIBGIT2_VERSION << ")" << std::endl;
+            std::cout << "git2cpp version " << GIT2CPP_VERSION_STRING << " (libgit2 " << LIBGIT2_VERSION
+                      << ")" << std::endl;
         }
         else if (app.get_subcommands().size() == 0)
         {
@@ -86,7 +88,8 @@ int main(int argc, char** argv)
         std::cerr << e.what() << std::endl;
         exit_code = e.error_code();
     }
-    catch (std::exception& e) {
+    catch (std::exception& e)
+    {
         std::cerr << e.what() << std::endl;
         exit_code = 1;
     }

src/subcommand/add_subcommand.cpp

@@ -1,13 +1,13 @@
+#include "add_subcommand.hpp"
+
 #include <git2.h>
 
-#include "add_subcommand.hpp"
 #include "../wrapper/index_wrapper.hpp"
 #include "../wrapper/repository_wrapper.hpp"
 
-
 add_subcommand::add_subcommand(const libgit2_object&, CLI::App& app)
 {
-    auto *sub = app.add_subcommand("add", "Add file contents to the index");
+    auto* sub = app.add_subcommand("add", "Add file contents to the index");
 
     sub->add_option("<files>", m_add_files, "Files to add");
 
@@ -16,10 +16,14 @@ add_subcommand::add_subcommand(const libgit2_object&, CLI::App& app)
     // sub->add_flag("-u,--update", update_flag, "");
     // sub->add_flag("-v,--verbose", verbose_flag, "");
 
-    sub->callback([this]() { this->run(); });
+    sub->callback(
+        [this]()
+        {
+            this->run();
+        }
+    );
 };
 
-
 void add_subcommand::run()
 {
     auto directory = get_current_git_path();

src/subcommand/add_subcommand.hpp

@@ -12,6 +12,7 @@ class add_subcommand
     void run();
 
 private:
+
     bool m_all_flag = false;
     std::vector<std::string> m_add_files;
 };

src/subcommand/branch_subcommand.cpp

@@ -1,6 +1,7 @@
+#include "../subcommand/branch_subcommand.hpp"
+
 #include <iostream>
 
-#include "../subcommand/branch_subcommand.hpp"
 #include "../wrapper/repository_wrapper.hpp"
 
 branch_subcommand::branch_subcommand(const libgit2_object&, CLI::App& app)
@@ -14,9 +15,18 @@ branch_subcommand::branch_subcommand(const libgit2_object&, CLI::App& app)
     sub->add_flag("-r,--remotes", m_remote_flag, "List or delete (if used with -d) the remote-tracking branches");
     sub->add_flag("-l,--list", m_list_flag, "List branches");
     sub->add_flag("-f,--force", m_force_flag, "Skips confirmation");
-    sub->add_flag("--show-current", m_show_current_flag, "Print the name of the current branch. In detached HEAD state, nothing is printed.");
+    sub->add_flag(
+        "--show-current",
+        m_show_current_flag,
+        "Print the name of the current branch. In detached HEAD state, nothing is printed."
+    );
 
-    sub->callback([this]() { this->run(); });
+    sub->callback(
+        [this]()
+        {
+            this->run();
+        }
+    );
 }
 
 void branch_subcommand::run()