specfold-core 0.5.1

Library behind specfold: typed Markdown documents, owners, a derived graph and checks.
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51

//! P1: a document lives with the owner of the code it governs.

use super::support::skipped;
use crate::check::context::Ctx;
use crate::check::finding::Finding;
use crate::check::rule::{Rule, RuleInfo};
use crate::model::Tier;
use crate::placement;

pub struct OwnerMatches;

impl Rule for OwnerMatches {
    fn info(&self) -> &RuleInfo {
        &RuleInfo {
            id: "P1",
            title: "documents live with the owner of the code they govern",
            explain: "A document belongs in the spec directory of the narrowest owner that contains every path in its rel.governs (a public owner's documents go to its private companion; a retired owner's to the root). Governs inside another project (a submodule, a remote checked out in the repository, or `<remote>:<path>`) are left out of the decision since 0.5.0, so a document that governed such a path beside its own code may now belong to a narrower owner. When code moves, or P1 asks, `spec mv <id> --owner <owner> --write` (the fix P1 prints; since 0.5.1 plain `spec mv <id> --write` decides the same owner) moves the document, rewrites every reference to it and carries its `[check] baseline` entries along.",
            on_commit: true,
        }
    }

    fn run(&self, ctx: &Ctx, out: &mut Vec<Finding>) {
        let owners = &ctx.corpus.owners;
        for (i, d) in ctx.corpus.docs.iter().enumerate() {
            if !ctx.scope.covers(i) || d.tier == Tier::Local || skipped(d, "P1") {
                continue;
            }
            let Some(current) = owners.by_id(&d.id.owner) else { continue };
            let all = d.rel().remove("governs").unwrap_or_default();
            if !all.is_empty() && all.iter().all(|g| crate::remotes::is_external(&ctx.corpus.cfg, g)) {
                continue;
            }
            let decision = placement::decide_local(&ctx.corpus.cfg, owners, &all, current);
            if decision.owner.id != current.id {
                out.push(
                    Finding::error(
                        "P1",
                        &d.path,
                        1,
                        format!("belongs to {} ({}), not {}", decision.owner.id, decision.reason, current.id),
                    )
                    .fix_cmd(format!(
                        "spec mv {} --owner {} --write",
                        crate::shell::word(&d.id),
                        crate::shell::word(&decision.owner.id)
                    )),
                );
            }
        }
    }
}