loftspec 2.1.0

The Loft Specification Format: document model, identity, canonical bytes, hashing and conversion
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
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86

//! What the converter reports about the project it converts. Every finding has a code and the
//! severity info; none stops the conversion.

use crate::report::{InfoFinding, InfoRule};
use crate::wire::wire_names;

/// The rule a finding follows; its wire name is its code.
#[derive(Debug, Clone, Copy, PartialEq, Eq, PartialOrd, Ord, Hash)]
pub enum Rule {
    FrontMatter,
    PlaceholderPurpose,
    ExtraSection,
    StrayRequirementsText,
    NonScenarioChild,
    DeltaSection,
    NoModal,
    ModalRewritten,
    DuplicateRequirement,
    ActiveChanges,
    ArchivedChanges,
    ConfigContext,
    Store,
    MetadataInParagraph,
}

wire_names!(Rule {
    FrontMatter => "OS-001",
    PlaceholderPurpose => "OS-002",
    ExtraSection => "OS-003",
    StrayRequirementsText => "OS-004",
    NonScenarioChild => "OS-005",
    DeltaSection => "OS-006",
    NoModal => "OS-007",
    ModalRewritten => "OS-008",
    DuplicateRequirement => "OS-010",
    ActiveChanges => "OS-011",
    ArchivedChanges => "OS-012",
    ConfigContext => "OS-013",
    Store => "OS-014",
    MetadataInParagraph => "OS-015",
});

impl Rule {
    /// What a finding of the rule says, before its detail.
    #[must_use]
    pub const fn message(self) -> &'static str {
        match self {
            Self::FrontMatter => "front matter was skipped",
            Self::PlaceholderPurpose => {
                "the Purpose is OpenSpec's archive placeholder; the Feature has no body"
            }
            Self::ExtraSection => "a section other than Purpose and Requirements became a Section",
            Self::StrayRequirementsText => {
                "text of Requirements outside every requirement became a Section"
            }
            Self::NonScenarioChild => {
                "a child of a requirement that is not a scenario became a Section"
            }
            Self::DeltaSection => "a delta section in a main spec became a Section",
            Self::NoModal => "the requirement holds neither SHALL nor MUST",
            Self::ModalRewritten => "statements whose SHALL or MUST was written as shall",
            Self::DuplicateRequirement => "a second requirement has the same name",
            Self::ActiveChanges => "active changes were not converted",
            Self::ArchivedChanges => "archived changes were not converted",
            Self::ConfigContext => "the context of config.yaml was not converted",
            Self::Store => "config.yaml names a store; the main specs may be kept elsewhere",
            Self::MetadataInParagraph => {
                "a metadata line lies inside the statement's paragraph; the lines around it were \
                 joined into the statement"
            }
        }
    }
}

impl InfoRule for Rule {
    fn code(self) -> &'static str {
        self.as_str()
    }

    fn message(self) -> &'static str {
        Self::message(self)
    }
}

/// A finding of one of the rules.
pub type Finding = InfoFinding<Rule>;