@clfhhc/bmad-methods-skills 0.2.0 → 0.2.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/config.json +16 -0
- package/docs/development.md +1 -0
- package/docs/getting-started.md +24 -2
- package/docs/technical-reference.md +13 -2
- package/package.json +1 -1
package/config.json
CHANGED
|
@@ -45,6 +45,12 @@
|
|
|
45
45
|
"dest": "core/resources/excalidraw",
|
|
46
46
|
"name": "Excalidraw Resources",
|
|
47
47
|
"isDirectory": true
|
|
48
|
+
},
|
|
49
|
+
{
|
|
50
|
+
"src": "src/bmm/workflows/excalidraw-diagrams/_shared",
|
|
51
|
+
"dest": "bmm/excalidraw-diagrams/_shared",
|
|
52
|
+
"name": "Excalidraw Diagrams Shared (templates, library)",
|
|
53
|
+
"isDirectory": true
|
|
48
54
|
}
|
|
49
55
|
],
|
|
50
56
|
"pathPatterns": [
|
|
@@ -83,6 +89,16 @@
|
|
|
83
89
|
"replacement": "{skill-root}/core/resources/excalidraw/$1",
|
|
84
90
|
"description": "Excalidraw helper resources"
|
|
85
91
|
},
|
|
92
|
+
{
|
|
93
|
+
"pattern": "\\{project-root\\}/_bmad/bmm/workflows/excalidraw-diagrams/_shared/([^/\\\\s'\"]+)",
|
|
94
|
+
"replacement": "{skill-root}/bmm/excalidraw-diagrams/_shared/$1",
|
|
95
|
+
"description": "Excalidraw-diagrams _shared files (excalidraw-templates.yaml, excalidraw-library.json)"
|
|
96
|
+
},
|
|
97
|
+
{
|
|
98
|
+
"pattern": "\\{project-root\\}/_bmad/bmm/workflows/excalidraw-diagrams/_shared(?!/)",
|
|
99
|
+
"replacement": "{skill-root}/bmm/excalidraw-diagrams/_shared",
|
|
100
|
+
"description": "Excalidraw-diagrams _shared directory (when not followed by /)"
|
|
101
|
+
},
|
|
86
102
|
{
|
|
87
103
|
"pattern": "\\{project-root\\}/_bmad/bmm/testarch/knowledge/",
|
|
88
104
|
"replacement": "{skill-root}/bmm/tea/knowledge/",
|
package/docs/development.md
CHANGED
|
@@ -38,6 +38,7 @@ To customize conversion:
|
|
|
38
38
|
1. **Agent Conversion**: Edit `src/converters/agent-converter.js`
|
|
39
39
|
2. **Workflow Conversion**: Edit `src/converters/workflow-converter.js`
|
|
40
40
|
3. **Output Format**: Edit `src/utils/skill-writer.js`
|
|
41
|
+
4. **Auxiliary resources and path patterns**: Edit `config.json` — add entries to `auxiliaryResources` (e.g. Excalidraw core, `excalidraw-diagrams/_shared`) and `pathPatterns` for any `{project-root}/_bmad/...` paths that need rewriting. See [Technical Reference - Auxiliary Resource Migration](technical-reference.md#auxiliary-resource-migration).
|
|
41
42
|
|
|
42
43
|
# Troubleshooting
|
|
43
44
|
|
package/docs/getting-started.md
CHANGED
|
@@ -161,6 +161,18 @@ Edit `config.json` to customize:
|
|
|
161
161
|
"src": "src/bmm/agents/tech-writer/tech-writer-sidecar/documentation-standards.md",
|
|
162
162
|
"dest": "bmm/tech-writer/data/documentation-standards.md",
|
|
163
163
|
"name": "Documentation Standards"
|
|
164
|
+
},
|
|
165
|
+
{
|
|
166
|
+
"src": "src/core/resources/excalidraw",
|
|
167
|
+
"dest": "core/resources/excalidraw",
|
|
168
|
+
"name": "Excalidraw Resources",
|
|
169
|
+
"isDirectory": true
|
|
170
|
+
},
|
|
171
|
+
{
|
|
172
|
+
"src": "src/bmm/workflows/excalidraw-diagrams/_shared",
|
|
173
|
+
"dest": "bmm/excalidraw-diagrams/_shared",
|
|
174
|
+
"name": "Excalidraw Diagrams Shared",
|
|
175
|
+
"isDirectory": true
|
|
164
176
|
}
|
|
165
177
|
],
|
|
166
178
|
"pathPatterns": [
|
|
@@ -168,13 +180,23 @@ Edit `config.json` to customize:
|
|
|
168
180
|
"pattern": "\\{project-root\\}/_bmad/core/resources/excalidraw/([^/\\\\s'\\\"]+)",
|
|
169
181
|
"replacement": "{skill-root}/core/resources/excalidraw/$1",
|
|
170
182
|
"description": "Excalidraw helper resources"
|
|
183
|
+
},
|
|
184
|
+
{
|
|
185
|
+
"pattern": "\\{project-root\\}/_bmad/bmm/workflows/excalidraw-diagrams/_shared/([^/\\\\s'\\\"]+)",
|
|
186
|
+
"replacement": "{skill-root}/bmm/excalidraw-diagrams/_shared/$1",
|
|
187
|
+
"description": "Excalidraw _shared files (templates, library)"
|
|
188
|
+
},
|
|
189
|
+
{
|
|
190
|
+
"pattern": "\\{project-root\\}/_bmad/bmm/workflows/excalidraw-diagrams/_shared(?!/)",
|
|
191
|
+
"replacement": "{skill-root}/bmm/excalidraw-diagrams/_shared",
|
|
192
|
+
"description": "Excalidraw _shared directory"
|
|
171
193
|
}
|
|
172
194
|
]
|
|
173
195
|
}
|
|
174
196
|
```
|
|
175
197
|
|
|
176
|
-
- **`auxiliaryResources`**: Define extra files or folders to migrate.
|
|
177
|
-
- **`pathPatterns`**: Custom regex rules for path adaptation. Applied before standard rewriting.
|
|
198
|
+
- **`auxiliaryResources`**: Define extra files or folders to migrate (e.g. Excalidraw core, Excalidraw Diagrams Shared). Supports `isDirectory: true` for recursive copy. Migrated content gets path rewriting.
|
|
199
|
+
- **`pathPatterns`**: Custom regex rules for path adaptation. Applied before standard rewriting. The default config includes patterns for Excalidraw core and `excalidraw-diagrams/_shared`; see [Technical Reference - Auxiliary Resource Migration](technical-reference.md#auxiliary-resource-migration) for the full list.
|
|
178
200
|
|
|
179
201
|
### Clean Up
|
|
180
202
|
|
|
@@ -10,10 +10,14 @@ skills/
|
|
|
10
10
|
│ │ └── SKILL.md
|
|
11
11
|
│ ├── pm/
|
|
12
12
|
│ │ └── SKILL.md
|
|
13
|
+
│ ├── excalidraw-diagrams/
|
|
14
|
+
│ │ └── _shared/ # excalidraw-templates.yaml, excalidraw-library.json
|
|
13
15
|
│ ├── config.yaml # Project configuration
|
|
14
|
-
│ └── (skills...) # BMM methodology skills
|
|
16
|
+
│ └── (skills...) # BMM methodology skills (includes create-excalidraw-*)
|
|
15
17
|
├── core/
|
|
16
18
|
│ ├── config.yaml # Core user settings
|
|
19
|
+
│ ├── resources/
|
|
20
|
+
│ │ └── excalidraw/ # excalidraw-helpers.md, validate-json-instructions.md, etc.
|
|
17
21
|
│ └── (skills...) # Core system skills
|
|
18
22
|
```
|
|
19
23
|
|
|
@@ -81,7 +85,12 @@ The converter automatically handles non-standard resources referenced by skills
|
|
|
81
85
|
4. **Excalidraw Resources**:
|
|
82
86
|
- Source: `src/core/resources/excalidraw`
|
|
83
87
|
- Destination: `core/resources/excalidraw`
|
|
84
|
-
- Purpose:
|
|
88
|
+
- Purpose: Universal Excalidraw helpers (excalidraw-helpers.md, validate-json-instructions.md, library-loader.md)
|
|
89
|
+
|
|
90
|
+
5. **Excalidraw Diagrams Shared**:
|
|
91
|
+
- Source: `src/bmm/workflows/excalidraw-diagrams/_shared`
|
|
92
|
+
- Destination: `bmm/excalidraw-diagrams/_shared`
|
|
93
|
+
- Purpose: Domain-specific templates and library (excalidraw-templates.yaml, excalidraw-library.json) used by create-excalidraw-flowchart, create-excalidraw-diagram, create-excalidraw-wireframe, create-excalidraw-dataflow
|
|
85
94
|
|
|
86
95
|
### Recursive Path Rewriting
|
|
87
96
|
Migrated resources are processed recursively. Any text-based files within these resources (e.g., Markdown in the TEA knowledge base) have their internal paths rewritten to be compatible with the new skill structure.
|
|
@@ -99,6 +108,8 @@ To make skills portable, path rewriting uses a dynamic map of all discovered ski
|
|
|
99
108
|
- **Standardized Paths**:
|
|
100
109
|
- Cross-Skill: `{skill-root}/{module}/{skill}/SKILL.md`
|
|
101
110
|
- Resources: `{skill-root}/{module}/{skill}/data/...`
|
|
111
|
+
- Excalidraw core: `{skill-root}/core/resources/excalidraw/...`
|
|
112
|
+
- Excalidraw shared: `{skill-root}/bmm/excalidraw-diagrams/_shared/...` (templates, library)
|
|
102
113
|
- **Migrated Resources**: Paths to migrated files are updated to their new locations.
|
|
103
114
|
|
|
104
115
|
This ensures skills work correctly regardless of where the root `skills` directory is installed and that cross-skill references are robust.
|