spec_driven_docs/domain/
rule_id.rs

1//! Rule identifiers: one variant per requirement the specs define.
2//!
3//! A rule ID is an address — `domain:rule` — that a failure message cites and
4//! a reader follows to the sentence that binds. This enum is the compile-time
5//! form of every `` ### `domain:rule` `` heading under the canon's specs; a
6//! parity test in `embedded` holds the two sets equal. Rule prose lives in
7//! the specs, never here.
8
9use std::fmt;
10
11macro_rules! rule_ids {
12    ($($variant:ident => $id:literal,)+) => {
13        /// A `domain:rule` requirement address defined by a spec.
14        #[derive(Debug, Clone, Copy, PartialEq, Eq, PartialOrd, Ord, Hash)]
15        pub enum RuleId {
16            $(
17                #[doc = $id]
18                $variant,
19            )+
20        }
21
22        impl RuleId {
23            /// Every rule the specs define, in slug order.
24            pub const ALL: &'static [Self] = &[$(Self::$variant),+];
25
26            /// The `domain:rule` slug pair this variant addresses.
27            #[must_use]
28            pub const fn as_str(self) -> &'static str {
29                match self {
30                    $(Self::$variant => $id),+
31                }
32            }
33        }
34    };
35}
36
37rule_ids! {
38    CellCarriesOneReference => "comparison-docs:a-cell-carries-one-reference",
39    ComparisonCarriesALegend => "comparison-docs:a-comparison-carries-a-legend",
40    VerdictCarriesItsWord => "comparison-docs:a-verdict-carries-its-word",
41    EveryTableIsDated => "comparison-docs:every-table-is-dated",
42    TablePipesAreEscaped => "comparison-docs:table-pipes-are-escaped",
43    CitationResolvesToARule => "decision-records:a-citation-resolves-to-a-rule",
44    BodyStaysWithinWordCap => "decision-records:body-stays-within-350-words",
45    FilenameCarriesNoDigit => "decision-records:filename-carries-no-digit",
46    MergedRecordIsPermanent => "decision-records:merged-record-is-permanent",
47    RecordIsNotRevised => "decision-records:record-is-not-revised",
48    SeededRuleRunsNoCanonCommand => "distribution:a-seeded-rule-runs-no-canon-command",
49    SkillHasOneOwner => "distribution:a-skill-has-one-owner",
50    SkillInstallRestoresOnFailure => "distribution:a-skill-install-restores-on-failure",
51    SkillObeysThePortableFormat => "distribution:a-skill-obeys-the-portable-format",
52    SkillPlansBeforeItActs => "distribution:a-skill-plans-before-it-acts",
53    StaleSkillIsNotAConflict => "distribution:a-stale-skill-is-not-a-conflict",
54    InstallSweepsWhatThePayloadDropped => "distribution:an-install-sweeps-what-the-payload-dropped",
55    InitializationPreservesProjectContent => "distribution:initialization-preserves-project-content",
56    InstancesOperateOffline => "distribution:instances-operate-offline",
57    ManifestIdentifiesEveryOwnedFile => "distribution:manifest-identifies-every-owned-file",
58    SharedSkillArtifactsHaveOneHome => "distribution:shared-skill-artifacts-have-one-home",
59    SkillInstallPreviewsBeforeWriting => "distribution:skill-install-previews-before-writing",
60    SkillUninstallRemovesOnlyWhatItWrote => "distribution:skill-uninstall-removes-only-what-it-wrote",
61    SkillsArePartOfThePayload => "distribution:skills-are-part-of-the-payload",
62    ThePayloadNamesNoOtherProject => "distribution:the-payload-names-no-other-project",
63    ThePayloadNamesNoPlanningTool => "distribution:the-payload-names-no-planning-tool",
64    ThePayloadRootsAreDeclaredOnce => "distribution:the-payload-roots-are-declared-once",
65    UpgradeConflictsAreAtomic => "distribution:upgrade-conflicts-are-atomic",
66    UserScopeFilesStayUnrecorded => "distribution:user-scope-files-stay-unrecorded",
67    AuthorInstructionsStayWithinBudget => "docs-format:author-instructions-stay-within-budget",
68    ChapterStaysWithinLineCap => "docs-format:chapter-stays-within-200-lines",
69    DocumentStatesThePresent => "docs-format:document-states-the-present",
70    DocumentUsesStructuralMarkdownOnly => "docs-format:document-uses-structural-markdown-only",
71    EveryBudgetCarriesAGate => "docs-format:every-budget-carries-a-gate",
72    FenceDeclaresALanguage => "docs-format:fence-declares-a-language",
73    ProseStaysUnwrapped => "docs-format:prose-stays-unwrapped",
74    DocumentCarriesNoPersonalPath => "docs-foundations:a-document-carries-no-personal-path",
75    DocumentOwnsWhatItGoverns => "docs-foundations:a-document-owns-what-it-governs",
76    KindPrefixCarriesASlug => "docs-foundations:a-kind-prefix-carries-a-slug",
77    ArtifactFilenamesCarryAKindPrefix => "docs-foundations:artifact-filenames-carry-a-kind-prefix",
78    CompanionArtifactsShareTheSpecName => "docs-foundations:companion-artifacts-share-the-spec-name",
79    SpecStatesThePresent => "docs-foundations:spec-states-the-present",
80    SpecWinsOverRecord => "docs-foundations:spec-wins-over-record",
81    SpecsAreCentralized => "docs-foundations:specs-are-centralized",
82    ProhibitionsAreCapped => "docs-specs:prohibitions-are-capped",
83    RequirementCarriesAVerification => "docs-specs:requirement-carries-a-verification",
84    RequirementCarriesFiveParts => "docs-specs:requirement-carries-five-parts",
85    RuleIdIsUniqueAndSlugged => "docs-specs:rule-id-is-unique-and-slugged",
86    RuleIdOutlivesItsSentence => "docs-specs:rule-id-outlives-its-sentence",
87    SpecStaysWithinLineCap => "docs-specs:spec-stays-within-300-lines",
88    StatementUsesAnEarsPattern => "docs-specs:statement-uses-an-ears-pattern",
89    UnenforcedRulesAreDeclared => "docs-specs:unenforced-rules-are-declared",
90    VerificationNamesALiveHook => "docs-specs:verification-names-a-live-hook",
91    DivergentResultNamesItsDestination => "guides:a-divergent-result-names-its-destination",
92    ManualStepEnumeratesItsInteraction => "guides:a-manual-step-enumerates-its-interaction",
93    StepFollowsItsProducers => "guides:a-step-follows-its-producers",
94    StepIsOneImperativeAction => "guides:a-step-is-one-imperative-action",
95    ExternalFactIsVerifiedUpstream => "guides:an-external-fact-is-verified-upstream",
96    CitationsLiveInTheReferenceZone => "guides:citations-live-in-the-reference-zone",
97    EveryStepCarriesItsCheck => "guides:every-step-carries-its-check",
98    PreconditionsOpenAndVerificationCloses => "guides:preconditions-open-and-verification-closes",
99    TheManifestStaysReadable => "instance:the-manifest-stays-readable",
100    BugzillaReportBodyFitsReportWidth => "known-issues:a-bugzilla-report-body-fits-in-79-columns",
101    FiledRecordCarriesItsReport => "known-issues:a-filed-record-carries-its-report",
102    RecordCarriesItsRetirementCondition => "known-issues:a-record-carries-its-retirement-condition",
103    RecordWalksTheMechanism => "known-issues:a-record-walks-the-mechanism",
104    CaseIdIsASlug => "known-issues:case-id-is-a-slug",
105    CanonGateIsNotDelivered => "release:a-canon-gate-is-not-delivered",
106    ReleasedVersionIsNotReAuthored => "release:a-released-version-is-not-re-authored",
107    TagDerivesFromTheVersionFile => "release:a-tag-derives-from-the-version-file",
108    LicenseDeclaresBothHalves => "release:license-declares-both-halves",
109    CanonRecordDescribesItsTree => "release:the-canon-record-describes-its-tree",
110    DeliveredGateSetIsDeclaredOnce => "release:the-delivered-gate-set-is-declared-once",
111    VersionsAreSemanticAndAligned => "release:versions-are-semantic-and-aligned",
112    CommentCitesTheRule => "spec-to-code:a-comment-cites-the-rule",
113    CommentNamesNoRecord => "spec-to-code:a-comment-names-no-record",
114    GateMessageCitesTheRule => "spec-to-code:a-gate-message-cites-the-rule",
115    SpecChangeIsTyped => "spec-to-code:a-spec-change-is-typed",
116    SpecMayLeadItsCode => "spec-to-code:a-spec-may-lead-its-code",
117    SuppressionNamesItsCase => "spec-to-code:a-suppression-names-its-case",
118    EntryDocumentCitesRuleIds => "spec-to-code:an-entry-document-cites-rule-ids",
119    UnenactedRulesAreTheBacklog => "spec-to-code:unenacted-rules-are-the-backlog",
120}
121
122impl fmt::Display for RuleId {
123    fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
124        f.write_str(self.as_str())
125    }
126}
127
128#[cfg(test)]
129mod tests {
130    use super::*;
131
132    #[test]
133    fn slugs_are_well_formed_and_unique() {
134        let mut seen = std::collections::BTreeSet::new();
135        for rule in RuleId::ALL {
136            let id = rule.as_str();
137            let (domain, name) = id.split_once(':').unwrap();
138            let assert_slug = |part: &str| {
139                assert!(!part.is_empty(), "{id} has an empty half");
140                assert!(
141                    part.bytes()
142                        .all(|b| b.is_ascii_lowercase() || b.is_ascii_digit() || b == b'-'),
143                    "{id} is not a slug pair"
144                );
145            };
146            assert_slug(domain);
147            assert_slug(name);
148            assert!(seen.insert(id), "{id} is duplicated");
149        }
150    }
151
152    #[test]
153    fn display_renders_the_slug_pair() {
154        assert_eq!(
155            RuleId::ChapterStaysWithinLineCap.to_string(),
156            "docs-format:chapter-stays-within-200-lines"
157        );
158    }
159}
spec_driven_docs/domain/rule_id.rs

spec_driven_docs/domain/
rule_id.rs
