Add failed action feedback rules
This commit is contained in:
@@ -0,0 +1,40 @@
|
||||
#!/usr/bin/env python3
|
||||
"""Verify player-facing failed-action feedback rules are documented."""
|
||||
|
||||
from pathlib import Path
|
||||
|
||||
|
||||
ROOT = Path(__file__).resolve().parents[1]
|
||||
DOC = ROOT / "Docs" / "KnowledgeAndSkillFoundation.md"
|
||||
ROADMAP = ROOT / "AGRARIAN_DEVELOPMENT_ROADMAP.md"
|
||||
|
||||
REQUIRED = {
|
||||
DOC: [
|
||||
"## Failed-Action And Poor-Result Feedback",
|
||||
"Feedback should identify:",
|
||||
"Message style:",
|
||||
"Say what happened.",
|
||||
"Name one likely cause.",
|
||||
"Offer one useful next step.",
|
||||
"Feedback rule:",
|
||||
],
|
||||
ROADMAP: [
|
||||
"[x] Add player-facing feedback that explains why an action failed or produced poor results.",
|
||||
],
|
||||
}
|
||||
|
||||
|
||||
def main() -> None:
|
||||
missing: list[str] = []
|
||||
for path, snippets in REQUIRED.items():
|
||||
text = path.read_text(encoding="utf-8")
|
||||
for snippet in snippets:
|
||||
if snippet not in text:
|
||||
missing.append(f"{path.relative_to(ROOT)} missing {snippet!r}")
|
||||
if missing:
|
||||
raise SystemExit("FAILED: " + "; ".join(missing))
|
||||
print("OK: failed-action feedback rules are documented.")
|
||||
|
||||
|
||||
if __name__ == "__main__":
|
||||
main()
|
||||
Reference in New Issue
Block a user