Add pre-commit support, and fix end of line and file issues (#120)

Twon · web-flow · commit 8870c58e18ae · 2024-10-25T15:54:02.000+01:00
diff --git a/.clang-format b/.clang-format
@@ -209,4 +209,3 @@ WhitespaceSensitiveMacros:
   - PP_STRINGIZE
   - STRINGIZE
 ...
-
diff --git a/.github/workflows/ci.yml b/.github/workflows/ci.yml
@@ -135,7 +135,7 @@ jobs:
         working-directory: /tmp/digests
         run: |
           docker buildx imagetools create $(jq -cr '.tags | map("-t " + .) | join(" ")' <<< "$DOCKER_METADATA_OUTPUT_JSON") \
-            $(printf '${{ env.REGISTRY_IMAGE }}-${{ env.COMPILER }}@sha256:%s ' *)          
+            $(printf '${{ env.REGISTRY_IMAGE }}-${{ env.COMPILER }}@sha256:%s ' *)
 
       - name: Inspect image
         run: |
diff --git a/.github/workflows/docs.yml b/.github/workflows/docs.yml
@@ -33,7 +33,7 @@ jobs:
       - uses: actions/checkout@v3
         with:
           submodules: 'true'
-            
+
       - name: Export docs
         continue-on-error: false
         shell: bash
@@ -43,7 +43,7 @@ jobs:
           cd .build
           cmake -DDOCS=True ..
           cmake --build . --target export_docs
-      
+
       - name: Setup Pages
         uses: actions/configure-pages@v4
 
@@ -52,7 +52,7 @@ jobs:
         with:
           path: ./.build/docs
           name: docs-develop
-      
+
       - name: Deploy to GitHub Pages
         id: deployment
         uses: actions/deploy-pages@v4
diff --git a/.gitignore b/.gitignore
@@ -6,6 +6,7 @@ result
 .clangd
 .cache/
 .devcontainer/
+.venv/
 .vscode/
 *.iws
 *.swp
diff --git a/.pre-commit-config.yaml b/.pre-commit-config.yaml
@@ -0,0 +1,31 @@
+# .pre-commit-config.yaml
+# ========================
+#
+# pre-commit clean
+# pre-commit install
+# pre-commit install-hooks
+#
+# precommit hooks installation
+#
+# - pre-commit autoupdate
+#
+# - pre-commit run black
+#
+# continuous integration
+# ======================
+#
+# - pre-commit run --all-files
+#
+# See https://pre-commit.com for more information
+# See https://pre-commit.com/hooks.html for more hooks
+repos:
+- repo: https://github.com/pre-commit/pre-commit-hooks
+  rev: v4.5.0
+  hooks:
+  - id: end-of-file-fixer
+  - id: trailing-whitespace
+- repo: https://github.com/pre-commit/mirrors-clang-format
+  rev: v18.1.8
+  hooks:
+  - id: clang-format
+    types_or: [c++, c]
diff --git a/README.md b/README.md
@@ -49,6 +49,25 @@ The maintainers are unable to guarantee that no significant refactoring will eve
 [similar-work]: https://www.doc.ic.ac.uk/~dorchard/publ/haskell14-effects.pdf
 [ripple]: https://ripple.com/
 
+## Pre-commit
+This repository supports [pre-commit](https://pre-commit.com/) to install git commit hooks which will run checks on the repository (currently just clang-format).  Pre-commit will install git commit hooks locally so that they run on each commit. To set up locally you configure a virtual environment, install the requirements and run pre-commit install.
+
+```
+# Set up a virtual environment to install pre-commit
+python3 -m venv .venv
+source ./.venv/bin/activate
+pip install pre-commit
+# Now install the pre-commit hooks locally
+pre-commit install
+```
+
+You can run the check manually as follows:
+```
+# Source the virtual environment to access pre-commit
+source ./.venv/bin/activate
+# Run pre-commit on local files.
+pre-commit run --all-files
+```
 
 ## License
 [![FOSSA Status](https://app.fossa.com/api/projects/git%2Bgithub.com%2Flibfn%2Ffunctional.svg?type=large)](https://app.fossa.com/projects/git%2Bgithub.com%2Flibfn%2Ffunctional?ref=badge_large)
diff --git a/cmake/Docs.cmake b/cmake/Docs.cmake
@@ -23,5 +23,5 @@ znai_export_docs(
   ${CMAKE_BINARY_DIR}/docs
   COMMENT "Export final documentation"
 )
-  
+
 add_dependencies(export_docs docs)
diff --git a/docs/choice.md b/docs/choice.md
@@ -12,4 +12,3 @@ title: fn::choice
 
 ## Return value {style: "api"}
 TODO
-
diff --git a/docs/choice/and_then.md b/docs/choice/and_then.md
@@ -23,6 +23,6 @@ A monadic type of the same kind.
 ## Examples {style: "api"}
 
 :include-template: templates/snippet.md {
-    path:  "examples/simple.cpp", 
+    path:  "examples/simple.cpp",
     surroundedBy: ["// example-choice-parse", "// example-choice-checks"]
 }
diff --git a/docs/choice/index.md b/docs/choice/index.md
@@ -24,5 +24,3 @@ Some text explaining this section...
 Some text explaining this section...
 
 :include-doxygen-member: fn::choice< Ts... >::value { signatureOnly: false, includeAllMatches: true }
-
-
diff --git a/docs/expected/and_then.md b/docs/expected/and_then.md
@@ -23,13 +23,13 @@ A monadic type of the same kind.
 ## Examples {style: "api"}
 
 :include-template: templates/snippet.md {
-    path:  "examples/simple.cpp", 
+    path:  "examples/simple.cpp",
     surroundedBy: ["// example-error-struct", "// example-expected-and_then-value"],
     desc:  "The resulting value is `13` because `ex` does not contain an `Error` and therefore `and_then` is called."
 }
 
 :include-template: templates/snippet.md {
-    path:  "examples/simple.cpp", 
+    path:  "examples/simple.cpp",
     surroundedBy: ["// example-error-struct", "// example-expected-and_then-error"],
     desc:  "The result is an `Error` because `ex` already contained an `Error` and therefore `and_then` is not called."
 }
diff --git a/docs/expected/fail.md b/docs/expected/fail.md
@@ -17,4 +17,3 @@ title: fn::fail
 
 ## Return value {style: "api"}
 A monadic type of the same kind.
-
diff --git a/docs/expected/filter.md b/docs/expected/filter.md
@@ -23,13 +23,13 @@ A monadic type of the same kind.
 ## Examples {style: "api"}
 
 :include-template: templates/snippet.md {
-    path:  "examples/simple.cpp", 
+    path:  "examples/simple.cpp",
     surroundedBy: ["// example-error-struct", "// example-expected-filter-value"],
     desc:  "The resulting value is `42` because the filter predicate returns `true` for `42` as it is not less than `42`."
 }
 
 :include-template: templates/snippet.md {
-    path:  "examples/simple.cpp", 
+    path:  "examples/simple.cpp",
     surroundedBy: ["// example-error-struct", "// example-expected-filter-error"],
     desc:  "The error is set to `Less than 42` because the predicate returns `false` for `12` since it's less than `42`."
 }
diff --git a/docs/expected/inspect_error.md b/docs/expected/inspect_error.md
@@ -17,4 +17,3 @@ title: fn::inspect_error
 
 ## Return value {style: "api"}
 A monadic type of the same kind.
-
diff --git a/docs/optional/and_then.md b/docs/optional/and_then.md
@@ -23,13 +23,13 @@ A monadic type of the same kind.
 ## Examples {style: "api"}
 
 :include-template: templates/snippet.md {
-    path:  "examples/simple.cpp", 
+    path:  "examples/simple.cpp",
     surroundedBy: ["// example-optional-and_then-value"],
     desc:  "The resulting value is `13` because `op` is not a `nullopt` and therefore `and_then` is called."
 }
 
 :include-template: templates/snippet.md {
-    path:  "examples/simple.cpp", 
+    path:  "examples/simple.cpp",
     surroundedBy: ["// example-optional-and_then-empty"],
     desc:  "The result is a `nullopt` because `op` was already a `nullopt` and therefore `and_then` is not called."
 }
diff --git a/docs/optional/fail.md b/docs/optional/fail.md
@@ -17,4 +17,3 @@ title: fn::fail
 
 ## Return value {style: "api"}
 A monadic type of the same kind.
-
diff --git a/docs/optional/filter.md b/docs/optional/filter.md
@@ -23,13 +23,13 @@ A monadic type of the same kind.
 ## Examples {style: "api"}
 
 :include-template: templates/snippet.md {
-    path:  "examples/simple.cpp", 
+    path:  "examples/simple.cpp",
     surroundedBy: ["// example-optional-filter-value"],
     desc:  "The resulting value is `42` because the filter predicate returns `true` for `42` as it is not less than `42`."
 }
 
 :include-template: templates/snippet.md {
-    path:  "examples/simple.cpp", 
+    path:  "examples/simple.cpp",
     surroundedBy: ["// example-optional-filter-empty"],
     desc:  "The optional is empty because the predicate returns `false` for `12` since it's less than `42`."
 }
diff --git a/docs/optional/inspect_error.md b/docs/optional/inspect_error.md
@@ -17,4 +17,3 @@ title: fn::inspect_error
 
 ## Return value {style: "api"}
 A monadic type of the same kind.
-
diff --git a/docs/pack.md b/docs/pack.md
@@ -9,7 +9,7 @@ title: fn::pack
 <!--
 For some reason `fn::pack` does not work here and produces the following error:
 ```
-Exception in thread "main" java.lang.RuntimeException: 
+Exception in thread "main" java.lang.RuntimeException:
 markup parsing error:
     TOC item: reference-manual/pack
     full path: /Users/godexsoft/Development/functional/docs/reference-manual/pack.md
@@ -71,7 +71,7 @@ Caused by: java.lang.IllegalArgumentException: expected to find element <declnam
         ... 18 more
 ```
 
-Interestingly using fn::detail::pack_impl does not produce the same error. 
+Interestingly using fn::detail::pack_impl does not produce the same error.
 And similarly looking code in choice.md and sum.md also appears to work fine.
 -->
 :include-doxygen-doc: fn::detail::pack_impl
@@ -80,4 +80,3 @@ And similarly looking code in choice.md and sum.md also appears to work fine.
 
 ## Return value {style: "api"}
 TODO
-
diff --git a/docs/sum.md b/docs/sum.md
@@ -12,4 +12,3 @@ title: fn::sum
 
 ## Return value {style: "api"}
 TODO
-
diff --git a/docs/toc b/docs/toc
@@ -28,4 +28,4 @@ pack
     index
 sum
     index
-    
+
diff --git a/nix/README.md b/nix/README.md
@@ -6,8 +6,8 @@ First you will need to install Nix from [https://nixos.org/download](https://nix
 It's as simple as running a command in your terminal.
 
 ## Usage
-> [!NOTE]  
-> First build will trigger multiple downloads. 
+> [!NOTE]
+> First build will trigger multiple downloads.
 
 Software immediately available in the build environment:
 - Compiler (clang or gcc)
@@ -25,7 +25,7 @@ The default compiler is gcc.
 Create a build environment:
 ```bash
 $ nix develop .
-``` 
+```
 
 Or just build and run the tests:
 ```bash
@@ -42,13 +42,13 @@ $ nix develop .#clang
 ```
 
 ### VSCode
-> [!NOTE]  
+> [!NOTE]
 > The executable `code` is assumed to be available in your `$PATH`.
 > on Mac it's in `/Applications/Visual Studio Code.app/Contents/Resources/app/bin`
 
 Once you are in a build environment it's possible to use VSCode directly by running it from that environment:
 ```bash
-$ git clone git@github.com:libfn/functional.git 
+$ git clone git@github.com:libfn/functional.git
 $ cd functional && nix develop .
 bash-5.2$ code .
 ```
diff --git a/nix/package.nix b/nix/package.nix
@@ -8,7 +8,7 @@
 , enableTests ? true
 }:
 
-let 
+let
   catch2_local = pkgs.callPackage ./catch2_3.nix { inherit stdenv; };
 in
 stdenv.mkDerivation {
diff --git a/tests/examples/simple.cpp b/tests/examples/simple.cpp
@@ -72,9 +72,9 @@ TEST_CASE("Minimal expected", "[expected][and_then]")
     // example-expected-and_then-value
     fn::expected<double, Error> ex{12.1};
 
-    auto rounded = ex 
-      | fn::and_then([](auto&& v) -> fn::expected<unsigned, Error> { 
-          return static_cast<unsigned>(std::ceil(v + 0.5)); 
+    auto rounded = ex
+      | fn::and_then([](auto&& v) -> fn::expected<unsigned, Error> {
+          return static_cast<unsigned>(std::ceil(v + 0.5));
         });
 
     REQUIRE(rounded.value() == 13u);
@@ -84,9 +84,9 @@ TEST_CASE("Minimal expected", "[expected][and_then]")
     // example-expected-and_then-error
     fn::expected<double, Error> ex = std::unexpected<Error>{"Not good"};
 
-    auto oops = ex 
-      | fn::and_then([](auto&& v) -> fn::expected<unsigned, Error> { 
-          return static_cast<unsigned>(std::ceil(v + 0.5)); 
+    auto oops = ex
+      | fn::and_then([](auto&& v) -> fn::expected<unsigned, Error> {
+          return static_cast<unsigned>(std::ceil(v + 0.5));
         }); // Not called because ex contains an Error
 
     REQUIRE(oops.error().what == "Not good");
@@ -228,9 +228,9 @@ TEST_CASE("Minimal optional", "[optional][and_then]")
     // example-optional-and_then-value
     fn::optional<double> op{12.1};
 
-    auto rounded = op 
-      | fn::and_then([](auto&& v) -> fn::optional<unsigned> { 
-          return static_cast<unsigned>(std::ceil(v + 0.5)); 
+    auto rounded = op
+      | fn::and_then([](auto&& v) -> fn::optional<unsigned> {
+          return static_cast<unsigned>(std::ceil(v + 0.5));
         });
 
     REQUIRE(rounded.value() == 13u);
@@ -240,9 +240,9 @@ TEST_CASE("Minimal optional", "[optional][and_then]")
     // example-optional-and_then-empty
     fn::optional<double> op = std::nullopt;
 
-    auto empty = op 
-      | fn::and_then([](auto&& v) -> fn::optional<unsigned> { 
-          return static_cast<unsigned>(std::ceil(v + 0.5)); 
+    auto empty = op
+      | fn::and_then([](auto&& v) -> fn::optional<unsigned> {
+          return static_cast<unsigned>(std::ceil(v + 0.5));
         }); // Not called because op is empty
 
     REQUIRE(not empty.has_value());
@@ -254,7 +254,7 @@ TEST_CASE("Minimal optional", "[optional][and_then]")
 
     auto value = ex
         | fn::filter([](auto &&i) { return i >= 42; }); // Filter out values less than 42
-                     
+
     REQUIRE(value.value() == 42);
     // example-optional-filter-value
   }
diff --git a/tests/util/CMakeLists.txt b/tests/util/CMakeLists.txt
@@ -6,7 +6,7 @@ set(CMAKE_CXX_STANDARD 23)
 set(CMAKE_CXX_STANDARD_REQUIRED ON)
 
 # Pls keep the filenames sorted
-set(UTIL_SOURCE_FILES    
+set(UTIL_SOURCE_FILES
     static_check.hpp
 )
 add_library(${PROJECT_NAME} INTERFACE ${UTIL_SOURCE_FILES})

Original file line number	Diff line number	Diff line change
`@@ -23,5 +23,5 @@ znai_export_docs(`
`23`	`23`	`${CMAKE_BINARY_DIR}/docs`
`24`	`24`	`COMMENT "Export final documentation"`
`25`	`25`	`)`
`26`		`-`
	`26`	`+`
`27`	`27`	`add_dependencies(export_docs docs)`
Original file line number	Diff line number	Diff line change
`@@ -12,4 +12,3 @@ title: fn::choice`
`12`	`12`
`13`	`13`	`## Return value {style: "api"}`
`14`	`14`	`TODO`
`15`		`-`
Original file line number	Diff line number	Diff line change
`@@ -23,6 +23,6 @@ A monadic type of the same kind.`
`23`	`23`	`## Examples {style: "api"}`
`24`	`24`
`25`	`25`	`:include-template: templates/snippet.md {`
`26`		`- path: "examples/simple.cpp",`
	`26`	`+ path: "examples/simple.cpp",`
`27`	`27`	`surroundedBy: ["// example-choice-parse", "// example-choice-checks"]`
`28`	`28`	`}`