use crate::domain::instance_config::WritingStyle;
use crate::domain::marker::{AGENTS_BEGIN, AGENTS_END};
pub const LINE_LENGTH_SUPPRESSION: &str = "<!-- markdownlint-disable-line MD013 -->";
const ROUTE_PLACEHOLDER: &str = "- {writing_style}";
#[must_use]
pub fn snippet() -> &'static str {
crate::embedded::INSTANCE
.get_file("snippets/AGENTS-docs.md")
.and_then(include_dir::File::contents_utf8)
.unwrap_or_default()
}
#[must_use]
pub fn route_line(selection: &WritingStyle) -> Option<String> {
selection
.route()
.map(|route| format!("- Read the writing style before you author or edit prose: {route}."))
}
#[must_use]
pub fn render_block(docs_root: &str, selection: &WritingStyle) -> String {
let mut body = String::new();
for line in crate::domain::profile::render_root(snippet(), docs_root).lines() {
let line = if line == ROUTE_PLACEHOLDER {
match route_line(selection) {
Some(route) => route,
None => continue,
}
} else {
line.to_string()
};
body.push_str(&line);
if line.starts_with("- ") {
body.push(' ');
body.push_str(LINE_LENGTH_SUPPRESSION);
}
body.push('\n');
}
let body = body.trim_matches('\n');
format!("{AGENTS_BEGIN}\n\n{body}\n\n{AGENTS_END}\n")
}
#[cfg(test)]
mod tests {
use super::*;
use crate::domain::instance_config::WritingSource;
#[test]
fn the_block_carries_the_markers_and_the_root() {
let block = render_block("docs", &WritingStyle::default());
assert!(block.starts_with("<!-- BEGIN spec-driven-docs docs -->\n"));
assert!(block.ends_with("<!-- END spec-driven-docs docs -->\n"));
assert!(block.contains(
"Read the writing style before you author or edit prose: `sdd method writing-style`."
));
assert!(!block.contains("{docs_root}"));
assert!(!block.contains("{writing_style}"));
assert!(!block.contains("simple-english"));
}
#[test]
fn a_blank_line_separates_each_marker_from_the_body() {
for selection in [
WritingStyle::default(),
WritingStyle {
source: WritingSource::None,
path: None,
},
] {
let block = render_block("docs", &selection);
assert!(
block.starts_with("<!-- BEGIN spec-driven-docs docs -->\n\n## "),
"{block}"
);
assert!(
block.ends_with(" -->\n\n<!-- END spec-driven-docs docs -->\n"),
"{block}"
);
assert!(!block.contains("\n\n\n"), "{block}");
}
}
#[test]
fn the_underscore_root_reaches_the_block() {
let block = render_block("_docs", &WritingStyle::default());
assert!(block.contains(
"Read the writing style before you author or edit prose: `sdd method writing-style`."
));
assert!(block.contains("`_docs/specs/SPEC-<domain>.md`"));
}
#[test]
fn every_instruction_item_carries_the_suppression_and_nothing_else_does() {
for selection in [
WritingStyle::default(),
WritingStyle {
source: WritingSource::Project,
path: Some("docs/STYLE.md".to_string()),
},
WritingStyle {
source: WritingSource::None,
path: None,
},
] {
let block = render_block("docs", &selection);
let mut items = 0;
for line in block.lines() {
if line.starts_with("- ") {
items += 1;
assert!(
line.ends_with(&format!(". {LINE_LENGTH_SUPPRESSION}")),
"{line}"
);
} else {
assert!(!line.contains(LINE_LENGTH_SUPPRESSION), "{line}");
}
assert_ne!(
line.trim(),
LINE_LENGTH_SUPPRESSION,
"an empty suppressed line"
);
}
assert!(items >= 7, "{block}");
}
let routed = render_block("docs", &WritingStyle::default());
assert!(routed.contains(&format!(
"- Read the writing style before you author or edit prose: `sdd method writing-style`. {LINE_LENGTH_SUPPRESSION}\n"
)));
}
#[test]
fn the_route_matches_each_selection() {
let project = WritingStyle {
source: WritingSource::Project,
path: Some("docs/STYLE.md".to_string()),
};
assert!(
render_block("docs", &project).contains(
"Read the writing style before you author or edit prose: `docs/STYLE.md`."
)
);
let none = WritingStyle {
source: WritingSource::None,
path: None,
};
let block = render_block("docs", &none);
assert!(!block.contains("writing style"), "{block}");
assert!(!block.contains("{writing_style}"));
assert!(
!block.contains("\n\n\n"),
"the removed route left a blank line:\n{block}"
);
}
}