bmad-method 6.7.0 → 6.7.1-next.1
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/package.json +1 -1
- package/src/bmm-skills/1-analysis/bmad-product-brief/SKILL.md +1 -1
- package/src/bmm-skills/2-plan-workflows/bmad-agent-ux-designer/customize.toml +1 -1
- package/src/bmm-skills/2-plan-workflows/bmad-prd/SKILL.md +5 -3
- package/src/bmm-skills/2-plan-workflows/bmad-prd/assets/prd-template.md +4 -7
- package/src/bmm-skills/2-plan-workflows/bmad-prd/assets/prd-validation-checklist.md +4 -4
- package/src/bmm-skills/2-plan-workflows/bmad-prd/references/headless.md +2 -2
- package/src/bmm-skills/2-plan-workflows/bmad-ux/SKILL.md +87 -0
- package/src/bmm-skills/2-plan-workflows/bmad-ux/assets/color-themes.md +9 -0
- package/src/bmm-skills/2-plan-workflows/bmad-ux/assets/design-directions.md +9 -0
- package/src/bmm-skills/2-plan-workflows/bmad-ux/assets/design-example-editorial.md +158 -0
- package/src/bmm-skills/2-plan-workflows/bmad-ux/assets/design-example-mobile.md +93 -0
- package/src/bmm-skills/2-plan-workflows/bmad-ux/assets/design-example-shadcn.md +109 -0
- package/src/bmm-skills/2-plan-workflows/bmad-ux/assets/excalidraw-wireframe.md +19 -0
- package/src/bmm-skills/2-plan-workflows/bmad-ux/assets/experience-example-mobile.md +112 -0
- package/src/bmm-skills/2-plan-workflows/bmad-ux/assets/experience-example-shadcn.md +133 -0
- package/src/bmm-skills/2-plan-workflows/bmad-ux/assets/headless-schemas.md +84 -0
- package/src/bmm-skills/2-plan-workflows/bmad-ux/assets/key-screens.md +29 -0
- package/src/bmm-skills/2-plan-workflows/bmad-ux/assets/validation-report-template.html +319 -0
- package/src/bmm-skills/2-plan-workflows/bmad-ux/customize.toml +100 -0
- package/src/bmm-skills/2-plan-workflows/bmad-ux/references/creative-tools.md +19 -0
- package/src/bmm-skills/2-plan-workflows/bmad-ux/references/design-md-spec.md +50 -0
- package/src/bmm-skills/2-plan-workflows/bmad-ux/references/headless.md +37 -0
- package/src/bmm-skills/2-plan-workflows/bmad-ux/references/validate.md +115 -0
- package/src/bmm-skills/module-help.csv +1 -1
- package/tools/installer/core/installer.js +100 -23
- package/tools/installer/ide/_config-driven.js +2 -2
- package/tools/installer/ui.js +51 -0
- package/tools/skill-validator.md +1 -19
- package/tools/validate-skills.js +1 -40
- package/src/bmm-skills/2-plan-workflows/bmad-create-ux-design/SKILL.md +0 -75
- package/src/bmm-skills/2-plan-workflows/bmad-create-ux-design/customize.toml +0 -41
- package/src/bmm-skills/2-plan-workflows/bmad-create-ux-design/steps/step-01-init.md +0 -135
- package/src/bmm-skills/2-plan-workflows/bmad-create-ux-design/steps/step-01b-continue.md +0 -127
- package/src/bmm-skills/2-plan-workflows/bmad-create-ux-design/steps/step-02-discovery.md +0 -190
- package/src/bmm-skills/2-plan-workflows/bmad-create-ux-design/steps/step-03-core-experience.md +0 -217
- package/src/bmm-skills/2-plan-workflows/bmad-create-ux-design/steps/step-04-emotional-response.md +0 -220
- package/src/bmm-skills/2-plan-workflows/bmad-create-ux-design/steps/step-05-inspiration.md +0 -235
- package/src/bmm-skills/2-plan-workflows/bmad-create-ux-design/steps/step-06-design-system.md +0 -253
- package/src/bmm-skills/2-plan-workflows/bmad-create-ux-design/steps/step-07-defining-experience.md +0 -255
- package/src/bmm-skills/2-plan-workflows/bmad-create-ux-design/steps/step-08-visual-foundation.md +0 -225
- package/src/bmm-skills/2-plan-workflows/bmad-create-ux-design/steps/step-09-design-directions.md +0 -225
- package/src/bmm-skills/2-plan-workflows/bmad-create-ux-design/steps/step-10-user-journeys.md +0 -242
- package/src/bmm-skills/2-plan-workflows/bmad-create-ux-design/steps/step-11-component-strategy.md +0 -249
- package/src/bmm-skills/2-plan-workflows/bmad-create-ux-design/steps/step-12-ux-patterns.md +0 -238
- package/src/bmm-skills/2-plan-workflows/bmad-create-ux-design/steps/step-13-responsive-accessibility.md +0 -265
- package/src/bmm-skills/2-plan-workflows/bmad-create-ux-design/steps/step-14-complete.md +0 -177
- package/src/bmm-skills/2-plan-workflows/bmad-create-ux-design/ux-design-template.md +0 -13
|
@@ -0,0 +1,100 @@
|
|
|
1
|
+
# DO NOT EDIT -- overwritten on every update.
|
|
2
|
+
#
|
|
3
|
+
# Workflow customization surface for bmad-ux.
|
|
4
|
+
# Overrides:
|
|
5
|
+
# {project-root}/_bmad/custom/bmad-ux.toml (team)
|
|
6
|
+
# {project-root}/_bmad/custom/bmad-ux.user.toml (personal)
|
|
7
|
+
# Merge rules: scalars override, arrays append.
|
|
8
|
+
|
|
9
|
+
[workflow]
|
|
10
|
+
|
|
11
|
+
# Steps to run before/after standard activation. Append-only.
|
|
12
|
+
activation_steps_prepend = []
|
|
13
|
+
activation_steps_append = []
|
|
14
|
+
|
|
15
|
+
# Persistent facts loaded at activation and kept in mind for the run.
|
|
16
|
+
# Entries: literal sentence, `skill:NAME`, or `file:PATH` (glob ok).
|
|
17
|
+
persistent_facts = [
|
|
18
|
+
"file:{project-root}/**/project-context.md",
|
|
19
|
+
]
|
|
20
|
+
|
|
21
|
+
# Runs at workflow completion. String or array of instructions.
|
|
22
|
+
on_complete = ""
|
|
23
|
+
|
|
24
|
+
# Reference DESIGN.md spines the distillation subagent reads to anchor shape
|
|
25
|
+
# and editorial richness. Convention-compliant with the Google Labs DESIGN.md
|
|
26
|
+
# spec (https://github.com/google-labs-code/design.md). Append entries via
|
|
27
|
+
# override TOML to seed an org-specific canonical aesthetic.
|
|
28
|
+
# Each entry: `file:PATH` (or bare relative path, resolved skill-relative).
|
|
29
|
+
design_md_examples = [
|
|
30
|
+
"assets/design-example-mobile.md",
|
|
31
|
+
"assets/design-example-shadcn.md",
|
|
32
|
+
"assets/design-example-editorial.md",
|
|
33
|
+
]
|
|
34
|
+
|
|
35
|
+
# Reference EXPERIENCE.md spines for the behavioral/flow/IA layer. Each entry:
|
|
36
|
+
# `file:PATH` (or bare relative path, resolved skill-relative).
|
|
37
|
+
experience_md_examples = [
|
|
38
|
+
"assets/experience-example-mobile.md",
|
|
39
|
+
"assets/experience-example-shadcn.md",
|
|
40
|
+
]
|
|
41
|
+
|
|
42
|
+
# Design handoff targets — external tools that can take over the design /
|
|
43
|
+
# visual identity work. The user runs the tool externally and saves outputs
|
|
44
|
+
# (whatever the tool produces — DESIGN.md, Figma files, React components,
|
|
45
|
+
# HTML mocks) to {doc_workspace}.
|
|
46
|
+
# Each entry: `tool:NAME: <directive>`, `skill:NAME`, or plain-text descriptor.
|
|
47
|
+
# Default: Google Stitch (emits DESIGN.md + per-screen HTML). Other producers:
|
|
48
|
+
# Vercel v0, Figma, Galileo, Anima, internal generators.
|
|
49
|
+
design_handoffs = [
|
|
50
|
+
"Google Stitch (https://stitch.withgoogle.com) — emits DESIGN.md + per-screen HTML. Paste assembled prompt; save outputs to {doc_workspace}.",
|
|
51
|
+
]
|
|
52
|
+
|
|
53
|
+
# HTML skeleton filled in by the validation synthesis pass.
|
|
54
|
+
validation_report_template = "assets/validation-report-template.html"
|
|
55
|
+
|
|
56
|
+
# Run folder. DESIGN.md, EXPERIENCE.md, .decision-log.md, .working/
|
|
57
|
+
# (creative-tool artifacts), imports/ (user-supplied screens / brand decks /
|
|
58
|
+
# Figma exports / sketches), optional mockups/ and wireframes/ (promoted
|
|
59
|
+
# artifacts), optional validation-report.* all land inside
|
|
60
|
+
# {ux_output_path}/{run_folder_pattern}/.
|
|
61
|
+
ux_output_path = "{planning_artifacts}/ux-designs"
|
|
62
|
+
run_folder_pattern = "ux-{project_name}-{date}"
|
|
63
|
+
|
|
64
|
+
# Creative tools registry. Collaborative renderers invoked on demand during
|
|
65
|
+
# Discovery and at Finalize. Entry forms: `file:PATH`, `skill:NAME`,
|
|
66
|
+
# `tool:MCP_TOOL: <directive>`, or plain text. Defaults ship for HTML color
|
|
67
|
+
# themes, HTML design directions, Excalidraw wireframes (Discovery), and
|
|
68
|
+
# 1:1 HTML key-screen mockups (Finalize). Working artifacts land in
|
|
69
|
+
# {doc_workspace}/.working/; finalize promotes those with lasting reference
|
|
70
|
+
# value to mockups/ or wireframes/. See references/creative-tools.md.
|
|
71
|
+
creative_tools = [
|
|
72
|
+
"file:assets/color-themes.md",
|
|
73
|
+
"file:assets/design-directions.md",
|
|
74
|
+
"file:assets/excalidraw-wireframe.md",
|
|
75
|
+
"file:assets/key-screens.md",
|
|
76
|
+
]
|
|
77
|
+
|
|
78
|
+
# Polish passes applied to DESIGN.md and EXPERIENCE.md at finalize.
|
|
79
|
+
# Entries: `skill:NAME`, `file:PATH`, or plain text directive.
|
|
80
|
+
# Suggested order: structural → content/voice → prose mechanics.
|
|
81
|
+
doc_standards = [
|
|
82
|
+
"skill:bmad-editorial-review-structure",
|
|
83
|
+
"skill:bmad-editorial-review-prose",
|
|
84
|
+
]
|
|
85
|
+
|
|
86
|
+
# Information retrieval registry. Consulted on demand when the conversation
|
|
87
|
+
# surfaces a matching need. Distinct from creative_tools (artifact production).
|
|
88
|
+
# Example: "When researching component patterns, consult corp:design_system_search."
|
|
89
|
+
external_sources = []
|
|
90
|
+
|
|
91
|
+
# Routes outputs beyond local files at Finalize. Returned URLs/IDs surfaced
|
|
92
|
+
# to the user. Unavailable tools skipped and flagged.
|
|
93
|
+
# Example: "Upload DESIGN.md to Confluence via corp:confluence_upload (space_key='DESIGN')."
|
|
94
|
+
external_handoffs = []
|
|
95
|
+
|
|
96
|
+
# Reviewers spawned at Finalize step 4 and at Validate intent, alongside
|
|
97
|
+
# the rubric walker. Entries: `skill:NAME`, `file:PATH`, or plain text.
|
|
98
|
+
# Common ad-hoc add (judged by the skill): accessibility-focused reviewer
|
|
99
|
+
# for consumer / regulated work.
|
|
100
|
+
finalize_reviewers = []
|
|
@@ -0,0 +1,19 @@
|
|
|
1
|
+
# Creative Tools
|
|
2
|
+
|
|
3
|
+
`{workflow.creative_tools}` is a registry of collaborative renderers invoked on demand when seeing options helps the user decide. Entries follow the standard prefix convention: `skill:NAME`, `file:PATH`, `tool:MCP_TOOL_NAME: <directive>`, or plain-text directive.
|
|
4
|
+
|
|
5
|
+
Defaults ship for HTML color themes, HTML design directions, Excalidraw wireframes (Discovery), and 1:1 HTML key-screen mocks (Finalize). Teams append more via override TOML — Figma MCP, custom skills, prompt-based mood boards.
|
|
6
|
+
|
|
7
|
+
## When to invoke
|
|
8
|
+
|
|
9
|
+
Decision moments where a visual beats more conversation: picking color tokens, picking a visual personality among directions, sketching IA, mocking a tricky flow. Fast-path users typically skip; coaching-path users typically lean in. Read the room.
|
|
10
|
+
|
|
11
|
+
## Artifact handling
|
|
12
|
+
|
|
13
|
+
Every renderer writes to `{doc_workspace}/.working/` with a descriptive filename. `.working/` is the audit trail and survives the run. At Finalize, the facilitator walks `.working/` with the user and promotes artifacts with lasting reference value to `{doc_workspace}/mockups/` (HTML anchoring a brand or layout decision) or `{doc_workspace}/wireframes/` (Excalidraw a dev would glance at). Bar for promotion: *would a future reader of `DESIGN.md` or `EXPERIENCE.md` open this?* Default is leave-in-`.working/`.
|
|
14
|
+
|
|
15
|
+
## Renderer contract
|
|
16
|
+
|
|
17
|
+
The parent passes the subagent: current `.decision-log.md`, relevant prior `.working/` captures, the user's stated intent for this pass, the output path. The subagent writes its artifact under `.working/` and returns ONLY a compact summary (file path, one line per variant, mode coverage). Parent never holds the full payload.
|
|
18
|
+
|
|
19
|
+
For HTML, open in browser when interactive: `python3 -c "import webbrowser, pathlib; webbrowser.open(pathlib.Path('PATH').resolve().as_uri())"`. Skip in headless.
|
|
@@ -0,0 +1,50 @@
|
|
|
1
|
+
# DESIGN.md Spec — Working Reference
|
|
2
|
+
|
|
3
|
+
Source of truth: [google-labs-code/design.md](https://github.com/google-labs-code/design.md) (Apache 2.0, Google Labs, April 2026). This file is a working summary; the URL wins on conflict.
|
|
4
|
+
|
|
5
|
+
## Structure
|
|
6
|
+
|
|
7
|
+
YAML frontmatter (machine-readable tokens) + markdown body (human-readable rationale, prose sections).
|
|
8
|
+
|
|
9
|
+
## Frontmatter tokens
|
|
10
|
+
|
|
11
|
+
| Key | Type | Notes |
|
|
12
|
+
|---|---|---|
|
|
13
|
+
| `name` | string | Required. Brand or system name. |
|
|
14
|
+
| `description` | string | One-line statement of what this system is. |
|
|
15
|
+
| `colors` | flat object | Kebab-case keys. Values are hex strings (`'#FBF9F4'`). |
|
|
16
|
+
| `typography` | nested object | Each value: an object with any subset of `fontFamily`, `fontSize`, `fontWeight`, `lineHeight`, `letterSpacing`. |
|
|
17
|
+
| `rounded` | object | Scale names (`sm`, `md`, `lg`, `xl`, `full`, `DEFAULT`) → CSS dimensions. `full` is conventionally `9999px`. |
|
|
18
|
+
| `spacing` | object | Scale levels (`'1'`, `'2'`, ...) or named tokens (`gutter`, `margin-mobile`, `editorial-gap`) → dimensions. |
|
|
19
|
+
| `components` | object | Component-name → object of component tokens mapped to values or `{path.to.token}` references. |
|
|
20
|
+
|
|
21
|
+
## Body sections (omittable, order-locked when present)
|
|
22
|
+
|
|
23
|
+
1. **Brand & Style** — Aesthetic posture in prose. The editorial voice — what *kind* of thing this is.
|
|
24
|
+
2. **Colors** — Per-color story. Why each exists, where it's used, what it's *not* used for.
|
|
25
|
+
3. **Typography** — Type roles, ramp, and rules. Platform conventions noted semantically when inherited.
|
|
26
|
+
4. **Layout & Spacing** — Spacing scale narrative, grid behavior, margins, gutters, breakpoint rules.
|
|
27
|
+
5. **Elevation & Depth** — Shadow language and tonal layering rules.
|
|
28
|
+
6. **Shapes** — Corner radii rules and the aesthetic logic behind them.
|
|
29
|
+
7. **Components** — Per-component visual specs: anatomy, color usage, sizing, state appearance.
|
|
30
|
+
8. **Do's and Don'ts** — Hard visual rules — what to do, what to avoid.
|
|
31
|
+
|
|
32
|
+
Sections may be omitted when not relevant; order is locked when present.
|
|
33
|
+
|
|
34
|
+
## Cross-reference syntax
|
|
35
|
+
|
|
36
|
+
`{path.to.token}` used in prose and inside component objects to reference frontmatter tokens. Examples:
|
|
37
|
+
|
|
38
|
+
- `{colors.primary}`
|
|
39
|
+
- `{typography.body.fontSize}`
|
|
40
|
+
- `{rounded.md}`
|
|
41
|
+
- `{spacing.4}`
|
|
42
|
+
|
|
43
|
+
The path follows the YAML structure.
|
|
44
|
+
|
|
45
|
+
## Common patterns
|
|
46
|
+
|
|
47
|
+
- **Light/dark mode.** Either separate kebab-case tokens (`surface-base` / `surface-base-dark`) or separate DESIGN.md files per mode. The spec allows either; pick the form that reads cleanest for the product.
|
|
48
|
+
- **Platform conventions.** When inheriting from native platforms (iOS UIKit, Android Compose, Apple Human Interface Guidelines), use a `note` field instead of literal values: `{ note: 'iOS Title 1 · Android Headline Small' }`. The spec is the spec; the platform owns the rendered values.
|
|
49
|
+
- **UI-system inheritance.** When inheriting from shadcn / MUI / Tailwind / internal design system, reference the system's tokens by name rather than restating values. DESIGN.md specifies only the deltas (brand color overrides, typography swaps, component customizations).
|
|
50
|
+
- **Component tokens.** The `components` frontmatter entry maps each named component (e.g., `button-primary`) to its specific token values. Use `{path.to.token}` references freely; the resolver flattens at consumption time.
|
|
@@ -0,0 +1,37 @@
|
|
|
1
|
+
# Headless Mode
|
|
2
|
+
|
|
3
|
+
Load this file when invoked headless. Follow it for the whole run.
|
|
4
|
+
|
|
5
|
+
## Detection
|
|
6
|
+
|
|
7
|
+
Headless when any of: caller sets `headless: true` (or harness equivalent); invocation is from another skill or non-interactive runner; `{workflow.activation_steps_prepend}` declares it; first message is an automation context pre-supplying inputs. Ambiguous → default interactive.
|
|
8
|
+
|
|
9
|
+
## Inputs
|
|
10
|
+
|
|
11
|
+
Free-form structured payload in the first message:
|
|
12
|
+
|
|
13
|
+
- `intent` — `"create"`, `"update"`, or `"validate"`. If absent, infer from the artifact set.
|
|
14
|
+
- **Create**: any source spec (PRD, brief, requirements list, design-thinking output, prior UX — text, path, or URL) plus brand / platform / accessibility notes; `doc_workspace` if a specific run folder is required.
|
|
15
|
+
- **Update**: existing workspace containing `DESIGN.md` + `EXPERIENCE.md` (or path to either) + change signal.
|
|
16
|
+
- **Validate**: existing workspace containing `DESIGN.md` + `EXPERIENCE.md` (or path to either). Workspace defaults to the spines' containing directory.
|
|
17
|
+
|
|
18
|
+
Inferences → `assumptions[]`. Gaps needing a human decision → `open_questions[]`. Do not invent persona, brand, accessibility, or scope detail.
|
|
19
|
+
|
|
20
|
+
Creative tools default off in headless. Caller can override; artifacts land in `.working/` and are not promoted unless the caller signals.
|
|
21
|
+
|
|
22
|
+
## Behavior
|
|
23
|
+
|
|
24
|
+
Do not ask. Do not greet. Complete the intent from what's provided, what exists in `{doc_workspace}`, or what you can discover. If intent stays ambiguous after inference, halt with `status: "blocked"` and a one-sentence `reason`.
|
|
25
|
+
|
|
26
|
+
`status`:
|
|
27
|
+
- `"complete"` — stands on its own.
|
|
28
|
+
- `"partial"` — artifact produced but `open_questions[]` non-empty or critical inputs inferred.
|
|
29
|
+
- `"blocked"` — no artifact produced.
|
|
30
|
+
|
|
31
|
+
End with JSON matching `assets/headless-schemas.md`. `intent` reflects detected intent. Omit keys for artifacts not produced.
|
|
32
|
+
|
|
33
|
+
## Mode-specific overrides
|
|
34
|
+
|
|
35
|
+
**Update.** Apply the change. Log to `.decision-log.md` with rationale. Surface conflicts in `conflicts_with_prior_decisions[]`.
|
|
36
|
+
|
|
37
|
+
**Validate.** Always write both `validation-report.html` and `validation-report.md` regardless of finding count. Always include `"offer_to_update": true`. Skip the browser-open step.
|
|
@@ -0,0 +1,115 @@
|
|
|
1
|
+
# Validate
|
|
2
|
+
|
|
3
|
+
Critique an existing spine pair (`DESIGN.md` + `EXPERIENCE.md`) or any format of UX the user provides, without changing it. The synthesis pipeline below is also used at the Reviewer Gate during Create / Update Finalize.
|
|
4
|
+
|
|
5
|
+
## Orient
|
|
6
|
+
|
|
7
|
+
Subagent-extract from `.decision-log.md`, sources in frontmatter, `imports/`, `mockups/`, `wireframes/`, `DESIGN.md`, `EXPERIENCE.md`. Parent assembles from extracts.
|
|
8
|
+
|
|
9
|
+
## Reviewer Gate
|
|
10
|
+
|
|
11
|
+
**Opt-in.** Reviewers are costly. At Finalize, ask first if the user wants to run UX validation with multiple subagent lenses. Default offered, easy skip. At Validate intent, skip that question, the user already invoked it.
|
|
12
|
+
|
|
13
|
+
**Lens menu.** UNLESS HEADLESS MODE: Always present the lens picks before dispatching. Build the menu from: rubric walker (this file) + `{workflow.finalize_reviewers}` + ad-hoc reviewers the skill judges relevant. The user picks all, a subset, or none. Only picked lenses dispatch.
|
|
14
|
+
|
|
15
|
+
Rubric walker prompt:
|
|
16
|
+
|
|
17
|
+
> Validate the spine pair (`DESIGN.md` + `EXPERIENCE.md`) as the contract for downstream consumers (architecture, story-dev — human or AI). Can a consumer source-extract cleanly, with every reference resolving and every load-bearing decision committed? Read `{workflow.design_md_examples}` and `{workflow.experience_md_examples}` first.
|
|
18
|
+
>
|
|
19
|
+
> **Pass 1 — mechanical coverage.** Per category: extract, then list misses with location citations. No misses = **strong**.
|
|
20
|
+
>
|
|
21
|
+
> 1. **Flow coverage** (EXPERIENCE.md). Sources frontmatter → extract every UJ / requirement name. Verify each has a Key Flow with named protagonist, numbered steps, a climax beat, and a failure path where applicable.
|
|
22
|
+
>
|
|
23
|
+
> 2. **Token completeness** (DESIGN.md). Extract every token in the YAML frontmatter and every `{path.to.token}` reference in the prose. Verify each defined (see `references/design-md-spec.md` for type rules). **Color tokens missing hex (or light/dark pairs where applicable) are critical** — downstream code mirrors the spine. Platform conventions (native dynamic type, 8pt grid) may stay semantic. Contrast targets stated for load-bearing combinations.
|
|
24
|
+
>
|
|
25
|
+
> 3. **Component coverage** (both spines). Extract every component name used anywhere. Verify each has a row in DESIGN.md.Components (visual spec) *and* EXPERIENCE.md.Component Patterns (behavioral spec) — real rules, not one-word descriptions.
|
|
26
|
+
>
|
|
27
|
+
> 4. **State coverage** (EXPERIENCE.md). Walk every IA surface. List states it should have (empty, cold-load, focus, error, offline, permission-denied — whichever apply). Verify each covered.
|
|
28
|
+
>
|
|
29
|
+
> 5. **Visual reference coverage.** List every file in `mockups/`, `wireframes/`, `imports/`. Spines link to each inline at the relevant section and name what it illustrates; spines-win-on-conflict stated once. List orphans and unspecific references.
|
|
30
|
+
>
|
|
31
|
+
> **Pass 2 — judgment.** Verdict per category (*strong / adequate / thin / broken*); findings only where they add information.
|
|
32
|
+
>
|
|
33
|
+
> 6. **Bloat & overspecification.** Pixel specs where tokens cover it; source restatement (personas, FRs, scope); prose where a table works; sections no downstream consumer would read; decorative narrative untied to a decision. DESIGN.md prose may carry editorial voice; EXPERIENCE.md prose should not.
|
|
34
|
+
>
|
|
35
|
+
> 7. **Inheritance discipline.** `sources` frontmatter resolves. UJ / requirement names verbatim from sources. Glossary identical across spines and sources. Component names identical across all sections in both files. EXPERIENCE.md token references resolve to DESIGN.md tokens by name.
|
|
36
|
+
>
|
|
37
|
+
> 8. **Shape fit.** DESIGN.md sections in canonical order (Brand & Style → Colors → Typography → Layout & Spacing → Elevation & Depth → Shapes → Components → Do's and Don'ts; omittable but order-locked when present). EXPERIENCE.md required defaults present (Foundation, IA, Voice and Tone, Component Patterns, State Patterns, Interaction Primitives, Accessibility Floor, Key Flows). Dropped defaults defensible. Required-when-applicable present where triggered (Inspiration when sources / log show reference products or rejects; Responsive when multi-surface or breakpoints). Invented sections earn their place.
|
|
38
|
+
>
|
|
39
|
+
> Severity = downstream impact, not fix difficulty.
|
|
40
|
+
>
|
|
41
|
+
> Write to `{doc_workspace}/review-rubric.md`:
|
|
42
|
+
>
|
|
43
|
+
> ```markdown
|
|
44
|
+
> # Spine Pair Review — {project_name}
|
|
45
|
+
>
|
|
46
|
+
> ## Overall verdict
|
|
47
|
+
> [2–3 sentences]
|
|
48
|
+
>
|
|
49
|
+
> ## 1. Flow coverage — [verdict]
|
|
50
|
+
> [What was checked.]
|
|
51
|
+
> ### Findings
|
|
52
|
+
> - **[critical|high|medium|low]** [finding] (location). *Fix:* [suggestion].
|
|
53
|
+
>
|
|
54
|
+
> (repeat 2–8)
|
|
55
|
+
>
|
|
56
|
+
> ## Mechanical notes
|
|
57
|
+
> [Name inconsistencies, broken cross-refs, frontmatter completeness, Mermaid syntax.]
|
|
58
|
+
> ```
|
|
59
|
+
>
|
|
60
|
+
> Return ONLY a compact summary: overall verdict, per-section verdicts, finding counts by severity, file path.
|
|
61
|
+
|
|
62
|
+
The gate may dispatch `{workflow.finalize_reviewers}` and ad-hoc reviewers (accessibility for consumer / regulated). Each writes `review-{slug}.md` and returns a compact summary. Parallel.
|
|
63
|
+
|
|
64
|
+
## Synthesis pipeline
|
|
65
|
+
|
|
66
|
+
Under Validate intent, after every reviewer returns, render one consolidated report. Don't skip.
|
|
67
|
+
|
|
68
|
+
1. Read every `{doc_workspace}/review-*.md`.
|
|
69
|
+
2. Fill `{workflow.validation_report_template}`. No overall grade — the per-category verdicts and severity counts already say what's true. Synthesis paragraph lifts the rubric's overall verdict; add a second if extra reviewers shift the picture. One section per rubric category (open if thin / broken), one per extra reviewer (closed, adversarial voice preserved).
|
|
70
|
+
3. Write `{doc_workspace}/validation-report.html`.
|
|
71
|
+
4. Write the Markdown twin `{doc_workspace}/validation-report.md` — same content grouped by severity.
|
|
72
|
+
5. Open HTML: `python3 -c "import webbrowser, pathlib; webbrowser.open(pathlib.Path('{doc_workspace}/validation-report.html').resolve().as_uri())"`. Skip headless.
|
|
73
|
+
|
|
74
|
+
Re-running overwrites the consolidated report; individual `review-*.md` files persist.
|
|
75
|
+
|
|
76
|
+
## Markdown twin shape
|
|
77
|
+
|
|
78
|
+
```markdown
|
|
79
|
+
# Validation Report — {project_name}
|
|
80
|
+
|
|
81
|
+
- **DESIGN.md:** `{design_path}`
|
|
82
|
+
- **EXPERIENCE.md:** `{experience_path}`
|
|
83
|
+
- **Run at:** {ISO timestamp}
|
|
84
|
+
|
|
85
|
+
## Overall verdict
|
|
86
|
+
{synthesis paragraphs}
|
|
87
|
+
|
|
88
|
+
## Category verdicts
|
|
89
|
+
- Flow coverage — {verdict}
|
|
90
|
+
- Token completeness — {verdict}
|
|
91
|
+
- Component coverage — {verdict}
|
|
92
|
+
- State coverage — {verdict}
|
|
93
|
+
- Visual reference coverage — {verdict}
|
|
94
|
+
- Bloat & overspecification — {verdict}
|
|
95
|
+
- Inheritance discipline — {verdict}
|
|
96
|
+
- Shape fit — {verdict}
|
|
97
|
+
|
|
98
|
+
## Findings by severity
|
|
99
|
+
|
|
100
|
+
### Critical (n)
|
|
101
|
+
**[Category or Reviewer]** — Title (§ location)
|
|
102
|
+
{Note}
|
|
103
|
+
Fix: {suggested fix}
|
|
104
|
+
|
|
105
|
+
### High (n) / Medium (n) / Low (n)
|
|
106
|
+
...
|
|
107
|
+
|
|
108
|
+
## Reviewer files
|
|
109
|
+
- `review-rubric.md`
|
|
110
|
+
- ...
|
|
111
|
+
```
|
|
112
|
+
|
|
113
|
+
## Close
|
|
114
|
+
|
|
115
|
+
Surface artifact paths. Always offer to roll findings into an Update.
|
|
@@ -16,7 +16,7 @@ BMad Method,bmad-technical-research,Technical Research,TR,Technical feasibility
|
|
|
16
16
|
BMad Method,bmad-product-brief,Create Brief,CB,An expert guided experience to nail down your product idea in a brief. a gentler approach than PRFAQ when you are already sure of your concept and nothing will sway you.,,-A,1-analysis,,,false,planning_artifacts,product brief
|
|
17
17
|
BMad Method,bmad-prfaq,PRFAQ Challenge,WB,Working Backwards guided experience to forge and stress-test your product concept to ensure you have a great product that users will love and need through the PRFAQ gauntlet to determine feasibility and alignment with user needs. alternative to product brief.,,-H,1-analysis,,,false,planning_artifacts,prfaq document
|
|
18
18
|
BMad Method,bmad-prd,Create Edit and Review PRD,PRD,"Facilitated PRD workflow — create a new PRD via coached discovery, update an existing one against a change signal, or validate a finished PRD against a checklist with an HTML findings report.",,,2-planning,bmad-product-brief,,true,planning_artifacts,prd
|
|
19
|
-
BMad Method,bmad-
|
|
19
|
+
BMad Method,bmad-ux,Create UX,CU,"Guidance through realizing the plan for your UX, strongly recommended if a UI is a primary piece of the proposed project.",,,2-planning,bmad-prd,,false,planning_artifacts,ux design
|
|
20
20
|
BMad Method,bmad-create-architecture,Create Architecture,CA,Guided workflow to document technical decisions.,,,3-solutioning,,,true,planning_artifacts,architecture
|
|
21
21
|
BMad Method,bmad-create-epics-and-stories,Create Epics and Stories,CE,,,,3-solutioning,bmad-create-architecture,,true,planning_artifacts,epics and stories
|
|
22
22
|
BMad Method,bmad-check-implementation-readiness,Check Implementation Readiness,IR,Ensure PRD UX Architecture and Epics Stories are aligned.,,,3-solutioning,bmad-create-epics-and-stories,,true,planning_artifacts,readiness report
|
|
@@ -54,7 +54,7 @@ class Installer {
|
|
|
54
54
|
}
|
|
55
55
|
|
|
56
56
|
if (existingInstall.installed) {
|
|
57
|
-
await this._removeDeselectedModules(existingInstall, config, paths);
|
|
57
|
+
await this._removeDeselectedModules(existingInstall, config, paths, originalConfig._preserveModules || []);
|
|
58
58
|
updateState = await this._prepareUpdateState(paths, config, existingInstall, officialModules);
|
|
59
59
|
await this._removeDeselectedIdes(existingInstall, config, paths);
|
|
60
60
|
}
|
|
@@ -76,25 +76,23 @@ class Installer {
|
|
|
76
76
|
const results = [];
|
|
77
77
|
const addResult = (step, status, detail = '', meta = {}) => results.push({ step, status, detail, ...meta });
|
|
78
78
|
|
|
79
|
-
// Capture previously installed skill
|
|
80
|
-
const
|
|
81
|
-
const
|
|
82
|
-
|
|
83
|
-
try {
|
|
84
|
-
const csvParse = require('csv-parse/sync');
|
|
85
|
-
const content = await fs.readFile(prevCsvPath, 'utf8');
|
|
86
|
-
const records = csvParse.parse(content, { columns: true, skip_empty_lines: true });
|
|
87
|
-
for (const r of records) {
|
|
88
|
-
if (r.canonicalId) previousSkillIds.add(r.canonicalId);
|
|
89
|
-
}
|
|
90
|
-
} catch (error) {
|
|
91
|
-
await prompts.log.warn(`Failed to parse skill-manifest.csv: ${error.message}`);
|
|
92
|
-
}
|
|
93
|
-
}
|
|
79
|
+
// Capture previously installed skill rows before they get overwritten
|
|
80
|
+
const preservedModules = originalConfig._preserveModules || [];
|
|
81
|
+
const previousSkillManifestRows = await this._readSkillManifestRows(paths.bmadDir);
|
|
82
|
+
const previousSkillIds = this._getPreviousSkillIdsForCleanup(previousSkillManifestRows, preservedModules);
|
|
94
83
|
|
|
95
84
|
const allModules = config.modules || [];
|
|
96
85
|
|
|
97
|
-
await this._installAndConfigure(
|
|
86
|
+
await this._installAndConfigure(
|
|
87
|
+
config,
|
|
88
|
+
originalConfig,
|
|
89
|
+
paths,
|
|
90
|
+
allModules,
|
|
91
|
+
allModules,
|
|
92
|
+
addResult,
|
|
93
|
+
officialModules,
|
|
94
|
+
previousSkillManifestRows,
|
|
95
|
+
);
|
|
98
96
|
|
|
99
97
|
await this._setupIdes(config, allModules, paths, addResult, previousSkillIds);
|
|
100
98
|
|
|
@@ -144,10 +142,11 @@ class Installer {
|
|
|
144
142
|
* Remove modules that were previously installed but are no longer selected.
|
|
145
143
|
* No confirmation — the user's module selection is the decision.
|
|
146
144
|
*/
|
|
147
|
-
async _removeDeselectedModules(existingInstall, config, paths) {
|
|
145
|
+
async _removeDeselectedModules(existingInstall, config, paths, preservedModules = []) {
|
|
148
146
|
const previouslyInstalled = new Set(existingInstall.moduleIds);
|
|
149
147
|
const newlySelected = new Set(config.modules || []);
|
|
150
|
-
const
|
|
148
|
+
const preserved = new Set(preservedModules);
|
|
149
|
+
const toRemove = [...previouslyInstalled].filter((m) => !newlySelected.has(m) && m !== 'core' && !preserved.has(m));
|
|
151
150
|
|
|
152
151
|
for (const moduleId of toRemove) {
|
|
153
152
|
const modulePath = paths.moduleDir(moduleId);
|
|
@@ -212,7 +211,16 @@ class Installer {
|
|
|
212
211
|
/**
|
|
213
212
|
* Install modules, create directories, generate configs and manifests.
|
|
214
213
|
*/
|
|
215
|
-
async _installAndConfigure(
|
|
214
|
+
async _installAndConfigure(
|
|
215
|
+
config,
|
|
216
|
+
originalConfig,
|
|
217
|
+
paths,
|
|
218
|
+
officialModuleIds,
|
|
219
|
+
allModules,
|
|
220
|
+
addResult,
|
|
221
|
+
officialModules,
|
|
222
|
+
previousSkillManifestRows = [],
|
|
223
|
+
) {
|
|
216
224
|
const isQuickUpdate = config.isQuickUpdate();
|
|
217
225
|
const moduleConfigs = officialModules.moduleConfigs;
|
|
218
226
|
|
|
@@ -291,25 +299,29 @@ class Installer {
|
|
|
291
299
|
|
|
292
300
|
message('Generating manifests...');
|
|
293
301
|
const manifestGen = new ManifestGenerator();
|
|
302
|
+
const preservedModules = originalConfig._preserveModules || [];
|
|
294
303
|
|
|
295
304
|
const allModulesForManifest = config.isQuickUpdate()
|
|
296
305
|
? originalConfig._existingModules || allModules || []
|
|
297
|
-
:
|
|
298
|
-
? [...allModules, ...
|
|
306
|
+
: preservedModules.length > 0
|
|
307
|
+
? [...allModules, ...preservedModules]
|
|
299
308
|
: allModules || [];
|
|
300
309
|
|
|
301
310
|
let modulesForCsvPreserve;
|
|
302
311
|
if (config.isQuickUpdate()) {
|
|
303
312
|
modulesForCsvPreserve = originalConfig._existingModules || allModules || [];
|
|
304
313
|
} else {
|
|
305
|
-
modulesForCsvPreserve =
|
|
314
|
+
modulesForCsvPreserve = preservedModules.length > 0 ? [...allModules, ...preservedModules] : allModules;
|
|
306
315
|
}
|
|
307
316
|
|
|
317
|
+
await this._trackPreservedModuleFiles(paths.bmadDir, preservedModules);
|
|
318
|
+
|
|
308
319
|
await manifestGen.generateManifests(paths.bmadDir, allModulesForManifest, [...this.installedFiles], {
|
|
309
320
|
ides: config.ides || [],
|
|
310
321
|
preservedModules: modulesForCsvPreserve,
|
|
311
322
|
moduleConfigs,
|
|
312
323
|
});
|
|
324
|
+
await this._appendPreservedSkillManifestRows(paths.bmadDir, previousSkillManifestRows, preservedModules);
|
|
313
325
|
|
|
314
326
|
// Apply post-install --set TOML patches. Runs after writeCentralConfig
|
|
315
327
|
// (inside generateManifests above) so the patch operates on the
|
|
@@ -411,6 +423,62 @@ class Installer {
|
|
|
411
423
|
}
|
|
412
424
|
}
|
|
413
425
|
|
|
426
|
+
async _readSkillManifestRows(bmadDir) {
|
|
427
|
+
const csvPath = path.join(bmadDir, '_config', 'skill-manifest.csv');
|
|
428
|
+
if (!(await fs.pathExists(csvPath))) return [];
|
|
429
|
+
|
|
430
|
+
try {
|
|
431
|
+
const csvParse = require('csv-parse/sync');
|
|
432
|
+
const content = await fs.readFile(csvPath, 'utf8');
|
|
433
|
+
return csvParse.parse(content, { columns: true, skip_empty_lines: true });
|
|
434
|
+
} catch (error) {
|
|
435
|
+
await prompts.log.warn(`Failed to parse skill-manifest.csv: ${error.message}`);
|
|
436
|
+
return [];
|
|
437
|
+
}
|
|
438
|
+
}
|
|
439
|
+
|
|
440
|
+
_getPreviousSkillIdsForCleanup(previousRows, preservedModules = []) {
|
|
441
|
+
const preservedModuleSet = new Set(preservedModules || []);
|
|
442
|
+
const ids = new Set();
|
|
443
|
+
for (const row of previousRows || []) {
|
|
444
|
+
if (row.canonicalId && !preservedModuleSet.has(row.module)) {
|
|
445
|
+
ids.add(row.canonicalId);
|
|
446
|
+
}
|
|
447
|
+
}
|
|
448
|
+
return ids;
|
|
449
|
+
}
|
|
450
|
+
|
|
451
|
+
async _appendPreservedSkillManifestRows(bmadDir, previousRows, preservedModules = []) {
|
|
452
|
+
if (!previousRows || previousRows.length === 0 || preservedModules.length === 0) return;
|
|
453
|
+
|
|
454
|
+
const preservedModuleSet = new Set(preservedModules);
|
|
455
|
+
const rowsToPreserve = previousRows.filter((row) => row.canonicalId && row.module && preservedModuleSet.has(row.module));
|
|
456
|
+
if (rowsToPreserve.length === 0) return;
|
|
457
|
+
|
|
458
|
+
const csvPath = path.join(bmadDir, '_config', 'skill-manifest.csv');
|
|
459
|
+
if (!(await fs.pathExists(csvPath))) return;
|
|
460
|
+
|
|
461
|
+
const currentRows = await this._readSkillManifestRows(bmadDir);
|
|
462
|
+
const activeIds = new Set(currentRows.map((row) => row.canonicalId).filter(Boolean));
|
|
463
|
+
const appendedRows = [];
|
|
464
|
+
|
|
465
|
+
for (const row of rowsToPreserve) {
|
|
466
|
+
if (activeIds.has(row.canonicalId)) continue;
|
|
467
|
+
activeIds.add(row.canonicalId);
|
|
468
|
+
appendedRows.push(
|
|
469
|
+
[row.canonicalId, row.name || row.canonicalId, row.description || '', row.module, row.path || '']
|
|
470
|
+
.map((field) => this.escapeCSVField(field))
|
|
471
|
+
.join(','),
|
|
472
|
+
);
|
|
473
|
+
}
|
|
474
|
+
|
|
475
|
+
if (appendedRows.length === 0) return;
|
|
476
|
+
|
|
477
|
+
const currentContent = await fs.readFile(csvPath, 'utf8');
|
|
478
|
+
const prefix = currentContent.endsWith('\n') ? currentContent : `${currentContent}\n`;
|
|
479
|
+
await fs.writeFile(csvPath, prefix + appendedRows.join('\n') + '\n', 'utf8');
|
|
480
|
+
}
|
|
481
|
+
|
|
414
482
|
/**
|
|
415
483
|
* Restore custom and modified files that were backed up before the update.
|
|
416
484
|
* No-op for fresh installs (updateState is null).
|
|
@@ -597,6 +665,15 @@ class Installer {
|
|
|
597
665
|
}
|
|
598
666
|
}
|
|
599
667
|
|
|
668
|
+
async _trackPreservedModuleFiles(bmadDir, preservedModules = []) {
|
|
669
|
+
for (const moduleName of preservedModules) {
|
|
670
|
+
const modulePath = path.join(bmadDir, moduleName);
|
|
671
|
+
if (await fs.pathExists(modulePath)) {
|
|
672
|
+
await this._trackFilesRecursive(modulePath);
|
|
673
|
+
}
|
|
674
|
+
}
|
|
675
|
+
}
|
|
676
|
+
|
|
600
677
|
/**
|
|
601
678
|
* Install official (non-custom) modules.
|
|
602
679
|
* @param {Object} config - Installation configuration
|
|
@@ -501,7 +501,7 @@ class ConfigDrivenIdeSetup {
|
|
|
501
501
|
|
|
502
502
|
// Build removal set: previously installed skills + removals.txt entries
|
|
503
503
|
let removalSet;
|
|
504
|
-
if (options.previousSkillIds
|
|
504
|
+
if (options.previousSkillIds) {
|
|
505
505
|
// Install/update flow: use pre-captured skill IDs (before manifest was overwritten)
|
|
506
506
|
removalSet = new Set(options.previousSkillIds);
|
|
507
507
|
if (resolvedBmadDir) {
|
|
@@ -547,7 +547,7 @@ class ConfigDrivenIdeSetup {
|
|
|
547
547
|
// previousSkillIds — full uninstall or per-IDE removal via
|
|
548
548
|
// cleanupByList), don't spare anything; the IDE itself is going away,
|
|
549
549
|
// so its pointers should go with it.
|
|
550
|
-
const isInstallFlow = options.previousSkillIds
|
|
550
|
+
const isInstallFlow = !!options.previousSkillIds;
|
|
551
551
|
const activeSkillIds = isInstallFlow ? await this._readActiveSkillIds(resolvedBmadDir) : new Set();
|
|
552
552
|
const extension = this.installerConfig.commands_extension || '.md';
|
|
553
553
|
await this.cleanupCommandPointers(
|
package/tools/installer/ui.js
CHANGED
|
@@ -110,6 +110,44 @@ async function getModuleVersion(moduleCode, { repoUrl = null, registryDefault =
|
|
|
110
110
|
* UI utilities for the installer
|
|
111
111
|
*/
|
|
112
112
|
class UI {
|
|
113
|
+
async _retainUnavailableInstalledModules(selectedModules, installedModuleIds, bmadDir, options = {}) {
|
|
114
|
+
const { OfficialModules } = require('./modules/official-modules');
|
|
115
|
+
const officialCodes = new Set(['core']);
|
|
116
|
+
|
|
117
|
+
const builtInModules = (await new OfficialModules().listAvailable()).modules || [];
|
|
118
|
+
for (const mod of builtInModules) {
|
|
119
|
+
officialCodes.add(mod.id);
|
|
120
|
+
}
|
|
121
|
+
|
|
122
|
+
const externalManager = new ExternalModuleManager();
|
|
123
|
+
const registryModules = await externalManager.listAvailable();
|
|
124
|
+
for (const mod of registryModules) {
|
|
125
|
+
officialCodes.add(mod.code);
|
|
126
|
+
}
|
|
127
|
+
|
|
128
|
+
const { CustomModuleManager } = require('./modules/custom-module-manager');
|
|
129
|
+
const customMgr = new CustomModuleManager();
|
|
130
|
+
const selectedSet = new Set(selectedModules);
|
|
131
|
+
const preserveModules = [];
|
|
132
|
+
|
|
133
|
+
for (const moduleId of installedModuleIds) {
|
|
134
|
+
if (moduleId === 'core') continue;
|
|
135
|
+
if (!selectedSet.has(moduleId) && !options.preserveUnselected) continue;
|
|
136
|
+
if (officialCodes.has(moduleId)) continue;
|
|
137
|
+
|
|
138
|
+
const customSource = await customMgr.findModuleSourceByCode(moduleId, { bmadDir });
|
|
139
|
+
if (!customSource) {
|
|
140
|
+
preserveModules.push(moduleId);
|
|
141
|
+
}
|
|
142
|
+
}
|
|
143
|
+
|
|
144
|
+
const preservedSet = new Set(preserveModules);
|
|
145
|
+
return {
|
|
146
|
+
selectedModules: selectedModules.filter((moduleId) => !preservedSet.has(moduleId)),
|
|
147
|
+
preserveModules,
|
|
148
|
+
};
|
|
149
|
+
}
|
|
150
|
+
|
|
113
151
|
/**
|
|
114
152
|
* Prompt for installation configuration
|
|
115
153
|
* @param {Object} options - Command-line options from install command
|
|
@@ -273,6 +311,18 @@ class UI {
|
|
|
273
311
|
selectedModules.unshift('core');
|
|
274
312
|
}
|
|
275
313
|
|
|
314
|
+
const retainedModuleResult = await this._retainUnavailableInstalledModules(selectedModules, installedModuleIds, bmadDir, {
|
|
315
|
+
preserveUnselected: options.yes && !options.modules,
|
|
316
|
+
});
|
|
317
|
+
selectedModules = retainedModuleResult.selectedModules;
|
|
318
|
+
const preservedModules = retainedModuleResult.preserveModules;
|
|
319
|
+
|
|
320
|
+
if (preservedModules.length > 0) {
|
|
321
|
+
await prompts.log.warn(
|
|
322
|
+
`Retaining ${preservedModules.length} installed module(s) with no available source: ${preservedModules.join(', ')}`,
|
|
323
|
+
);
|
|
324
|
+
}
|
|
325
|
+
|
|
276
326
|
// For existing installs, resolve per-module update decisions BEFORE
|
|
277
327
|
// we clone anything. Reads the existing manifest's recorded channel
|
|
278
328
|
// per module and prompts the user on available upgrades (patch/minor
|
|
@@ -317,6 +367,7 @@ class UI {
|
|
|
317
367
|
setOverrides,
|
|
318
368
|
skipPrompts: options.yes || false,
|
|
319
369
|
channelOptions,
|
|
370
|
+
_preserveModules: preservedModules,
|
|
320
371
|
};
|
|
321
372
|
}
|
|
322
373
|
}
|
package/tools/skill-validator.md
CHANGED
|
@@ -10,7 +10,7 @@ Before running inference-based validation, run the deterministic validator:
|
|
|
10
10
|
node tools/validate-skills.js --json path/to/skill-dir
|
|
11
11
|
```
|
|
12
12
|
|
|
13
|
-
This checks
|
|
13
|
+
This checks 12 rules deterministically: SKILL-01, SKILL-02, SKILL-03, SKILL-04, SKILL-05, SKILL-06, SKILL-07, PATH-02, STEP-01, STEP-06, STEP-07, SEQ-02.
|
|
14
14
|
|
|
15
15
|
Review its JSON output. For any rule that produced **zero findings** in the first pass, **skip it** during inference-based validation below — it has already been verified. If a rule produced any findings, the inference validator should still review that rule (some rules like SKILL-04 and SKILL-06 have sub-checks that benefit from judgment). Focus your inference effort on the remaining rules that require judgment (PATH-01, PATH-03, PATH-04, PATH-05, WF-03, STEP-02, STEP-03, STEP-04, STEP-05, SEQ-01, REF-01, REF-02, REF-03).
|
|
16
16
|
|
|
@@ -98,24 +98,6 @@ If no findings are generated (from either pass), the skill passes validation.
|
|
|
98
98
|
|
|
99
99
|
---
|
|
100
100
|
|
|
101
|
-
### WF-01 — Only SKILL.md May Have `name` in Frontmatter
|
|
102
|
-
|
|
103
|
-
- **Severity:** HIGH
|
|
104
|
-
- **Applies to:** all `.md` files except `SKILL.md`
|
|
105
|
-
- **Rule:** The `name` field belongs only in `SKILL.md`. No other markdown file in the skill directory may have `name:` in its frontmatter.
|
|
106
|
-
- **Detection:** Parse frontmatter of every non-SKILL.md markdown file and check for `name:` key.
|
|
107
|
-
- **Fix:** Remove the `name:` line from the file's frontmatter.
|
|
108
|
-
- **Exception:** `bmad-agent-tech-writer` — has sub-skill files with intentional `name` fields (to be revisited).
|
|
109
|
-
|
|
110
|
-
### WF-02 — Only SKILL.md May Have `description` in Frontmatter
|
|
111
|
-
|
|
112
|
-
- **Severity:** HIGH
|
|
113
|
-
- **Applies to:** all `.md` files except `SKILL.md`
|
|
114
|
-
- **Rule:** The `description` field belongs only in `SKILL.md`. No other markdown file in the skill directory may have `description:` in its frontmatter.
|
|
115
|
-
- **Detection:** Parse frontmatter of every non-SKILL.md markdown file and check for `description:` key.
|
|
116
|
-
- **Fix:** Remove the `description:` line from the file's frontmatter.
|
|
117
|
-
- **Exception:** `bmad-agent-tech-writer` — has sub-skill files with intentional `description` fields (to be revisited).
|
|
118
|
-
|
|
119
101
|
### WF-03 — workflow.md Frontmatter Variables Must Be Config or Runtime Only
|
|
120
102
|
|
|
121
103
|
- **Severity:** HIGH
|