Jorijn van der Graaf
6cf15919db
A lens has one charter, the one this pipeline ships; what a repository knows that is not general to the lens - its platform and layers, the record it keeps its decisions in, what its users already have, the calibration entries that are its own - goes in a file the config names for the lens (lenses.<name>.section), and Charter appends it after one blank line. The charter sha in every reuse key covers the combined text. The config refuses a path outside the repository - absolute, or climbing out with `..` - by the check slots.dir had, now one both settings share; a file missing or one the run could not use (a dangling link, unreadable, not UTF-8) is a problem too, checked through the reader Charter uses (Prompt::ReadSection), so a section is never dropped in silence, and a name that is no lens is the unknown key it always was. Nothing lists a directory, so what lies beside the files is no concern of the config's: a directory listed would have to tolerate or refuse every foreign entry. The run logs which charters got one. The better-solution charter gains a consumer's general entry (2026-10-31: a mechanism reworked a second time in one submission is the signal to derive the fix at every layer the data crosses). The procedure names the section wherever it names the charter: among the config's keys, in the lens inputs, in the reuse rule (an edit to either re-runs the lens) and in the feedback loop, which routes a repository's own lesson to its section and a general one to the shipped charter.
49 lines
2.4 KiB
C++
49 lines
2.4 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 shipped lens file — the text read with universal
|
|
// newlines, as UTF-8 — keyed by file name. A lens's reuse keys carry its
|
|
// charter's (the combined text's when lenses.<name>.section gives the
|
|
// lens a section of the repository's own), so --version prints these: a
|
|
// stale home shows up there before it shows up as nothing being reused.
|
|
std::vector<std::pair<std::string, std::string>> CharterHashes();
|
|
}
|