Merge baseline Expected (#53)

Baseline std::expected<T, E> implementation 
Project scaffolding 
GitHub Actions
Doxygen generation

Tests and CI all Green

Author: steve-downey

.beman-tidy.yaml

@@ -0,0 +1,8 @@
+# SPDX-License-Identifier: Apache-2.0 WITH LLVM-exception
+
+# This is the config file for beman-tidy, which checks compliance with the Beman Standard (https://github.com/bemanproject/beman/blob/main/docs/beman_standard.md)
+# Check documentation for beman-tidy here:
+# https://github.com/bemanproject/beman-tidy/blob/main/README.md
+
+disabled_rules: []
+ignored_paths: []

.clang-format

@@ -125,7 +125,7 @@ IndentCaseBlocks: false
 IndentCaseLabels: false
 IndentExternBlock: AfterExternBlock
 IndentGotoLabels: true
-IndentPPDirectives: None
+IndentPPDirectives: BeforeHash
 IndentRequiresClause: true
 IndentWidth:     4
 IndentWrappedFunctionNames: false

.copier-answers.yml

@@ -0,0 +1,14 @@
+# Standard answers and internal state managed by Copier
+_commit: 2.0.0-322-gc3c230c
+_src_path: https://github.com/steve-downey/exemplar.git
+description: Expected Over References
+maintainer: steve-downey
+minimum_cpp_build_version: '20'
+paper: PnnnnRr
+project_name: expected
+unit_test_library: catch2
+# Hidden variables manually tracked because 'when: false' omits them from _copier_answers
+generating_exemplar: false
+owner: "bemanproject"
+ci_tests_cron: "15 12 * * 2"
+pre_commit_update_cron: "50 7 * * 4"

.exemplar_version

@@ -0,0 +1 @@
+ec861600898941a5114f352f1efcba57d825b6d0

.gitattributes

@@ -1,5 +1,6 @@
 infra/** linguist-vendored
-cookiecutter/** linguist-vendored
+template/** linguist-vendored
+copier/** linguist-vendored
 *.bib -linguist-detectable
 *.tex -linguist-detectable
 papers/* linguist-documentation

.github/workflows/ci_tests.yml

@@ -9,7 +9,11 @@ on:
   pull_request:
   workflow_dispatch:
   schedule:
-    - cron: '30 15 * * *'
+    - cron: '15 12 * * 2'
+
+concurrency:
+  group: ${{format('{0}:{1}', github.repository, github.ref)}}
+  cancel-in-progress: true
 
 jobs:
   beman-submodule-check:
@@ -36,35 +40,60 @@ jobs:
       matrix_config: >
         {
           "gcc": [
-            { "versions": ["15"],
+            { "versions": ["16"],
               "tests": [
                 { "cxxversions": ["c++26"],
                   "tests": [
                     { "stdlibs": ["libstdc++"],
                       "tests": [
                         "Debug.Default", "Release.Default", "Release.TSan",
                         "Release.MaxSan", "Debug.Werror",
-                        "Debug.Coverage"
+                        "Debug.Coverage", "Debug.-DBEMAN_EXPECTED_USE_MODULES=On"
+                      ]
+                    }
+                  ]
+                },
+                { "cxxversions": ["c++23"],
+                  "tests": [
+                    { "stdlibs": ["libstdc++"],
+                      "tests": [
+                        "Release.Default", "Debug.-DBEMAN_EXPECTED_USE_MODULES=On"
+                      ]
+                    }
+                  ]
+                },
+                { "cxxversions": ["c++20"],
+                  "tests": [{ "stdlibs": ["libstdc++"], "tests": ["Release.Default"]}]
+                }
+              ]
+            },
+            { "versions": ["15"],
+              "tests": [
+                { "cxxversions": ["c++26", "c++23"],
+                  "tests": [
+                    { "stdlibs": ["libstdc++"],
+                      "tests": [
+                        "Release.Default", "Debug.-DBEMAN_EXPECTED_USE_MODULES=On"
                       ]
                     }
                   ]
                 },
-                { "cxxversions": ["c++23", "c++20", "c++17"],
+                { "cxxversions": ["c++20"],
                   "tests": [{ "stdlibs": ["libstdc++"], "tests": ["Release.Default"]}]
                 }
               ]
             },
             { "versions": ["14", "13"],
               "tests": [
-                { "cxxversions": ["c++26", "c++23", "c++20", "c++17"],
+                { "cxxversions": ["c++26", "c++23", "c++20"],
                   "tests": [{ "stdlibs": ["libstdc++"], "tests": ["Release.Default"]}]
                 }
               ]
             },
             {
               "versions": ["12", "11"],
               "tests": [
-                { "cxxversions": ["c++23", "c++20", "c++17"],
+                { "cxxversions": ["c++23", "c++20"],
                   "tests": [{ "stdlibs": ["libstdc++"], "tests": ["Release.Default"]}]
                 }
               ]
@@ -78,12 +107,22 @@ jobs:
                     { "stdlibs": ["libstdc++", "libc++"],
                       "tests": [
                         "Debug.Default", "Release.Default", "Release.TSan",
-                        "Release.MaxSan", "Debug.Werror"
+                        "Release.MaxSan", "Debug.Werror",
+                        "Debug.-DBEMAN_EXPECTED_USE_MODULES=On"
                       ]
                     }
                   ]
                 },
-                { "cxxversions": ["c++23", "c++20", "c++17"],
+                { "cxxversions": ["c++23"],
+                  "tests": [
+                    { "stdlibs": ["libstdc++", "libc++"],
+                      "tests": [
+                        "Release.Default", "Debug.-DBEMAN_EXPECTED_USE_MODULES=On"
+                      ]
+                    }
+                  ]
+                },
+                { "cxxversions": ["c++20"],
                   "tests": [
                     {"stdlibs": ["libstdc++", "libc++"], "tests": ["Release.Default"]}
                   ]
@@ -92,19 +131,29 @@ jobs:
             },
             { "versions": ["21", "20", "19"],
               "tests": [
-                { "cxxversions": ["c++26", "c++23", "c++20", "c++17"],
+                { "cxxversions": ["c++26", "c++23", "c++20"],
                   "tests": [
                     {"stdlibs": ["libstdc++", "libc++"], "tests": ["Release.Default"]}
                   ]
                 }
               ]
             },
-            { "versions": ["18", "17"],
+            { "versions": ["18"],
+              "tests": [
+                { "cxxversions": ["c++26", "c++23", "c++20"],
+                  "tests": [{"stdlibs": ["libc++"], "tests": ["Release.Default"]}]
+                },
+                { "cxxversions": ["c++23", "c++20"],
+                  "tests": [{"stdlibs": ["libstdc++"], "tests": ["Release.Default"]}]
+                }
+              ]
+            },
+            { "versions": ["17"],
               "tests": [
-                { "cxxversions": ["c++26", "c++23", "c++20", "c++17"],
+                { "cxxversions": ["c++26", "c++23", "c++20"],
                   "tests": [{"stdlibs": ["libc++"], "tests": ["Release.Default"]}]
                 },
-                { "cxxversions": ["c++20", "c++17"],
+                { "cxxversions": ["c++20"],
                   "tests": [{"stdlibs": ["libstdc++"], "tests": ["Release.Default"]}]
                 }
               ]
@@ -113,7 +162,7 @@ jobs:
           "appleclang": [
             { "versions": ["latest"],
               "tests": [
-                { "cxxversions": ["c++26", "c++23", "c++20", "c++17"],
+                { "cxxversions": ["c++26", "c++23", "c++20"],
                   "tests": [{ "stdlibs": ["libc++"], "tests": ["Release.Default"]}]
                 }
               ]
@@ -125,7 +174,10 @@ jobs:
                 { "cxxversions": ["c++23"],
                   "tests": [
                     { "stdlibs": ["stl"],
-                      "tests": ["Debug.Default", "Release.Default", "Release.MaxSan"]
+                      "tests": [
+                        "Debug.Default", "Release.Default", "Release.MaxSan",
+                        "Debug.-DBEMAN_EXPECTED_USE_MODULES=On"
+                      ]
                     }
                   ]
                 }
@@ -134,6 +186,16 @@ jobs:
           ]
         }
 
+  vcpkg-ci:
+    uses: bemanproject/infra-workflows/.github/workflows/reusable-beman-vcpkg-ci.yml@1.7.2
+    with:
+      port_name: beman-expected
+      feature_combinations: |
+        [
+          {"features": {}},
+          {"features": {"modules": true}}
+        ]
+
   create-issue-when-fault:
     needs: [preset-test, build-and-test]
     if: failure() && github.event_name == 'schedule'

.github/workflows/pre-commit-update.yml

@@ -5,7 +5,7 @@ name: Weekly pre-commit autoupdate
 on:
   workflow_dispatch:
   schedule:
-    - cron: "0 16 * * 0"
+    - cron: "50 7 * * 4"
 
 jobs:
   auto-update-pre-commit:

.github/workflows/vcpkg-release.yml

@@ -0,0 +1,14 @@
+# SPDX-License-Identifier: Apache-2.0 WITH LLVM-exception
+
+name: vcpkg registry release
+on:
+  release:
+    types: [published]
+jobs:
+  vcpkg-release:
+    permissions: {}
+    uses: bemanproject/infra-workflows/.github/workflows/reusable-beman-vcpkg-release.yml@1.7.2
+    with:
+      port_name: beman-expected
+    secrets:
+      VCPKG_REGISTRY_TOKEN: ${{ secrets.VCPKG_REGISTRY_TOKEN }}

.gitignore

@@ -10,8 +10,15 @@
 
 # ignore vscode settings
 .vscode
+
+# ignore vim swap files
+.swp
+
+# ignore merge/patch backup files
+.orig
 /.build/
 /.install/
 /.update-submodules
 /uv.lock
 .build
+/.claude/

.markdownlint.yaml

@@ -1,3 +1,4 @@
+# SPDX-License-Identifier: Apache-2.0 WITH LLVM-exception
 # 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