refs

type LedgerEntry struct {
	QuarantineID string `json:"quarantine_id"`
	Time         string `json:"time"`
	Op           string `json:"op"`
	File         string `json:"file"`
	Original     string `json:"original,omitempty"`
	LineOrKey    string `json:"line_or_key"`
	Line         int    `json:"line,omitempty"`
	Before       string `json:"before,omitempty"`
	After        string `json:"after,omitempty"`
	HashBefore   string `json:"hash_before,omitempty"`
	HashAfter    string `json:"hash_after,omitempty"`
	Reason       string `json:"reason,omitempty"`
}

type Options struct {
	// VaultPath is the vault root (the parent of the topic directories).
	VaultPath string
	// TopicRoot is the topic directory.
	TopicRoot string
	// Path is the topic-relative file: `raw/...` for Quarantine; the original
	// or the quarantine path for Restore (used when ID is empty).
	Path string
	// Reason is the triage_reason written on quarantine (off_topic, thin, ...).
	Reason string
	// ID is the quarantine id; Quarantine derives one when empty.
	ID string
	// Writer writes the triage keys; one is opened on the topic when nil.
	Writer *corpus.Writer
	// State, when set, keeps the state row's written hashes in step with the
	// removal of items from kb-owned list keys, so a kb-written relation
	// stays kb-owned after quarantine and restore.
	State *corpus.StateStore
	// Now defaults to time.Now.
	Now func() time.Time
	// contains filtered or unexported fields
}

type Quarantined struct {
	ID       string `json:"id"`
	Path     string `json:"path"`
	Original string `json:"original"`
	Reason   string `json:"reason"`
	Time     string `json:"time"`
	Edits    int    `json:"edits"`
}

type Ref struct {
	// File is the topic-relative path of the referring document.
	File string `json:"file"`
	// Kind is KindIndexLine, KindFrontmatter or KindBody.
	Kind string `json:"kind"`
	// Key is the frontmatter key for KindFrontmatter references.
	Key string `json:"key,omitempty"`
	// Line is the 1-based line number in the referring file.
	Line int `json:"line"`
	// Text is the referring line (index lines, frontmatter items) or the
	// link markup (body links).
	Text string `json:"text"`
}

type RestoreResult struct {
	ID string
	// Restored lists the ledger rows that were replayed.
	Restored []LedgerEntry
	// Manual lists edit rows that were not replayed because the touched file
	// changed since the quarantine; they are ready to print for manual repair.
	Manual []LedgerEntry
	// Path is the topic-relative path the file was moved back to.
	Path string
}

type Result struct {
	ID string
	// NewPath is the topic-relative quarantine path.
	NewPath string
	// Removed lists the ledger rows of every removal (move row first).
	Removed []LedgerEntry
	// BodyRefs are references left in place: body links and index lines that
	// also link to files that are not quarantined. Lint reports them as
	// link-to-quarantined.
	BodyRefs []Ref
	// Unremoved are frontmatter references that could not be removed line by
	// line (flow-style or scalar values, keys outside RemovableKeys, locked
	// documents); they are left for the owner.
	Unremoved []Ref
	// SkippedUserKeys lists triage keys the writer left alone because the
	// user owns them.
	SkippedUserKeys []string
}