Add pre-commit hooks (#102)

Author: ClausKlein

.codespellignore

@@ -0,0 +1,5 @@
+cancelled
+copyable
+pullrequest
+snd
+statics

.codespellrc

@@ -3,4 +3,4 @@ builtin = clear,rare,en-GB_to_en-US,names,informal,code
 check-hidden =
 skip = ./.git,./build/*,./stagedir/*,./docs/html/*,./docs/latex/*,*.log,.*.swp,*~,*.bak,Makefile
 quiet-level = 2
-# ignore-words = .ignore-words
+ignore-words = .codespellignore

.devcontainer/devcontainer.json

@@ -1,19 +1,19 @@
 // SPDX-License-Identifier: Apache-2.0 WITH LLVM-exception
-// For format details, see https://aka.ms/devcontainer.json. For config options, see the
-// README at: https://github.com/devcontainers/templates/tree/main/src/cpp
+    // For format details, see https://aka.ms/devcontainer.json. For config options, see the
+    // README at: https://github.com/devcontainers/templates/tree/main/src/cpp
 
-{
-	"name": "Beman Project Generic Devcontainer",
-	"build": {
-		"dockerfile": "Dockerfile"
-	},
-	"postCreateCommand": "bash .devcontainer/postcreate.sh",
-	"customizations": {
-		"vscode": {
-			"extensions": [
-				"ms-vscode.cpptools",
-				"ms-vscode.cmake-tools"
-			]
-		}
-	}
-}
+    {
+      "name": "Beman Project Generic Devcontainer",
+      "build": {
+        "dockerfile": "Dockerfile"
+      },
+      "postCreateCommand": "bash .devcontainer/postcreate.sh",
+      "customizations": {
+        "vscode": {
+          "extensions": [
+            "ms-vscode.cpptools",
+            "ms-vscode.cmake-tools"
+          ]
+        }
+      }
+    }

.github/CODEOWNERS

@@ -2,4 +2,3 @@
 # Codeowners for reviews on PRs
 
 *  @dietmarkuehl @camio @neatudarius
-

.gitignore

@@ -45,4 +45,4 @@ CMakeCache.txt
 CMakeFiles/
 
 docs/html
-docs/latex
+docs/latex

.markdownlint.yaml

@@ -0,0 +1,9 @@
+# MD033/no-inline-html : Inline HTML : https://github.com/DavidAnson/markdownlint/blob/v0.35.0/doc/md033.md
+# Disable inline html linter is needed for <details> <summary>
+MD033: false
+
+# MD013/line-length : Line length : https://github.com/DavidAnson/markdownlint/blob/v0.35.0/doc/md013.md
+# Conforms to .clang-format ColumnLimit
+# Update the comment in .clang-format if we no-longer tie these two column limits.
+MD013:
+  line_length: 119

.pre-commit-config.yaml

@@ -0,0 +1,40 @@
+# 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: v5.0.0
+    hooks:
+      # TODO: - id: trailing-whitespace
+      # TODO: - id: end-of-file-fixer
+      # FIXME: - id: check-yaml
+      - id: check-added-large-files
+
+  # TODO: Clang-format for C++
+  # This brings in a portable version of clang-format.
+  # See also: https://github.com/ssciwr/clang-format-wheel
+  # - repo: https://github.com/pre-commit/mirrors-clang-format
+  #   rev: v19.1.4
+  #   hooks:
+  #     - id: clang-format
+  #       types_or: [c++, c, json]
+
+  # TODO: CMake linting and formatting
+  # - repo: https://github.com/BlankSpruce/gersemi
+  #   rev: 0.17.1
+  #   hooks:
+  #     - id: gersemi
+  #       name: CMake linting
+
+  # TODO: Markdown linting
+  # Config file: .markdownlint.yaml
+  # - repo: https://github.com/igorshubovych/markdownlint-cli
+  #   rev: v0.43.0
+  #   hooks:
+  #     - id: markdownlint
+
+  - repo: https://github.com/codespell-project/codespell
+    rev: v2.3.0
+    hooks:
+      - id: codespell
+        files: ^.*\.(cmake|cpp|hpp|txt|md|json|in|yaml|yml)$
+        args: ["--ignore-words", ".codespellignore" ]

include/beman/execution26/detail/common.hpp

@@ -21,7 +21,7 @@
  *
  * There are a few ingredients to using `std::execution`:
  *
- * - Sender algoritms to composes work into an asynchronous workflow.
+ * - Sender algorithms to composes work into an asynchronous workflow.
  * - Something holding and starting senders like `sync_wait()`
  *   or `counting_scope`.
  * - A coroutine binding like `task` to make sender composition

include/beman/execution26/detail/completion_signatures_for.hpp

@@ -21,7 +21,7 @@ namespace beman::execution26::detail {
 struct no_completion_signatures_defined_in_sender {};
 
 /*!
- * \brief Primary template declaration for the customisation of sender completion signatures.
+ * \brief Primary template declaration for the customization of sender completion signatures.
  * \headerfile beman/execution26/execution.hpp <beman/execution26/execution.hpp>
  * \internal
  */

include/beman/execution26/detail/forwarding_query.hpp

@@ -39,7 +39,7 @@ namespace beman::execution26 {
  */
 using forwarding_query_t = beman::execution26::detail::forwarding_query_t;
 /*!
- * \brief The customizatoin point object to determine whether querys should be forwarded
+ * \brief The customizatoin point object to determine whether queries should be forwarded
  * \headerfile beman/execution26/execution.hpp <beman/execution26/execution.hpp>
  *
  * \details