m3taz-ahmed/aizee / skills/bmad-facilitate
bmad-facilitate
VerifiedCoaches the user through writing, updating or validating a document. Use when invoked by skill name only
| File | Kind | Size |
|---|---|---|
| SKILL.md | skill md | 21.0 KB |
| bmod.toml | config | 84 B |
| customize.toml | config | 2.4 KB |
| references/guidance-planning.md | markdown | 2.1 KB |
| references/rubric-general.md | markdown | 678 B |
| references/rubric-planning.md | markdown | 693 B |
| scripts/check_ids.py | script | 10.5 KB |
| scripts/render_view.py | script | 28.3 KB |
| scripts/tests/test_check_ids.py | script | 6.6 KB |
| scripts/tests/test_render_view.py | script | 11.6 KB |
scripts/tests/test_render_view.py
View on GitHub# /// script
# requires-python = ">=3.11"
# dependencies = ["pytest>=8.0"]
# ///
"""Tests for render_view.py. Run: uv run --with pytest pytest scripts/tests/test_render_view.py
The deterministic half of the view: what is stripped before rendering, the page title, how a
deck splits into slides with titles and speaker notes, how a view file's slots fill, which style
files are inlined, where the page is written, and the exit code for a missing document. Browser
behavior is not tested.
"""
import importlib.util
import json
import re
import sys
from pathlib import Path
_SPEC = importlib.util.spec_from_file_location("render_view", Path(__file__).resolve().parent.parent / "render_view.py")
render_view = importlib.util.module_from_spec(_SPEC)
sys.modules["render_view"] = render_view
_SPEC.loader.exec_module(render_view)
DECK = """---
title: "Measure first"
template: pitch-deck
view: slides
---
<!-- purpose: Move the room to measure first. -->
# Measure first
A talk for the meetup.
## Problem
<!-- required. Whose pain. -->
**CI took 40 minutes.**
- 300 engineers
> Ours was 40 minutes.
>
> Keep your hand up.
## Open questions
- Which tools?
> A quote that is the slide's content, mid-slide.
Closing line.
"""
def payload(page: str) -> dict:
return json.loads(re.search(r'id="view-data">(.*?)</script>', page, re.DOTALL).group(1))
def test_comments_and_frontmatter_stripped():
title, body = render_view.prepare(DECK)
assert title == "Measure first"
assert "<!--" not in body and "required. Whose pain" not in body
assert "template: pitch-deck" not in body
assert body.startswith("# Measure first")
def test_comments_inside_code_fences_kept():
text = "# T\n\n```html\n<!-- keep me -->\n```\n\n<!-- drop me -->\n"
_, body = render_view.prepare(text)
assert "<!-- keep me -->" in body
assert "drop me" not in body
def test_title_quotes_unwrapped():
assert render_view.frontmatter_title('title: "A \\"quoted\\" title"') == 'A "quoted" title'
assert render_view.frontmatter_title("title: 'It''s here'") == "It's here"
assert render_view.frontmatter_title("title: plain") == "plain"
assert render_view.frontmatter_title("template: x") == ""
def test_page_title_falls_back_to_h1_then_filename():
assert "<title>From the heading</title>" in render_view.render("# From the heading\n\ntext\n", "document")
assert "<title>my-doc</title>" in render_view.render("no heading\n", "document", name="my-doc")
assert "<title>A & B</title>" in render_view.render('---\ntitle: "A & B"\n---\n# x\n', "document")
def test_slides_split_on_h2_with_h1_first():
_, body = render_view.prepare(DECK)
slides = render_view.split_slides(body)
assert [s["section"] for s in slides] == ["Measure first", "Problem", "Open questions"]
assert slides[0]["title_slide"] and slides[0]["title"] == "Measure first"
assert slides[0]["body"] == "A talk for the meetup."
def test_table_of_contents_gets_no_slide():
text = "# T\n\n## Table of Contents\n\n- [Problem](#problem)\n\n## Problem\n\nPain.\n"
assert [s["section"] for s in render_view.split_slides(text)] == ["T", "Problem"]
def test_bold_first_line_becomes_title_and_heading_is_dropped():
_, body = render_view.prepare(DECK)
problem = render_view.split_slides(body)[1]
assert problem["title"] == "CI took 40 minutes."
assert problem["body"] == "- 300 engineers"
def test_heading_stays_title_without_bold_line():
slides = render_view.split_slides("## Team\n\n**Ana** and **Bo** lead it.\n")
assert slides[0]["title"] == "Team"
assert slides[0]["body"] == "**Ana** and **Bo** lead it."
def test_trailing_blockquote_becomes_notes():
_, body = render_view.prepare(DECK)
problem = render_view.split_slides(body)[1]
assert problem["notes"] == "Ours was 40 minutes.\n\nKeep your hand up."
assert ">" not in problem["body"]
def test_blockquote_before_more_content_is_not_notes():
_, body = render_view.prepare(DECK)
last = render_view.split_slides(body)[2]
assert last["notes"] == ""
assert "> A quote that is the slide's content" in last["body"]
def test_h2_inside_code_fence_does_not_split():
slides = render_view.split_slides("## One\n\n```md\n## not a slide\n```\n")
assert len(slides) == 1
assert "## not a slide" in slides[0]["body"]
def test_notes_stay_out_of_slide_markup():
page = render_view.render(DECK, "slides")
markup = page.split('id="view-data"')[0]
assert "Ours was 40 minutes" not in markup
assert payload(page)["slides"][1]["notes"].startswith("Ours was 40 minutes")
def test_embedded_markdown_cannot_close_the_script():
page = render_view.render("# T\n\n</script><script>alert(1)</script>\n", "document")
data_block = re.search(r'id="view-data">(.*?)</script>', page, re.DOTALL).group(1)
assert "</script" not in data_block
assert payload(page)["markdown"].startswith("# T")
def test_fallback_pre_escapes_markdown():
page = render_view.render("# T\n\n<b>raw</b>\n", "document")
assert '<pre class="fallback"># T\n\n<b>raw</b>\n</pre>' in page
def test_css_style_inlined_after_default(tmp_path):
css = tmp_path / "brand.css"
css.write_text("body { color: hotpink; }", encoding="utf-8")
page = render_view.render("# T\n", "document", render_view.load_style(str(css)))
assert page.index("hotpink") > page.index("--code-bg")
def test_non_css_style_ignored_with_warning(tmp_path, capsys):
guide = tmp_path / "voice.md"
guide.write_text("Write warmly.", encoding="utf-8")
assert render_view.load_style(str(guide)) == ""
assert "not a .css file" in capsys.readouterr().err
def test_empty_style_is_no_style(capsys):
assert render_view.load_style("") == ""
assert capsys.readouterr().err == ""
def test_default_output_path_and_stdout(tmp_path, capsys):
doc = tmp_path / "pm-1-deck.md"
doc.write_text(DECK, encoding="utf-8")
assert render_view.main([str(doc), "--layout", "slides"]) == 0
out = tmp_path / "pm-1-deck.html"
assert capsys.readouterr().out == f"{out}\n"
assert payload(out.read_text(encoding="utf-8"))["layout"] == "slides"
def test_out_option_creates_parent(tmp_path, capsys):
doc = tmp_path / "doc.md"
doc.write_text("# T\n", encoding="utf-8")
out = tmp_path / "views" / "view.html"
assert render_view.main([str(doc), "--out", str(out)]) == 0
assert out.is_file()
assert capsys.readouterr().out == f"{out}\n"
def test_missing_document_exits_2(tmp_path, capsys):
assert render_view.main([str(tmp_path / "absent.md")]) == 2
captured = capsys.readouterr()
assert captured.out == ""
assert "not found" in captured.err
def test_title_slide_keeps_the_document_title():
slides = render_view.split_slides(
"# How we cut CI\n**Measure before you optimize.**\n\n## Problem\n**Builds are slow.**\n"
)
assert slides[0]["title"] == "How we cut CI"
assert "Measure before you optimize." in slides[0]["body"]
assert slides[1]["title"] == "Builds are slow."
SHEET = """---
title: "Wren"
template: character
tagline: "Keeps every secret but her own"
class: ""
---
<!-- purpose: A character. -->
# Wren
## Table of Contents
- [Concept](#concept)
## Concept
<!-- required. -->
A smuggler who **cannot** lie.
## Secrets
```mermaid
graph LR
A --> B
```
## Arc
## Relationships
Owes the harbor master.
"""
VIEW = """<!doctype html>
<html><head><meta charset="utf-8"><title data-field="title">Sheet</title><style>h1 { color: red; }</style></head>
<body>
<br>
<img src="frame.png">
<h1 data-field="title">Name</h1>
<p class="tag" data-field="tagline"></p>
<p class="cls" data-field="class">Class</p>
<div class="a" data-section="Concept">placeholder</div>
<section class="b" data-section="secrets"><h2>Secrets</h2><div data-body></div></section>
<section class="c" data-section="Arc"><h2>Arc</h2><div data-body></div></section>
<section class="d" data-rest><p>leftovers</p></section>
</body></html>
"""
def test_section_slot_takes_the_section_body():
page, pieces, _ = render_view.fill_view(VIEW, SHEET)
assert "A smuggler who **cannot** lie." in pieces
assert "placeholder" not in page
assert '<div class="a" data-section="Concept"><div data-md="0">' in page
def test_section_names_match_without_case_and_body_child_keeps_the_label():
page, _, _ = render_view.fill_view(VIEW, SHEET)
assert re.search(r'<h2>Secrets</h2><div data-body><div data-md="\d+">', page)
def test_slot_for_an_empty_or_absent_section_is_removed_with_its_label():
page, _, _ = render_view.fill_view(VIEW, SHEET)
assert "<h2>Arc</h2>" not in page
absent = '<section data-section="Nowhere"><h2>Label</h2></section>'
assert "Label" not in render_view.fill_view(absent, SHEET)[0]
def test_field_slot_takes_the_frontmatter_value_escaped():
page, _, _ = render_view.fill_view('<i data-field="title"></i>', '---\ntitle: "A & <B>"\n---\n# x\n')
assert page == '<i data-field="title">A & <B></i>'
def test_title_field_falls_back_to_the_heading():
assert render_view.fill_view('<i data-field="title"></i>', "# Wren\n")[0] == '<i data-field="title">Wren</i>'
def test_empty_field_slot_is_removed():
page, _, _ = render_view.fill_view(VIEW, SHEET)
assert 'class="cls"' not in page
assert 'class="tag" data-field="tagline">Keeps every secret but her own<' in page
def test_rest_slot_takes_unclaimed_sections_with_their_headings():
page, pieces, unplaced = render_view.fill_view(VIEW, SHEET)
assert "## Relationships\n\nOwes the harbor master." in pieces
assert "leftovers" not in page
assert unplaced == []
assert not any("Table of Contents" in piece for piece in pieces)
def test_sections_with_no_slot_are_reported_without_a_rest_slot():
_, _, unplaced = render_view.fill_view('<div data-section="Concept"></div>', SHEET)
assert unplaced == ["Secrets", "Relationships"]
def test_field_inside_a_removed_section_does_not_disturb_the_page():
view = '<a><section data-section="Arc"><b data-field="title"></b></section></a><i data-section="Concept"></i>'
page, _, _ = render_view.fill_view(view, SHEET)
assert page.startswith('<a></a><i data-section="Concept"><div data-md="0">')
def test_view_keeps_its_own_markup_and_adds_no_default_css():
page = render_view.render_into_view(SHEET, VIEW)
assert "h1 { color: red; }" in page
assert "--code-bg" not in page
assert page.index('id="view-data"') < page.index("</body>")
assert payload(page)["layout"] == "view"
def test_view_payload_cannot_close_the_script():
page = render_view.render_into_view("# T\n\n## Concept\n\n</script>x\n", '<div data-section="Concept"></div>')
assert "</script" not in re.search(r'id="view-data">(.*?)</script>', page, re.DOTALL).group(1)
def test_css_style_goes_into_a_view(tmp_path):
page = render_view.render_into_view(SHEET, VIEW, "body { color: hotpink; }")
assert page.index("hotpink") < page.index("</head>")
def test_view_file_layout_writes_the_page(tmp_path, capsys):
doc = tmp_path / "character-wren.md"
doc.write_text(SHEET, encoding="utf-8")
view = tmp_path / "sheet.html"
view.write_text('<body><div data-section="Concept"></div></body>', encoding="utf-8")
assert render_view.main([str(doc), "--layout", str(view)]) == 0
captured = capsys.readouterr()
assert "no slot in sheet.html for: Secrets, Relationships" in captured.err
assert "A smuggler" in (tmp_path / "character-wren.html").read_text(encoding="utf-8")
def test_unknown_layout_exits_2(tmp_path, capsys):
doc = tmp_path / "doc.md"
doc.write_text("# T\n", encoding="utf-8")
assert render_view.main([str(doc), "--layout", "poster"]) == 2
assert "not a layout or an .html view file" in capsys.readouterr().err
Related skills
| Skill | Stars | Updated | Works with | Status | Install |
|---|---|---|---|---|---|
| reverse-engineer-anythingmorluto/reaReverse engineer native, managed, Electron/JavaScript, packaged, firmware, and browser targets with REA, and build agent environments (AgentEnv bundles) of web applications from a live instance or a capture, and of Linux desktop apps with a task from a request. Use shipped-artifact or requested runtime evidence to explain features, compare versions, decompile code, or guide a reconstruction. Skip REA for ordinary source-repository architecture analysis. | Stars: 472k | Updated | Claude CodeCodex | Verified | Install |
| diagnosing-superpowersobra/superpowersUse when a superpowers session went wrong and your human partner wants to know why — repeated work, ignored plans, stumbles, poor results, a skill that didn't fire, "it took too long", "why is it so expensive", "what is it doing" — or wants to build a bug report for the superpowers maintainers, for the current session or a past one identified by id or path, on any harness. | Stars: 322k | Updated | Claude CodeCodex | Verified | Install |
| dispatching-parallel-agentsobra/superpowersUse when facing 2+ independent tasks that can be worked on without shared state or sequential dependencies | Stars: 322k | Updated | Claude CodeCodex | Verified | Install |
| executing-plansobra/superpowersUse when executing an implementation plan in the current session as the implementer yourself — your human partner chose inline execution, or no subagent tool is available | Stars: 322k | Updated | Claude CodeCodex | Verified | Install |