Crafter.Review/interfaces/Crafter.Review-Core.cppm
Jorijn van der Graaf 741e3a656d
feat(pipeline): the pure pipeline, checked against its goldens
The modules that turn a frozen range into passes and passes into a
verdict: :Schema, :Tools (the DENY, git and base lists, a leaf, so the
config and the pool both read them), :Plan, :Artifact, :Inventory,
:Dispositions, :State, :Normalize, :Stream, :Prompt, :Config, and the URL
half of :PgWire. Units, jobs, results, the config and the claude stream
stay JSON from end to end, so every key keeps its place; :Text gives JSON
values truthiness, get, ==, membership and Str(), and throws Dyn::Error
under a name for each kind of unexpected data.

Exactness where the bytes are seen:
- the stream classifiers are hand-written scanners with case-insensitive
  folds (the Kelvin sign is a k), Unicode \b and \s, and `.` stopping at
  \n; the SQL call detection takes `<exe> sql` with any path before it;
- config problems carry the JSON scanner's and the UTF-8 decoder's own
  texts, positions included;
- a float total is Neumaier's compensated sum, and the build passes
  -ffp-contract=off: -march=native would fuse a*b+c;
- `crafter-review inventory` and `config` print what the goldens record,
  byte for byte (the fixture and 14 configs, broken ones included); a
  message names this binary as the command to run.

tests/Goldens: the recorded answers over the fixtures next to them (the
commits fixture, a rich versioned series with CRLF, a folded subject,
Markdown headings in and out of fences, the code-key rewrites); the suite
compares 2304 results as DumpFile writes them, so a key out of order fails
too. All agree.

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
2026-10-31 06:48:55 +01:00

48 lines
2.3 KiB
C++

// SPDX-License-Identifier: AGPL-3.0-only
// SPDX-FileCopyrightText: Copyright (C) 2026 Catcrafts®
export module Crafter.Review:Core;
import std;
export namespace Crafter::Review {
// The release this binary was built from, as project.cpp stamped it:
// CRAFTER_REVIEW_VERSION, else `git describe`, else 0.0.0-dev.
std::string_view Version();
// Bumped only when clean results stored under the earlier number must not
// be reused: a text change a lens reads that changes what a clean pass
// proves. It is one of the inputs of every reuse key, so a bump retires
// every stored result at once. A change that leaves what a lens reads the
// same — a layout change, a reworded log line — does not bump it.
constexpr std::int32_t PromptVersion = 1;
// `crafter-review <version> (prompt v<n>)`: the dump's `driver` field,
// the first log line of a run and `--version`.
std::string DriverLine();
// How a person runs this binary, for the command lines it prints: `flatpak
// run net.catcrafts.CrafterReview` in the Flatpak, the binary's absolute
// path otherwise.
std::string Invocation();
// Where the lens texts, the procedure and the templates are: the
// directory that holds process/. In this order:
// - CRAFTER_REVIEW_HOME, natively only: a host setting must not swap the
// Flatpak's lens texts for a checkout's, which would change every reuse
// key without a word;
// - <exe>/../share/crafter-review, which in the Flatpak is
// /app/share/crafter-review;
// - the checkout the binary was built in, when it runs from
// <checkout>/bin/crafter.review-exe-*/.
// Throws std::runtime_error when none of them holds process/lenses.
const std::filesystem::path& Home();
// For tests, which run from neither place.
void SetHome(std::filesystem::path home);
// Home()/process/lenses.
std::filesystem::path LensDir();
// The sha256 of each lens file — the text read with universal newlines,
// as UTF-8 — keyed by file name. Every charter's is part of its lens's
// reuse keys, so --version and the run log print them: a stale home shows
// up there before it shows up as nothing being reused.
std::vector<std::pair<std::string, std::string>> CharterHashes();
}