bmad-method-quarkus 1.0.0

package/src/core-skills/bmad-brainstorming/scripts/tests/test_brain.py

@@ -0,0 +1,239 @@
+# /// script
+# requires-python = ">=3.10"
+# dependencies = ["pytest>=8.0"]
+# ///
+"""Tests for brain.py. Run: uv run -m pytest scripts/tests/test_brain.py"""
+import json
+import sys
+from pathlib import Path
+
+import pytest
+
+sys.path.insert(0, str(Path(__file__).resolve().parent.parent))
+import brain  # noqa: E402
+
+CSV = """category,technique_name,description,detail
+collaborative,Yes And Building,Build on every idea with "yes and" to keep momentum,
+wild,Quantum Superposition,Hold contradictory ideas as simultaneously true,techniques/quantum.md
+structured,SCAMPER Method,Run the idea through seven transformation lenses,
+wild,Anti-Solution,Brainstorm how to make the problem worse then invert,
+"""
+
+DETAIL = "# Quantum Superposition\nFull multi-step instructions for the complex technique."
+
+
+@pytest.fixture
+def lib(tmp_path):
+    csv_path = tmp_path / "brain-methods.csv"
+    csv_path.write_text(CSV, encoding="utf-8")
+    (tmp_path / "techniques").mkdir()
+    (tmp_path / "techniques" / "quantum.md").write_text(DETAIL, encoding="utf-8")
+    return csv_path
+
+
+def test_load_normalizes_detail(lib):
+    rows = brain.load(lib)
+    assert len(rows) == 4
+    assert rows[0]["detail"] == ""
+    assert rows[1]["detail"] == "techniques/quantum.md"
+
+
+def test_categories_counts_sorted(lib):
+    assert brain.categories(brain.load(lib)) == [("collaborative", 1), ("structured", 1), ("wild", 2)]
+
+
+def test_filter_is_case_insensitive(lib):
+    rows = brain.filter_cats(brain.load(lib), ["WILD"])
+    assert {r["technique_name"] for r in rows} == {"Quantum Superposition", "Anti-Solution"}
+
+
+def test_filter_none_returns_all(lib):
+    assert len(brain.filter_cats(brain.load(lib), None)) == 4
+
+
+def test_find_hits_and_misses(lib):
+    found, missing = brain.find(brain.load(lib), ["scamper method", "Nope"])
+    assert [r["technique_name"] for r in found] == ["SCAMPER Method"]
+    assert missing == ["Nope"]
+
+
+def test_resolve_detail_present(lib):
+    row = next(r for r in brain.load(lib) if r["detail"])
+    assert "multi-step instructions" in brain.resolve_detail(row, lib.parent)
+
+
+def test_resolve_detail_absent_is_none(lib):
+    row = next(r for r in brain.load(lib) if not r["detail"])
+    assert brain.resolve_detail(row, lib.parent) is None
+
+
+def test_resolve_detail_missing_file_warns_not_fatal(lib, capsys):
+    rows = brain.load(lib)
+    rows[1]["detail"] = "techniques/gone.md"
+    assert brain.resolve_detail(rows[1], lib.parent) is None
+    assert "not found" in capsys.readouterr().err
+
+
+def test_show_inlines_detail(lib, capsys):
+    assert brain.main(["--file", str(lib), "show", "Quantum Superposition"]) == 0
+    out = capsys.readouterr().out
+    assert "multi-step instructions" in out and "[wild]" in out
+
+
+def test_show_simple_has_no_detail(lib, capsys):
+    brain.main(["--file", str(lib), "show", "SCAMPER Method"])
+    out = capsys.readouterr().out
+    assert "transformation lenses" in out
+
+
+def test_show_all_missing_returns_1(lib):
+    assert brain.main(["--file", str(lib), "show", "Ghost"]) == 1
+
+
+def test_list_filtered_text(lib, capsys):
+    brain.main(["--file", str(lib), "list", "--category", "structured"])
+    out = capsys.readouterr().out.strip().splitlines()
+    assert len(out) == 1 and out[0].startswith("structured\tSCAMPER Method\t")
+
+
+def test_list_bare_is_refused(lib, capsys):
+    # the footgun: bare `list` must NOT dump the catalog into context
+    assert brain.main(["--file", str(lib), "list"]) == 2
+    captured = capsys.readouterr()
+    assert captured.out == ""  # nothing leaked to stdout
+    assert "--category" in captured.err and "--all" in captured.err
+
+
+def test_list_all_dumps_everything(lib, capsys):
+    assert brain.main(["--file", str(lib), "list", "--all"]) == 0
+    out = capsys.readouterr().out.strip().splitlines()
+    assert len(out) == 4  # the deliberate full-catalog escape hatch
+
+
+def test_json_output(lib, capsys):
+    import json
+    brain.main(["--file", str(lib), "--json", "categories"])
+    data = json.loads(capsys.readouterr().out)
+    assert {"category": "wild", "count": 2} in data
+
+
+def test_random_respects_n_and_category(lib, capsys):
+    brain.main(["--file", str(lib), "random", "--category", "wild", "-n", "5"])
+    lines = capsys.readouterr().out.strip().splitlines()
+    assert len(lines) == 2  # only 2 wild exist, n capped
+    assert all(line.startswith("wild\t") for line in lines)
+
+
+def test_random_negative_n_does_not_crash(lib, capsys):
+    # a negative -n is clamped to 0, not passed to random.sample (which would raise)
+    assert brain.main(["--file", str(lib), "random", "-n", "-1"]) == 0
+    assert capsys.readouterr().out.strip() == ""
+
+
+def test_missing_file_returns_2(tmp_path):
+    assert brain.main(["--file", str(tmp_path / "nope.csv"), "categories"]) == 2
+
+
+# --- html selection page ------------------------------------------------
+
+def test_html_requires_out(lib, capsys):
+    # never dump the catalog to stdout — writing to a file is the whole point
+    assert brain.main(["--file", str(lib), "html"]) == 2
+    assert "--out" in capsys.readouterr().err
+
+
+def test_html_writes_selection_page(lib, tmp_path):
+    out = tmp_path / "sel.html"
+    assert brain.main(["--file", str(lib), "html", "--out", str(out)]) == 0
+    doc = out.read_text(encoding="utf-8")
+    assert doc.startswith("<!DOCTYPE html>")
+    assert "BMad Method Brainstorming Selection" in doc
+    for r in brain.load(lib):
+        assert r["technique_name"] in doc  # every technique is selectable
+    assert "&quot;yes and&quot;" in doc  # quotes in a description are escaped, not raw
+
+
+def test_html_creates_missing_parent(lib, tmp_path):
+    out = tmp_path / "nested" / "deep" / "sel.html"
+    assert brain.main(["--file", str(lib), "html", "--out", str(out)]) == 0
+    assert out.is_file()
+
+
+# --- --extra overlay (customize.toml additional_techniques) -------------
+
+EXTRA = (
+    '[{"category": "domain-specific", "technique_name": "Regulatory Inversion", '
+    '"description": "Start from the compliance constraint and brainstorm what it unlocks."}, '
+    '{"category": "wild", "technique_name": "Extra Wild One", "description": "An added wild method."}]'
+)
+
+
+@pytest.fixture
+def extra(tmp_path):
+    p = tmp_path / "extra.json"
+    p.write_text(EXTRA, encoding="utf-8")
+    return p
+
+
+def test_extra_merges_into_categories(lib, extra, capsys):
+    brain.main(["--file", str(lib), "--extra", str(extra), "categories"])
+    out = capsys.readouterr().out
+    assert "domain-specific\t1" in out  # a brand-new category appears
+    assert "wild\t3" in out  # the extra wild one is counted alongside the shipped two
+
+
+def test_extra_appears_in_list_and_random(lib, extra, capsys):
+    brain.main(["--file", str(lib), "--extra", str(extra), "list", "--category", "domain-specific"])
+    assert "Regulatory Inversion" in capsys.readouterr().out
+
+
+def test_extra_replaces_shipped_row_by_name(lib, extra, tmp_path, capsys):
+    shipped = brain.load(Path(lib))[0]
+    overlay = tmp_path / "replace.json"
+    overlay.write_text(
+        json.dumps([{"category": shipped["category"], "technique_name": shipped["technique_name"], "description": "RETUNED"}]),
+        encoding="utf-8",
+    )
+    brain.main(["--file", str(lib), "--extra", str(overlay), "list", "--all"])
+    out = capsys.readouterr().out
+    assert "RETUNED" in out
+    assert out.count(shipped["technique_name"]) == 1  # replaced, not duplicated
+
+
+def test_extra_malformed_exits_cleanly(lib, tmp_path, capsys):
+    bad = tmp_path / "bad.json"
+    for content in ('{not json', '{"a": 1}', '["not-an-object"]'):
+        bad.write_text(content, encoding="utf-8")
+        assert brain.main(["--file", str(lib), "--extra", str(bad), "categories"]) == 2
+        assert "could not read --extra" in capsys.readouterr().err
+
+
+def test_extra_is_first_class_in_html(lib, extra, tmp_path):
+    out = tmp_path / "sel.html"
+    assert brain.main(["--file", str(lib), "--extra", str(extra), "html", "--out", str(out)]) == 0
+    doc = out.read_text(encoding="utf-8")
+    # custom technique is selectable and its new category renders without crashing (fallback glyph/hue)
+    assert "Regulatory Inversion" in doc
+    assert "Domain Specific" in doc
+
+
+def test_extra_missing_file_returns_2(lib, tmp_path):
+    assert brain.main(["--file", str(lib), "--extra", str(tmp_path / "nope.json"), "categories"]) == 2
+
+
+def test_unknown_category_style_uses_fallback_glyph():
+    hue, glyph = brain.category_style("totally-made-up-category")
+    assert hue.startswith("#") and len(hue) == 7  # valid derived hex
+    assert glyph == brain._FALLBACK_GLYPH
+
+
+def test_shipped_selector_is_in_sync_with_catalog():
+    # foolproofing: if someone edits brain-methods.csv they must regenerate the page.
+    # Regenerate with: uv run brain.py html --out assets/brain-selector.html
+    asset = brain.DEFAULT_FILE.parent / "brain-selector.html"
+    assert asset.is_file(), "missing assets/brain-selector.html — generate it"
+    expected = brain.html_doc(brain.load(brain.DEFAULT_FILE))
+    assert asset.read_text(encoding="utf-8") == expected, (
+        "assets/brain-selector.html is stale; regenerate: "
+        "uv run brain.py html --out assets/brain-selector.html"
+    )

package/src/core-skills/bmad-customize/SKILL.md

@@ -0,0 +1,111 @@
+---
+name: bmad-customize
+description: Authors and updates customization overrides for installed BMad skills. Use when the user says 'customize bmad', 'override a skill', 'change agent behavior', or 'customize a workflow'.
+---
+
+# BMad Customize
+
+Translate the user's intent into a correctly-placed TOML override file under `{project-root}/_bmad/custom/` for a customizable agent or workflow skill. Discover, route, author, write, verify.
+
+Scope v1: per-skill `[agent]` overrides (`bmad-agent-<role>.toml` / `.user.toml`) and per-skill `[workflow]` overrides (`bmad-<workflow>.toml` / `.user.toml`). Central config (`{project-root}/_bmad/custom/config.toml`) is out of scope — point users at the [How to Customize BMad guide](https://docs.bmad-method.org/how-to/customize-bmad/).
+
+When the target's `customize.toml` doesn't expose what the user wants, say so plainly. Don't invent fields.
+
+## Preflight
+
+- No `{project-root}/_bmad/` → BMad isn't installed. Say so, stop.
+- `{project-root}/_bmad/scripts/resolve_customization.py` missing → continue, but Step 6 verify falls back to manual merge.
+- Both present → proceed.
+
+## Activation
+
+Load `_bmad/config.toml` and `_bmad/config.user.toml` from `{project-root}` for `user_name` (default `BMad`) and `communication_language` (default `English`). Greet. If the user's invocation already names a target skill AND a specific change, jump to Step 3.
+
+## Step 1: Classify intent
+
+- **Directed** — specific skill + specific change → Step 3.
+- **Exploratory** — "what can I customize?" → Step 2.
+- **Audit/iterate** — wants to review or change something already customized → Step 2, lead with skills that have existing overrides; read the existing override in Step 3 before composing.
+- **Cross-cutting** — could live on multiple surfaces → Step 3, choose agent vs workflow explicitly with the user.
+
+## Step 2: Discovery
+
+```
+uv run {skill-root}/scripts/list_customizable_skills.py --project-root {project-root}
+```
+
+Use `--extra-root <path>` (repeatable) if the user has skills installed in additional locations.
+
+Group the returned `agents` and `workflows` for the user; for each show name, description, whether `has_team_override` or `has_user_override` is true. Surface any `errors[]`. For audit/iterate intents, lead with already-overridden entries.
+
+Empty list: show `scanned_roots`, ask whether skills live elsewhere (offer `--extra-root`); otherwise stop.
+
+## Step 3: Determine the right surface
+
+Read the target's `customize.toml`. Top-level `[agent]` or `[workflow]` block defines the surface.
+
+If a team or user override already exists, read it first and summarize what's already overridden before composing.
+
+**Cross-cutting intent — walk both surfaces with the user:**
+- Every workflow a given agent runs → agent surface (e.g. `bmad-agent-pm.toml` with `persistent_facts`, `principles`).
+- One workflow only → workflow surface (e.g. `bmad-prd.toml` with `activation_steps_prepend`).
+- Several specific workflows → multiple workflow overrides in sequence, not an agent override.
+
+**Single-surface heuristic:**
+- Workflow-level: template swap, output path, step-specific behavior, or a named scalar already exposed (`*_template`, `on_complete`). Surgical, reliable.
+- Agent-level: persona, communication style, org-wide facts, menu changes, behavior that should apply to every workflow the agent dispatches.
+
+When ambiguous, present both with tradeoff, recommend one, let the user decide.
+
+Intent outside the exposed surface (step logic, ordering, anything not in `customize.toml`): say so; offer `activation_steps_prepend`/`append` or `persistent_facts` as approximations, or recommend `bmad-builder` to create a custom skill.
+
+## Step 4: Compose the override
+
+Translate plain-English into TOML against the target's `customize.toml` fields. If an existing override was read, frame the change as additive.
+
+Merge semantics:
+- **Scalars** (`icon`, `role`, `*_template`, `on_complete`) — override wins.
+- **Append arrays** (`persistent_facts`, `activation_steps_prepend`/`append`, `principles`) — team/user entries append in order.
+- **Keyed arrays of tables** (menu items with `code` or `id`) — matching keys replace, new keys append.
+
+Overrides are sparse: only the fields being changed. Never copy the whole `customize.toml`.
+
+**Template swap** (`*_template` scalar): offer to copy the default template to `{project-root}/_bmad/custom/{skill-name}-{purpose}-template.md`, point the override at the new path, offer to help edit it.
+
+## Step 5: Team or user placement
+
+Under `{project-root}/_bmad/custom/`:
+- `{skill-name}.toml` — team, committed. Policies, org conventions, compliance.
+- `{skill-name}.user.toml` — user, gitignored. Personal tone, private facts, shortcuts.
+
+Default by character (policy → team, personal → user), confirm before writing.
+
+## Step 6: Show, confirm, write, verify
+
+1. Show the full TOML. If the file exists, show a diff. Never silently overwrite.
+2. Wait for explicit yes.
+3. Write. Create `{project-root}/_bmad/custom/` if needed.
+4. Verify:
+   ```
+   uv run {project-root}/_bmad/scripts/resolve_customization.py --skill <install-path> --key <agent-or-workflow>
+   ```
+   Show the merged output, point out the changed fields.
+
+   **Resolver missing or fails:** read whichever layers exist — `<install-path>/customize.toml` (base), `{project-root}/_bmad/custom/{skill-name}.toml` (team), `{project-root}/_bmad/custom/{skill-name}.user.toml` (user) — apply base → team → user with the same merge rules (scalars override, tables deep-merge, `code`/`id`-keyed arrays merge by key, all other arrays append), describe how the changed fields resolve.
+
+   **Verify shows override didn't land** (field unchanged, merge conflict, file not picked up): re-enter Step 4 with the verify output as context. Usually wrong field name, wrong merge mode (scalar vs array), or wrong scope.
+5. Summarize what changed, where the file lives, how to iterate. Remind the user to commit team overrides.
+
+## Complete when
+
+- Override file written (or user explicitly aborted).
+- User has seen resolver output (or manual fallback merge summary).
+- User has acknowledged the summary.
+
+Otherwise the skill isn't done — finish or tell the user they're exiting incomplete.
+
+## When this skill can't help
+
+- **Central config** (`{project-root}/_bmad/custom/config.toml`) — see the [How to Customize BMad guide](https://docs.bmad-method.org/how-to/customize-bmad/).
+- **Step logic, ordering, behavior not in `customize.toml`** — open a feature request, or use `bmad-builder` to create a custom skill. Offer to help with either.
+- **Skills without a `customize.toml`** — not customizable.

package/src/core-skills/bmad-customize/scripts/list_customizable_skills.py

@@ -0,0 +1,231 @@
+#!/usr/bin/env python3
+# /// script
+# requires-python = ">=3.11"
+# ///
+"""Enumerate customizable BMad skills installed alongside this one.
+
+Scans a skills directory (by default: the directory this script's own skill
+lives in, derived from __file__), finds every sibling directory containing a
+`customize.toml`, classifies each as agent and/or workflow based on its
+top-level blocks, reads the skill's SKILL.md frontmatter description for a
+one-liner, and checks whether override files already exist in
+`{project-root}/_bmad/custom/`.
+
+Skills in BMad are loaded either from a project-local location (e.g. the
+project's `.claude/skills/` or `.cursor/skills/`) or from a user-global
+location (e.g. `~/.claude/skills/`). We do not hardcode those paths — the
+running skill's own location is the source of truth for sibling discovery.
+`--extra-root` is available for the rare case where skills live in multiple
+locations on the same machine.
+
+Output: JSON to stdout. Non-empty `errors[]` in the payload is non-fatal
+by contract — the scanner surfaces malformed TOML, missing roots, and
+skills with no customization block as data for the caller to display,
+and still exits 0. Exit 2 is reserved for invocation errors (e.g.
+missing or unreadable `--project-root`) where no useful payload can be
+produced.
+"""
+
+from __future__ import annotations
+
+import argparse
+import json
+import re
+import sys
+import tomllib
+from pathlib import Path
+
+# Top-level TOML blocks that indicate a customization surface.
+SURFACE_KEYS = ("agent", "workflow")
+
+FRONTMATTER_RE = re.compile(r"^---\s*\n(.*?)\n---\s*\n", re.DOTALL)
+
+
+def default_skills_root() -> Path:
+    """Derive the skills root from this script's location.
+
+    Layout assumption: {skills_root}/bmad-customize/scripts/list_customizable_skills.py.
+    So the skills root is three parents up from this file.
+    """
+    return Path(__file__).resolve().parent.parent.parent
+
+
+def read_frontmatter_description(skill_md: Path) -> str:
+    """Extract the `description:` value from a SKILL.md YAML frontmatter block.
+
+    Returns an empty string if the file is missing, unreadable, or has no
+    description field. Intentionally permissive — this is metadata for a
+    human-facing list, not a validation target.
+    """
+    if not skill_md.is_file():
+        return ""
+    try:
+        text = skill_md.read_text(encoding="utf-8")
+    except (OSError, UnicodeDecodeError):
+        return ""
+    m = FRONTMATTER_RE.match(text)
+    if not m:
+        return ""
+    for line in m.group(1).splitlines():
+        stripped = line.strip()
+        if stripped.startswith("description:"):
+            value = stripped[len("description:") :].strip()
+            # Strip surrounding quotes if present.
+            if (value.startswith("'") and value.endswith("'")) or (
+                value.startswith('"') and value.endswith('"')
+            ):
+                value = value[1:-1]
+            return value
+    return ""
+
+
+def load_customize(toml_path: Path) -> dict | None:
+    """Return the parsed TOML, or None if unreadable."""
+    try:
+        with toml_path.open("rb") as f:
+            return tomllib.load(f)
+    except (OSError, tomllib.TOMLDecodeError):
+        return None
+
+
+def scan_skills(
+    skills_roots: list[Path],
+    project_root: Path,
+) -> dict:
+    """Scan each skills root for directories that contain a customize.toml."""
+    agents: list[dict] = []
+    workflows: list[dict] = []
+    errors: list[str] = []
+    scanned_roots: list[str] = []
+    seen_names: set[str] = set()
+    custom_dir = project_root / "_bmad" / "custom"
+
+    for root in skills_roots:
+        if not root.is_dir():
+            errors.append(f"skills root does not exist: {root}")
+            continue
+        scanned_roots.append(str(root))
+
+        for skill_dir in sorted(p for p in root.iterdir() if p.is_dir()):
+            customize_toml = skill_dir / "customize.toml"
+            if not customize_toml.is_file():
+                continue
+
+            data = load_customize(customize_toml)
+            if data is None:
+                errors.append(f"failed to parse {customize_toml}")
+                continue
+
+            skill_name = skill_dir.name
+            # If a skill with this name was already found in an earlier
+            # root, skip it — roots are scanned in the order provided, so
+            # the first occurrence wins.
+            if skill_name in seen_names:
+                continue
+            seen_names.add(skill_name)
+
+            description = read_frontmatter_description(skill_dir / "SKILL.md")
+            team_override = custom_dir / f"{skill_name}.toml"
+            user_override = custom_dir / f"{skill_name}.user.toml"
+
+            entry_base = {
+                "name": skill_name,
+                "install_path": str(skill_dir),
+                "skills_root": str(root),
+                "description": description,
+                "has_team_override": team_override.is_file(),
+                "has_user_override": user_override.is_file(),
+                "team_override_path": str(team_override),
+                "user_override_path": str(user_override),
+            }
+
+            # A skill may expose an agent surface, a workflow surface, or
+            # both. Emit one entry per surface so the caller can group cleanly.
+            surfaces_found = [k for k in SURFACE_KEYS if k in data]
+            if not surfaces_found:
+                errors.append(
+                    f"no [agent] or [workflow] block in {customize_toml}"
+                )
+                continue
+            for surface in surfaces_found:
+                entry = dict(entry_base)
+                entry["surface"] = surface
+                if surface == "agent":
+                    agents.append(entry)
+                else:
+                    workflows.append(entry)
+
+    return {
+        "project_root": str(project_root),
+        "scanned_roots": scanned_roots,
+        "custom_dir": str(custom_dir),
+        "agents": agents,
+        "workflows": workflows,
+        "errors": errors,
+    }
+
+
+def parse_args(argv: list[str]) -> argparse.Namespace:
+    parser = argparse.ArgumentParser(
+        description=(
+            "List customizable BMad skills installed alongside this one, "
+            "grouped by surface (agent vs workflow), with override status "
+            "looked up against {project-root}/_bmad/custom/."
+        )
+    )
+    parser.add_argument(
+        "--project-root",
+        required=True,
+        help="Absolute path to the project root (the folder containing _bmad/).",
+    )
+    parser.add_argument(
+        "--skills-root",
+        default=None,
+        help=(
+            "Override the primary skills directory to scan. Defaults to the "
+            "directory this script's own skill lives in."
+        ),
+    )
+    parser.add_argument(
+        "--extra-root",
+        action="append",
+        default=[],
+        metavar="PATH",
+        help=(
+            "Additional skills directory to include (repeatable). Useful "
+            "when skills live in multiple locations on the same machine "
+            "(e.g. project-local plus a user-global install)."
+        ),
+    )
+    return parser.parse_args(argv)
+
+
+def main(argv: list[str]) -> int:
+    args = parse_args(argv)
+    project_root = Path(args.project_root).expanduser().resolve()
+    if not project_root.is_dir():
+        print(
+            f"error: project-root does not exist or is not a directory: {project_root}",
+            file=sys.stderr,
+        )
+        return 2
+
+    primary = (
+        Path(args.skills_root).expanduser().resolve()
+        if args.skills_root
+        else default_skills_root()
+    )
+    extras = [Path(p).expanduser().resolve() for p in args.extra_root]
+    # Deduplicate in order of appearance.
+    roots: list[Path] = []
+    for root in [primary, *extras]:
+        if root not in roots:
+            roots.append(root)
+
+    result = scan_skills(roots, project_root)
+    print(json.dumps(result, indent=2, sort_keys=True))
+    return 0
+
+
+if __name__ == "__main__":
+    sys.exit(main(sys.argv[1:]))