Crate specfold_core 

specfold-core: typed Markdown documents, their owners, the graph between them and the checks over it. The CLI crate is a thin layer over this library.

Re-exports

pub use config::Config;

pub use corpus::Corpus;

pub use corpus::LoadOptions;

pub use graph::Graph;

pub use model::Doc;

pub use model::DocId;

Modules

audit

Audits: what passes every check yet needs attention (diagnose), how documents changed over time (history), and packs for judgement a machine cannot make alone (pack).

authoring

Writing documents: create, change, move and fix. Every operation returns a plan; nothing touches the disk until the plan is applied.

census

A census of the corpus: how much there is, where, and in what state. Used to measure a migration before and after, and to confirm an old layout is gone.

check

Checks over the corpus: rules, their scope, and the findings they report.

config

Project configuration (spec.toml).

corpus

The corpus: every document under every owner’s spec directory.

files

Attachments: non-Markdown files that belong to a document, kept in the repository when small and in a store when large.

graph

The graph derived from documents. It is computed on every run and never stored.

guards

Guards: named checks over any file in the repository and over commit messages, such as the gate that keeps internal names out of a public package.

import

Importing documents from another layout through a project’s import map.

markdown

Reading and writing the Markdown files documents are made of.

model

The data model: identifiers, types, lifecycle and documents.

placement

Placement: which owner a document belongs to and the path it lives at.

plugins

Plugins: external programs that add rules, importers, exporters, audits and event handlers over a JSON protocol. Only programs named in spec.toml ever run.

search

Searching the corpus by words, type, owner, status and tags.

trace

Phase timings on stderr when SPECFOLD_TRACE is set, for diagnosing slow runs.

workspace

The repository around the documents: its owners and its version control.