Compare commits
6 Commits
efae5c2f3f
...
b09ada15c8
| Author | SHA1 | Date |
|---|---|---|
Jonah Schulte
|
b09ada15c8 | |
Brian Madison
|
efbe839a0a | |
|
Brian Madison
|
3f9ad4868c | |
Alex Verkhovsky
|
aad132c9b1 | |
|
Brian Madison
|
c9f2dc51db | |
|
Jonah Schulte
|
5e841f9cac |
35
README.md
35
README.md
|
|
@ -26,27 +26,34 @@ Traditional AI tools do the thinking for you, producing average results. BMad ag
|
|||
npx bmad-method@alpha install
|
||||
```
|
||||
|
||||
Follow the installer prompts to configure your project. Then run:
|
||||
Follow the installer prompts to configure your project.
|
||||
|
||||
```bash
|
||||
*workflow-init
|
||||
```
|
||||
Once you have installed BMad to a folder, launch your tool of choice from where you installed BMad. (We really like Claude Code and Cursor - but there are any that work great with BMad!)
|
||||
|
||||
Then its simple as running the command: `/bmad-help` if you do not know what to do. Depending on which modules you have installed, you will have different choices.
|
||||
|
||||
To make the help more applicable you can even run the `/bmad-help What do you suggest I do to get started building a brand new web application for XYZ`.
|
||||
|
||||
The results from BMad Help will be able to suggest and constantly guide you on what to do next - along with the workflows upon completion also making suggestions on what to do next.
|
||||
|
||||
This analyzes your project and recommends a track:
|
||||
|
||||
| Track | Best For | Time to First Story |
|
||||
| --------------- | ------------------------- | ------------------- |
|
||||
| **Quick Flow** | Bug fixes, small features | ~5 minutes |
|
||||
| **BMad Method** | Products and platforms | ~15 minutes |
|
||||
| **Enterprise** | Compliance-heavy systems | ~30 minutes |
|
||||
| Track | Best For | Time to First Story Coding |
|
||||
| --------------- | ------------------------- | -------------------------- |
|
||||
| **Quick Flow** | Bug fixes, small features | ~10-30 minutes |
|
||||
| **BMad Method** | Products and platforms | ~30 minutes - 2 hours |
|
||||
| **Enterprise** | Compliance-heavy systems | ~1-3 hours |
|
||||
|
||||
## Modules
|
||||
|
||||
| Module | Purpose |
|
||||
| ------------------------------------- | -------------------------------------------------------- |
|
||||
| **BMad Method (BMM)** | Core agile development with 34 workflows across 4 phases |
|
||||
| **BMad Builder (BMB)** | Create custom agents and domain-specific modules |
|
||||
| **Creative Intelligence Suite (CIS)** | Innovation, brainstorming, and problem-solving |
|
||||
BMad Method extends with official modules for specialized domains. Modules are available during installation and can be added to your project at any time.
|
||||
|
||||
| Module | GitHub | NPM | Purpose |
|
||||
|--------|--------|-----|---------|
|
||||
| **BMad Method (BMM)** | [bmad-code-org/BMAD-METHOD](https://github.com/bmad-code-org/BMAD-METHOD) | [bmad-method](https://www.npmjs.com/package/bmad-method) | Core framework with 34+ workflows across 4 development phases |
|
||||
| **BMad Builder (BMB)** | [bmad-code-org/bmad-builder](https://github.com/bmad-code-org/bmad-builder) | [bmad-builder](https://www.npmjs.com/package/bmad-builder) | Create custom BMad agents, workflows, and domain-specific modules |
|
||||
| **Game Dev Studio (BMGD)** | [bmad-code-org/bmad-module-game-dev-studio](https://github.com/bmad-code-org/bmad-module-game-dev-studio) | [bmad-game-dev-studio](https://www.npmjs.com/package/bmad-game-dev-studio) | Game development workflows for Unity, Unreal, and Godot |
|
||||
| **Creative Intelligence Suite (CIS)** | [bmad-code-org/bmad-module-creative-intelligence-suite](https://github.com/bmad-code-org/bmad-module-creative-intelligence-suite) | [bmad-creative-intelligence-suite](https://www.npmjs.com/package/bmad-creative-intelligence-suite) | Innovation, brainstorming, design thinking, and problem-solving |
|
||||
|
||||
## Documentation
|
||||
|
||||
|
|
|
|||
|
|
@ -81,6 +81,21 @@ export default [
|
|||
},
|
||||
},
|
||||
|
||||
// Test files using Vitest (ES modules)
|
||||
{
|
||||
files: ['test/unit/**/*.js', 'test/integration/**/*.js', 'test/helpers/**/*.js', 'test/setup.js', 'vitest.config.js'],
|
||||
languageOptions: {
|
||||
sourceType: 'module',
|
||||
ecmaVersion: 'latest',
|
||||
},
|
||||
rules: {
|
||||
// Allow dev dependencies in test files
|
||||
'n/no-unpublished-import': 'off',
|
||||
'unicorn/prefer-module': 'off',
|
||||
'no-unused-vars': 'off',
|
||||
},
|
||||
},
|
||||
|
||||
// CLI scripts under tools/** and test/**
|
||||
{
|
||||
files: ['tools/**/*.js', 'tools/**/*.mjs', 'test/**/*.js'],
|
||||
|
|
|
|||
|
|
@ -35,6 +35,8 @@
|
|||
"@astrojs/sitemap": "^3.6.0",
|
||||
"@astrojs/starlight": "^0.37.0",
|
||||
"@eslint/js": "^9.33.0",
|
||||
"@vitest/coverage-v8": "^4.0.16",
|
||||
"@vitest/ui": "^4.0.16",
|
||||
"archiver": "^7.0.1",
|
||||
"astro": "^5.16.0",
|
||||
"c8": "^10.1.3",
|
||||
|
|
@ -50,6 +52,7 @@
|
|||
"prettier": "^3.7.4",
|
||||
"prettier-plugin-packagejson": "^2.5.19",
|
||||
"sharp": "^0.33.5",
|
||||
"vitest": "^4.0.16",
|
||||
"yaml-eslint-parser": "^1.2.3",
|
||||
"yaml-lint": "^1.7.0"
|
||||
},
|
||||
|
|
@ -2983,6 +2986,13 @@
|
|||
"url": "https://opencollective.com/pkgr"
|
||||
}
|
||||
},
|
||||
"node_modules/@polka/url": {
|
||||
"version": "1.0.0-next.29",
|
||||
"resolved": "https://registry.npmjs.org/@polka/url/-/url-1.0.0-next.29.tgz",
|
||||
"integrity": "sha512-wwQAWhWSuHaag8c4q/KN/vCoeOJYshAIvMQwD4GpSb3OiZklFfvAgmj0VCBBImRpuF/aFgIRzllXlVX93Jevww==",
|
||||
"dev": true,
|
||||
"license": "MIT"
|
||||
},
|
||||
"node_modules/@rollup/pluginutils": {
|
||||
"version": "5.3.0",
|
||||
"resolved": "https://registry.npmjs.org/@rollup/pluginutils/-/pluginutils-5.3.0.tgz",
|
||||
|
|
@ -3435,6 +3445,13 @@
|
|||
"@sinonjs/commons": "^3.0.1"
|
||||
}
|
||||
},
|
||||
"node_modules/@standard-schema/spec": {
|
||||
"version": "1.1.0",
|
||||
"resolved": "https://registry.npmjs.org/@standard-schema/spec/-/spec-1.1.0.tgz",
|
||||
"integrity": "sha512-l2aFy5jALhniG5HgqrD6jXLi/rUWrKvqN/qJx6yoJsgKhblVd+iqqU4RCXavm/jPityDo5TCvKMnpjKnOriy0w==",
|
||||
"dev": true,
|
||||
"license": "MIT"
|
||||
},
|
||||
"node_modules/@swc/helpers": {
|
||||
"version": "0.5.18",
|
||||
"resolved": "https://registry.npmjs.org/@swc/helpers/-/helpers-0.5.18.tgz",
|
||||
|
|
@ -3501,6 +3518,17 @@
|
|||
"@babel/types": "^7.28.2"
|
||||
}
|
||||
},
|
||||
"node_modules/@types/chai": {
|
||||
"version": "5.2.3",
|
||||
"resolved": "https://registry.npmjs.org/@types/chai/-/chai-5.2.3.tgz",
|
||||
"integrity": "sha512-Mw558oeA9fFbv65/y4mHtXDs9bPnFMZAL/jxdPFUpOHHIXX91mcgEHbS5Lahr+pwZFR8A7GQleRWeI6cGFC2UA==",
|
||||
"dev": true,
|
||||
"license": "MIT",
|
||||
"dependencies": {
|
||||
"@types/deep-eql": "*",
|
||||
"assertion-error": "^2.0.1"
|
||||
}
|
||||
},
|
||||
"node_modules/@types/debug": {
|
||||
"version": "4.1.12",
|
||||
"resolved": "https://registry.npmjs.org/@types/debug/-/debug-4.1.12.tgz",
|
||||
|
|
@ -3510,6 +3538,13 @@
|
|||
"@types/ms": "*"
|
||||
}
|
||||
},
|
||||
"node_modules/@types/deep-eql": {
|
||||
"version": "4.0.2",
|
||||
"resolved": "https://registry.npmjs.org/@types/deep-eql/-/deep-eql-4.0.2.tgz",
|
||||
"integrity": "sha512-c9h9dVVMigMPc4bwTvC5dxqtqJZwQPePsWjPlpSOnojbor6pGqdk541lfA7AqFQr5pB1BRdq0juY9db81BwyFw==",
|
||||
"dev": true,
|
||||
"license": "MIT"
|
||||
},
|
||||
"node_modules/@types/estree": {
|
||||
"version": "1.0.8",
|
||||
"resolved": "https://registry.npmjs.org/@types/estree/-/estree-1.0.8.tgz",
|
||||
|
|
@ -3953,6 +3988,171 @@
|
|||
"win32"
|
||||
]
|
||||
},
|
||||
"node_modules/@vitest/coverage-v8": {
|
||||
"version": "4.0.16",
|
||||
"resolved": "https://registry.npmjs.org/@vitest/coverage-v8/-/coverage-v8-4.0.16.tgz",
|
||||
"integrity": "sha512-2rNdjEIsPRzsdu6/9Eq0AYAzYdpP6Bx9cje9tL3FE5XzXRQF1fNU9pe/1yE8fCrS0HD+fBtt6gLPh6LI57tX7A==",
|
||||
"dev": true,
|
||||
"license": "MIT",
|
||||
"dependencies": {
|
||||
"@bcoe/v8-coverage": "^1.0.2",
|
||||
"@vitest/utils": "4.0.16",
|
||||
"ast-v8-to-istanbul": "^0.3.8",
|
||||
"istanbul-lib-coverage": "^3.2.2",
|
||||
"istanbul-lib-report": "^3.0.1",
|
||||
"istanbul-lib-source-maps": "^5.0.6",
|
||||
"istanbul-reports": "^3.2.0",
|
||||
"magicast": "^0.5.1",
|
||||
"obug": "^2.1.1",
|
||||
"std-env": "^3.10.0",
|
||||
"tinyrainbow": "^3.0.3"
|
||||
},
|
||||
"funding": {
|
||||
"url": "https://opencollective.com/vitest"
|
||||
},
|
||||
"peerDependencies": {
|
||||
"@vitest/browser": "4.0.16",
|
||||
"vitest": "4.0.16"
|
||||
},
|
||||
"peerDependenciesMeta": {
|
||||
"@vitest/browser": {
|
||||
"optional": true
|
||||
}
|
||||
}
|
||||
},
|
||||
"node_modules/@vitest/expect": {
|
||||
"version": "4.0.16",
|
||||
"resolved": "https://registry.npmjs.org/@vitest/expect/-/expect-4.0.16.tgz",
|
||||
"integrity": "sha512-eshqULT2It7McaJkQGLkPjPjNph+uevROGuIMJdG3V+0BSR2w9u6J9Lwu+E8cK5TETlfou8GRijhafIMhXsimA==",
|
||||
"dev": true,
|
||||
"license": "MIT",
|
||||
"dependencies": {
|
||||
"@standard-schema/spec": "^1.0.0",
|
||||
"@types/chai": "^5.2.2",
|
||||
"@vitest/spy": "4.0.16",
|
||||
"@vitest/utils": "4.0.16",
|
||||
"chai": "^6.2.1",
|
||||
"tinyrainbow": "^3.0.3"
|
||||
},
|
||||
"funding": {
|
||||
"url": "https://opencollective.com/vitest"
|
||||
}
|
||||
},
|
||||
"node_modules/@vitest/mocker": {
|
||||
"version": "4.0.16",
|
||||
"resolved": "https://registry.npmjs.org/@vitest/mocker/-/mocker-4.0.16.tgz",
|
||||
"integrity": "sha512-yb6k4AZxJTB+q9ycAvsoxGn+j/po0UaPgajllBgt1PzoMAAmJGYFdDk0uCcRcxb3BrME34I6u8gHZTQlkqSZpg==",
|
||||
"dev": true,
|
||||
"license": "MIT",
|
||||
"dependencies": {
|
||||
"@vitest/spy": "4.0.16",
|
||||
"estree-walker": "^3.0.3",
|
||||
"magic-string": "^0.30.21"
|
||||
},
|
||||
"funding": {
|
||||
"url": "https://opencollective.com/vitest"
|
||||
},
|
||||
"peerDependencies": {
|
||||
"msw": "^2.4.9",
|
||||
"vite": "^6.0.0 || ^7.0.0-0"
|
||||
},
|
||||
"peerDependenciesMeta": {
|
||||
"msw": {
|
||||
"optional": true
|
||||
},
|
||||
"vite": {
|
||||
"optional": true
|
||||
}
|
||||
}
|
||||
},
|
||||
"node_modules/@vitest/pretty-format": {
|
||||
"version": "4.0.16",
|
||||
"resolved": "https://registry.npmjs.org/@vitest/pretty-format/-/pretty-format-4.0.16.tgz",
|
||||
"integrity": "sha512-eNCYNsSty9xJKi/UdVD8Ou16alu7AYiS2fCPRs0b1OdhJiV89buAXQLpTbe+X8V9L6qrs9CqyvU7OaAopJYPsA==",
|
||||
"dev": true,
|
||||
"license": "MIT",
|
||||
"dependencies": {
|
||||
"tinyrainbow": "^3.0.3"
|
||||
},
|
||||
"funding": {
|
||||
"url": "https://opencollective.com/vitest"
|
||||
}
|
||||
},
|
||||
"node_modules/@vitest/runner": {
|
||||
"version": "4.0.16",
|
||||
"resolved": "https://registry.npmjs.org/@vitest/runner/-/runner-4.0.16.tgz",
|
||||
"integrity": "sha512-VWEDm5Wv9xEo80ctjORcTQRJ539EGPB3Pb9ApvVRAY1U/WkHXmmYISqU5E79uCwcW7xYUV38gwZD+RV755fu3Q==",
|
||||
"dev": true,
|
||||
"license": "MIT",
|
||||
"dependencies": {
|
||||
"@vitest/utils": "4.0.16",
|
||||
"pathe": "^2.0.3"
|
||||
},
|
||||
"funding": {
|
||||
"url": "https://opencollective.com/vitest"
|
||||
}
|
||||
},
|
||||
"node_modules/@vitest/snapshot": {
|
||||
"version": "4.0.16",
|
||||
"resolved": "https://registry.npmjs.org/@vitest/snapshot/-/snapshot-4.0.16.tgz",
|
||||
"integrity": "sha512-sf6NcrYhYBsSYefxnry+DR8n3UV4xWZwWxYbCJUt2YdvtqzSPR7VfGrY0zsv090DAbjFZsi7ZaMi1KnSRyK1XA==",
|
||||
"dev": true,
|
||||
"license": "MIT",
|
||||
"dependencies": {
|
||||
"@vitest/pretty-format": "4.0.16",
|
||||
"magic-string": "^0.30.21",
|
||||
"pathe": "^2.0.3"
|
||||
},
|
||||
"funding": {
|
||||
"url": "https://opencollective.com/vitest"
|
||||
}
|
||||
},
|
||||
"node_modules/@vitest/spy": {
|
||||
"version": "4.0.16",
|
||||
"resolved": "https://registry.npmjs.org/@vitest/spy/-/spy-4.0.16.tgz",
|
||||
"integrity": "sha512-4jIOWjKP0ZUaEmJm00E0cOBLU+5WE0BpeNr3XN6TEF05ltro6NJqHWxXD0kA8/Zc8Nh23AT8WQxwNG+WeROupw==",
|
||||
"dev": true,
|
||||
"license": "MIT",
|
||||
"funding": {
|
||||
"url": "https://opencollective.com/vitest"
|
||||
}
|
||||
},
|
||||
"node_modules/@vitest/ui": {
|
||||
"version": "4.0.16",
|
||||
"resolved": "https://registry.npmjs.org/@vitest/ui/-/ui-4.0.16.tgz",
|
||||
"integrity": "sha512-rkoPH+RqWopVxDnCBE/ysIdfQ2A7j1eDmW8tCxxrR9nnFBa9jKf86VgsSAzxBd1x+ny0GC4JgiD3SNfRHv3pOg==",
|
||||
"dev": true,
|
||||
"license": "MIT",
|
||||
"dependencies": {
|
||||
"@vitest/utils": "4.0.16",
|
||||
"fflate": "^0.8.2",
|
||||
"flatted": "^3.3.3",
|
||||
"pathe": "^2.0.3",
|
||||
"sirv": "^3.0.2",
|
||||
"tinyglobby": "^0.2.15",
|
||||
"tinyrainbow": "^3.0.3"
|
||||
},
|
||||
"funding": {
|
||||
"url": "https://opencollective.com/vitest"
|
||||
},
|
||||
"peerDependencies": {
|
||||
"vitest": "4.0.16"
|
||||
}
|
||||
},
|
||||
"node_modules/@vitest/utils": {
|
||||
"version": "4.0.16",
|
||||
"resolved": "https://registry.npmjs.org/@vitest/utils/-/utils-4.0.16.tgz",
|
||||
"integrity": "sha512-h8z9yYhV3e1LEfaQ3zdypIrnAg/9hguReGZoS7Gl0aBG5xgA410zBqECqmaF/+RkTggRsfnzc1XaAHA6bmUufA==",
|
||||
"dev": true,
|
||||
"license": "MIT",
|
||||
"dependencies": {
|
||||
"@vitest/pretty-format": "4.0.16",
|
||||
"tinyrainbow": "^3.0.3"
|
||||
},
|
||||
"funding": {
|
||||
"url": "https://opencollective.com/vitest"
|
||||
}
|
||||
},
|
||||
"node_modules/abort-controller": {
|
||||
"version": "3.0.0",
|
||||
"resolved": "https://registry.npmjs.org/abort-controller/-/abort-controller-3.0.0.tgz",
|
||||
|
|
@ -4264,6 +4464,35 @@
|
|||
"node": ">=8"
|
||||
}
|
||||
},
|
||||
"node_modules/assertion-error": {
|
||||
"version": "2.0.1",
|
||||
"resolved": "https://registry.npmjs.org/assertion-error/-/assertion-error-2.0.1.tgz",
|
||||
"integrity": "sha512-Izi8RQcffqCeNVgFigKli1ssklIbpHnCYc6AknXGYoB6grJqyeby7jv12JUQgmTAnIDnbck1uxksT4dzN3PWBA==",
|
||||
"dev": true,
|
||||
"license": "MIT",
|
||||
"engines": {
|
||||
"node": ">=12"
|
||||
}
|
||||
},
|
||||
"node_modules/ast-v8-to-istanbul": {
|
||||
"version": "0.3.10",
|
||||
"resolved": "https://registry.npmjs.org/ast-v8-to-istanbul/-/ast-v8-to-istanbul-0.3.10.tgz",
|
||||
"integrity": "sha512-p4K7vMz2ZSk3wN8l5o3y2bJAoZXT3VuJI5OLTATY/01CYWumWvwkUw0SqDBnNq6IiTO3qDa1eSQDibAV8g7XOQ==",
|
||||
"dev": true,
|
||||
"license": "MIT",
|
||||
"dependencies": {
|
||||
"@jridgewell/trace-mapping": "^0.3.31",
|
||||
"estree-walker": "^3.0.3",
|
||||
"js-tokens": "^9.0.1"
|
||||
}
|
||||
},
|
||||
"node_modules/ast-v8-to-istanbul/node_modules/js-tokens": {
|
||||
"version": "9.0.1",
|
||||
"resolved": "https://registry.npmjs.org/js-tokens/-/js-tokens-9.0.1.tgz",
|
||||
"integrity": "sha512-mxa9E9ITFOt0ban3j6L5MpjwegGz6lBQmM1IJkWeBZGcMxto50+eWdjC/52xDbS2vy0k7vIMK0Fe2wfL9OQSpQ==",
|
||||
"dev": true,
|
||||
"license": "MIT"
|
||||
},
|
||||
"node_modules/astring": {
|
||||
"version": "1.9.0",
|
||||
"resolved": "https://registry.npmjs.org/astring/-/astring-1.9.0.tgz",
|
||||
|
|
@ -5513,6 +5742,16 @@
|
|||
"url": "https://github.com/sponsors/wooorm"
|
||||
}
|
||||
},
|
||||
"node_modules/chai": {
|
||||
"version": "6.2.2",
|
||||
"resolved": "https://registry.npmjs.org/chai/-/chai-6.2.2.tgz",
|
||||
"integrity": "sha512-NUPRluOfOiTKBKvWPtSD4PhFvWCqOi0BGStNWs57X9js7XGTprSmFoz5F0tWhR4WPjNeR9jXqdC7/UpSJTnlRg==",
|
||||
"dev": true,
|
||||
"license": "MIT",
|
||||
"engines": {
|
||||
"node": ">=18"
|
||||
}
|
||||
},
|
||||
"node_modules/chalk": {
|
||||
"version": "4.1.2",
|
||||
"resolved": "https://registry.npmjs.org/chalk/-/chalk-4.1.2.tgz",
|
||||
|
|
@ -7248,6 +7487,16 @@
|
|||
"node": "^18.14.0 || ^20.0.0 || ^22.0.0 || >=24.0.0"
|
||||
}
|
||||
},
|
||||
"node_modules/expect-type": {
|
||||
"version": "1.3.0",
|
||||
"resolved": "https://registry.npmjs.org/expect-type/-/expect-type-1.3.0.tgz",
|
||||
"integrity": "sha512-knvyeauYhqjOYvQ66MznSMs83wmHrCycNEN6Ao+2AeYEfxUIkuiVxdEa1qlGEPK+We3n0THiDciYSsCcgW/DoA==",
|
||||
"dev": true,
|
||||
"license": "Apache-2.0",
|
||||
"engines": {
|
||||
"node": ">=12.0.0"
|
||||
}
|
||||
},
|
||||
"node_modules/expressive-code": {
|
||||
"version": "0.41.5",
|
||||
"resolved": "https://registry.npmjs.org/expressive-code/-/expressive-code-0.41.5.tgz",
|
||||
|
|
@ -7363,6 +7612,13 @@
|
|||
}
|
||||
}
|
||||
},
|
||||
"node_modules/fflate": {
|
||||
"version": "0.8.2",
|
||||
"resolved": "https://registry.npmjs.org/fflate/-/fflate-0.8.2.tgz",
|
||||
"integrity": "sha512-cPJU47OaAoCbg0pBvzsgpTPhmhqI5eJjh/JIu8tPj5q+T7iLvW/JAYUqmE7KOB4R1ZyEhzBaIQpQpardBF5z8A==",
|
||||
"dev": true,
|
||||
"license": "MIT"
|
||||
},
|
||||
"node_modules/figlet": {
|
||||
"version": "1.9.4",
|
||||
"resolved": "https://registry.npmjs.org/figlet/-/figlet-1.9.4.tgz",
|
||||
|
|
@ -11693,6 +11949,17 @@
|
|||
"url": "https://github.com/fb55/nth-check?sponsor=1"
|
||||
}
|
||||
},
|
||||
"node_modules/obug": {
|
||||
"version": "2.1.1",
|
||||
"resolved": "https://registry.npmjs.org/obug/-/obug-2.1.1.tgz",
|
||||
"integrity": "sha512-uTqF9MuPraAQ+IsnPf366RG4cP9RtUi7MLO1N3KEc+wb0a6yKpeL0lmk2IB1jY5KHPAlTc6T/JRdC/YqxHNwkQ==",
|
||||
"dev": true,
|
||||
"funding": [
|
||||
"https://github.com/sponsors/sxzz",
|
||||
"https://opencollective.com/debug"
|
||||
],
|
||||
"license": "MIT"
|
||||
},
|
||||
"node_modules/ofetch": {
|
||||
"version": "1.5.1",
|
||||
"resolved": "https://registry.npmjs.org/ofetch/-/ofetch-1.5.1.tgz",
|
||||
|
|
@ -12138,6 +12405,13 @@
|
|||
"url": "https://github.com/sponsors/sindresorhus"
|
||||
}
|
||||
},
|
||||
"node_modules/pathe": {
|
||||
"version": "2.0.3",
|
||||
"resolved": "https://registry.npmjs.org/pathe/-/pathe-2.0.3.tgz",
|
||||
"integrity": "sha512-WUjGcAqP1gQacoQe+OBJsFA7Ld4DyXuUIjZ5cc75cLHvJ7dtNsTugphxIADwspS+AraAUePCKrSVtPLFj/F88w==",
|
||||
"dev": true,
|
||||
"license": "MIT"
|
||||
},
|
||||
"node_modules/piccolore": {
|
||||
"version": "0.1.3",
|
||||
"resolved": "https://registry.npmjs.org/piccolore/-/piccolore-0.1.3.tgz",
|
||||
|
|
@ -13362,6 +13636,13 @@
|
|||
"@types/hast": "^3.0.4"
|
||||
}
|
||||
},
|
||||
"node_modules/siginfo": {
|
||||
"version": "2.0.0",
|
||||
"resolved": "https://registry.npmjs.org/siginfo/-/siginfo-2.0.0.tgz",
|
||||
"integrity": "sha512-ybx0WO1/8bSBLEWXZvEd7gMW3Sn3JFlW3TvX1nREbDLRNQNaeNN8WK0meBwPdAaOI7TtRRRJn/Es1zhrrCHu7g==",
|
||||
"dev": true,
|
||||
"license": "ISC"
|
||||
},
|
||||
"node_modules/signal-exit": {
|
||||
"version": "4.1.0",
|
||||
"resolved": "https://registry.npmjs.org/signal-exit/-/signal-exit-4.1.0.tgz",
|
||||
|
|
@ -13391,6 +13672,21 @@
|
|||
"dev": true,
|
||||
"license": "MIT"
|
||||
},
|
||||
"node_modules/sirv": {
|
||||
"version": "3.0.2",
|
||||
"resolved": "https://registry.npmjs.org/sirv/-/sirv-3.0.2.tgz",
|
||||
"integrity": "sha512-2wcC/oGxHis/BoHkkPwldgiPSYcpZK3JU28WoMVv55yHJgcZ8rlXvuG9iZggz+sU1d4bRgIGASwyWqjxu3FM0g==",
|
||||
"dev": true,
|
||||
"license": "MIT",
|
||||
"dependencies": {
|
||||
"@polka/url": "^1.0.0-next.24",
|
||||
"mrmime": "^2.0.0",
|
||||
"totalist": "^3.0.0"
|
||||
},
|
||||
"engines": {
|
||||
"node": ">=18"
|
||||
}
|
||||
},
|
||||
"node_modules/sisteransi": {
|
||||
"version": "1.0.5",
|
||||
"resolved": "https://registry.npmjs.org/sisteransi/-/sisteransi-1.0.5.tgz",
|
||||
|
|
@ -13601,6 +13897,20 @@
|
|||
"node": ">=8"
|
||||
}
|
||||
},
|
||||
"node_modules/stackback": {
|
||||
"version": "0.0.2",
|
||||
"resolved": "https://registry.npmjs.org/stackback/-/stackback-0.0.2.tgz",
|
||||
"integrity": "sha512-1XMJE5fQo1jGH6Y/7ebnwPOBEkIEnT4QF32d5R1+VXdXveM0IBMJt8zfaxX1P3QhVwrYe+576+jkANtSS2mBbw==",
|
||||
"dev": true,
|
||||
"license": "MIT"
|
||||
},
|
||||
"node_modules/std-env": {
|
||||
"version": "3.10.0",
|
||||
"resolved": "https://registry.npmjs.org/std-env/-/std-env-3.10.0.tgz",
|
||||
"integrity": "sha512-5GS12FdOZNliM5mAOxFRg7Ir0pWz8MdpYm6AY6VPkGpbA7ZzmbzNcBJQ0GPvvyWgcY7QAhCgf9Uy89I03faLkg==",
|
||||
"dev": true,
|
||||
"license": "MIT"
|
||||
},
|
||||
"node_modules/stream-replace-string": {
|
||||
"version": "2.0.0",
|
||||
"resolved": "https://registry.npmjs.org/stream-replace-string/-/stream-replace-string-2.0.0.tgz",
|
||||
|
|
@ -14015,6 +14325,13 @@
|
|||
"dev": true,
|
||||
"license": "MIT"
|
||||
},
|
||||
"node_modules/tinybench": {
|
||||
"version": "2.9.0",
|
||||
"resolved": "https://registry.npmjs.org/tinybench/-/tinybench-2.9.0.tgz",
|
||||
"integrity": "sha512-0+DUvqWMValLmha6lr4kD8iAMK1HzV0/aKnCtWb9v9641TnP/MFb7Pc2bxoxQjTXAErryXVgUOfv2YqNllqGeg==",
|
||||
"dev": true,
|
||||
"license": "MIT"
|
||||
},
|
||||
"node_modules/tinyexec": {
|
||||
"version": "1.0.2",
|
||||
"resolved": "https://registry.npmjs.org/tinyexec/-/tinyexec-1.0.2.tgz",
|
||||
|
|
@ -14042,6 +14359,16 @@
|
|||
"url": "https://github.com/sponsors/SuperchupuDev"
|
||||
}
|
||||
},
|
||||
"node_modules/tinyrainbow": {
|
||||
"version": "3.0.3",
|
||||
"resolved": "https://registry.npmjs.org/tinyrainbow/-/tinyrainbow-3.0.3.tgz",
|
||||
"integrity": "sha512-PSkbLUoxOFRzJYjjxHJt9xro7D+iilgMX/C9lawzVuYiIdcihh9DXmVibBe8lmcFrRi/VzlPjBxbN7rH24q8/Q==",
|
||||
"dev": true,
|
||||
"license": "MIT",
|
||||
"engines": {
|
||||
"node": ">=14.0.0"
|
||||
}
|
||||
},
|
||||
"node_modules/tmpl": {
|
||||
"version": "1.0.5",
|
||||
"resolved": "https://registry.npmjs.org/tmpl/-/tmpl-1.0.5.tgz",
|
||||
|
|
@ -14062,6 +14389,16 @@
|
|||
"node": ">=8.0"
|
||||
}
|
||||
},
|
||||
"node_modules/totalist": {
|
||||
"version": "3.0.1",
|
||||
"resolved": "https://registry.npmjs.org/totalist/-/totalist-3.0.1.tgz",
|
||||
"integrity": "sha512-sf4i37nQ2LBx4m3wB74y+ubopq6W/dIzXg0FDGjsYnZHVa1Da8FH853wlL2gtUhg+xJXjfk3kUZS3BRoQeoQBQ==",
|
||||
"dev": true,
|
||||
"license": "MIT",
|
||||
"engines": {
|
||||
"node": ">=6"
|
||||
}
|
||||
},
|
||||
"node_modules/trim-lines": {
|
||||
"version": "3.0.1",
|
||||
"resolved": "https://registry.npmjs.org/trim-lines/-/trim-lines-3.0.1.tgz",
|
||||
|
|
@ -14807,6 +15144,84 @@
|
|||
}
|
||||
}
|
||||
},
|
||||
"node_modules/vitest": {
|
||||
"version": "4.0.16",
|
||||
"resolved": "https://registry.npmjs.org/vitest/-/vitest-4.0.16.tgz",
|
||||
"integrity": "sha512-E4t7DJ9pESL6E3I8nFjPa4xGUd3PmiWDLsDztS2qXSJWfHtbQnwAWylaBvSNY48I3vr8PTqIZlyK8TE3V3CA4Q==",
|
||||
"dev": true,
|
||||
"license": "MIT",
|
||||
"dependencies": {
|
||||
"@vitest/expect": "4.0.16",
|
||||
"@vitest/mocker": "4.0.16",
|
||||
"@vitest/pretty-format": "4.0.16",
|
||||
"@vitest/runner": "4.0.16",
|
||||
"@vitest/snapshot": "4.0.16",
|
||||
"@vitest/spy": "4.0.16",
|
||||
"@vitest/utils": "4.0.16",
|
||||
"es-module-lexer": "^1.7.0",
|
||||
"expect-type": "^1.2.2",
|
||||
"magic-string": "^0.30.21",
|
||||
"obug": "^2.1.1",
|
||||
"pathe": "^2.0.3",
|
||||
"picomatch": "^4.0.3",
|
||||
"std-env": "^3.10.0",
|
||||
"tinybench": "^2.9.0",
|
||||
"tinyexec": "^1.0.2",
|
||||
"tinyglobby": "^0.2.15",
|
||||
"tinyrainbow": "^3.0.3",
|
||||
"vite": "^6.0.0 || ^7.0.0",
|
||||
"why-is-node-running": "^2.3.0"
|
||||
},
|
||||
"bin": {
|
||||
"vitest": "vitest.mjs"
|
||||
},
|
||||
"engines": {
|
||||
"node": "^20.0.0 || ^22.0.0 || >=24.0.0"
|
||||
},
|
||||
"funding": {
|
||||
"url": "https://opencollective.com/vitest"
|
||||
},
|
||||
"peerDependencies": {
|
||||
"@edge-runtime/vm": "*",
|
||||
"@opentelemetry/api": "^1.9.0",
|
||||
"@types/node": "^20.0.0 || ^22.0.0 || >=24.0.0",
|
||||
"@vitest/browser-playwright": "4.0.16",
|
||||
"@vitest/browser-preview": "4.0.16",
|
||||
"@vitest/browser-webdriverio": "4.0.16",
|
||||
"@vitest/ui": "4.0.16",
|
||||
"happy-dom": "*",
|
||||
"jsdom": "*"
|
||||
},
|
||||
"peerDependenciesMeta": {
|
||||
"@edge-runtime/vm": {
|
||||
"optional": true
|
||||
},
|
||||
"@opentelemetry/api": {
|
||||
"optional": true
|
||||
},
|
||||
"@types/node": {
|
||||
"optional": true
|
||||
},
|
||||
"@vitest/browser-playwright": {
|
||||
"optional": true
|
||||
},
|
||||
"@vitest/browser-preview": {
|
||||
"optional": true
|
||||
},
|
||||
"@vitest/browser-webdriverio": {
|
||||
"optional": true
|
||||
},
|
||||
"@vitest/ui": {
|
||||
"optional": true
|
||||
},
|
||||
"happy-dom": {
|
||||
"optional": true
|
||||
},
|
||||
"jsdom": {
|
||||
"optional": true
|
||||
}
|
||||
}
|
||||
},
|
||||
"node_modules/walker": {
|
||||
"version": "1.0.8",
|
||||
"resolved": "https://registry.npmjs.org/walker/-/walker-1.0.8.tgz",
|
||||
|
|
@ -14862,6 +15277,23 @@
|
|||
"node": ">=4"
|
||||
}
|
||||
},
|
||||
"node_modules/why-is-node-running": {
|
||||
"version": "2.3.0",
|
||||
"resolved": "https://registry.npmjs.org/why-is-node-running/-/why-is-node-running-2.3.0.tgz",
|
||||
"integrity": "sha512-hUrmaWBdVDcxvYqnyh09zunKzROWjbZTiNy8dBEjkS7ehEDQibXJ7XvlmtbwuTclUiIyN+CyXQD4Vmko8fNm8w==",
|
||||
"dev": true,
|
||||
"license": "MIT",
|
||||
"dependencies": {
|
||||
"siginfo": "^2.0.0",
|
||||
"stackback": "0.0.2"
|
||||
},
|
||||
"bin": {
|
||||
"why-is-node-running": "cli.js"
|
||||
},
|
||||
"engines": {
|
||||
"node": ">=8"
|
||||
}
|
||||
},
|
||||
"node_modules/widest-line": {
|
||||
"version": "3.1.0",
|
||||
"resolved": "https://registry.npmjs.org/widest-line/-/widest-line-3.1.0.tgz",
|
||||
|
|
|
|||
12
package.json
12
package.json
|
|
@ -45,10 +45,15 @@
|
|||
"release:minor": "gh workflow run \"Manual Release\" -f version_bump=minor",
|
||||
"release:patch": "gh workflow run \"Manual Release\" -f version_bump=patch",
|
||||
"release:watch": "gh run watch",
|
||||
"test": "npm run test:schemas && npm run test:install && npm run validate:schemas && npm run lint && npm run lint:md && npm run format:check",
|
||||
"test:coverage": "c8 --reporter=text --reporter=html npm run test:schemas",
|
||||
"test": "npm run test:schemas && npm run test:install && npm run test:unit && npm run validate:schemas && npm run lint && npm run lint:md && npm run format:check",
|
||||
"test:coverage": "vitest run --coverage",
|
||||
"test:install": "node test/test-installation-components.js",
|
||||
"test:integration": "vitest run test/integration",
|
||||
"test:quick": "vitest run --changed",
|
||||
"test:schemas": "node test/test-agent-schema.js",
|
||||
"test:ui": "vitest --ui",
|
||||
"test:unit": "vitest run",
|
||||
"test:unit:watch": "vitest",
|
||||
"validate:schemas": "node tools/validate-agent-schema.js"
|
||||
},
|
||||
"lint-staged": {
|
||||
|
|
@ -90,6 +95,8 @@
|
|||
"@astrojs/sitemap": "^3.6.0",
|
||||
"@astrojs/starlight": "^0.37.0",
|
||||
"@eslint/js": "^9.33.0",
|
||||
"@vitest/coverage-v8": "^4.0.16",
|
||||
"@vitest/ui": "^4.0.16",
|
||||
"archiver": "^7.0.1",
|
||||
"astro": "^5.16.0",
|
||||
"c8": "^10.1.3",
|
||||
|
|
@ -105,6 +112,7 @@
|
|||
"prettier": "^3.7.4",
|
||||
"prettier-plugin-packagejson": "^2.5.19",
|
||||
"sharp": "^0.33.5",
|
||||
"vitest": "^4.0.16",
|
||||
"yaml-eslint-parser": "^1.2.3",
|
||||
"yaml-lint": "^1.7.0"
|
||||
},
|
||||
|
|
|
|||
|
|
@ -1,33 +1,33 @@
|
|||
module,phase,name,code,sequence,workflow-file,command,required,agent,options,description,output-location,outputs,
|
||||
bmm,anytime,Document Project,DP,10,_bmad/bmm/workflows/document-project/workflow.yaml,bmad:bmm:document-project,false,analyst,Create Mode,"Analyze an existing project to produce useful documentation",project-knowledge,*,
|
||||
bmm,anytime,Tech Spec,TS,20,_bmad/bmm/workflows/bmad-quick-flow/quick-spec/workflow.md,bmad:bmm:tech-spec,false,quick-flow-solo-dev,Create Mode,"Do not suggest for potentially very complex things unless requested or if the user complains that they do not want to follow the extensive planning of the bmad method. Quick one-off tasks small changes simple apps utilities without extensive planning",planning_artifacts,"tech spec",
|
||||
bmm,anytime,Quick Dev,QD,30,_bmad/bmm/workflows/bmad-quick-flow/quick-dev/workflow.md,bmad:bmm:quick-dev,false,quick-flow-solo-dev,Create Mode,"Quick one-off tasks small changes simple apps utilities without extensive planning - Do not suggest for potentially very complex things unless requested or if the user complains that they do not want to follow the extensive planning of the bmad method, unless the user is already working through the implementation phase and just requests a 1 off things not already in the plan",,,
|
||||
bmm,anytime,Correct Course,CC,40,_bmad/bmm/workflows/4-implementation/correct-course/workflow.yaml,bmad:bmm:correct-course,false,sm,Create Mode,"Anytime: Navigate significant changes. May recommend start over update PRD redo architecture sprint planning or correct epics and stories",planning_artifacts,"change proposal",
|
||||
bmm,1-analysis,Brainstorm Project,BP,10,_bmad/core/workflows/brainstorming/workflow.md,bmad:bmm:brainstorming,false,analyst,"data=_bmad/bmm/data/project-context-template.md","Expert Guided Facilitation through a single or multiple techniques",planning_artifacts,"brainstorming session",
|
||||
bmm,1-analysis,Market Research,MR,20,_bmad/bmm/workflows/1-analysis/research/workflow.md,bmad:bmm:research,false,analyst,Create Mode,"research_type=""market""","Market analysis competitive landscape customer needs and trends","planning_artifacts|project-knowledge","research documents"
|
||||
bmm,1-analysis,Domain Research,DR,21,_bmad/bmm/workflows/1-analysis/research/workflow.md,bmad:bmm:research,false,analyst,Create Mode,"research_type=""domain""","Industry domain deep dive subject matter expertise and terminology","planning_artifacts|project-knowledge","research documents"
|
||||
bmm,1-analysis,Technical Research,TR,22,_bmad/bmm/workflows/1-analysis/research/workflow.md,bmad:bmm:research,false,analyst,Create Mode,"research_type=""technical""","Technical feasibility architecture options and implementation approaches","planning_artifacts|project-knowledge","research documents"
|
||||
bmm,1-analysis,Create Brief,CB,30,_bmad/bmm/workflows/1-analysis/create-product-brief/workflow.md,bmad:bmm:create-brief,false,analyst,Create Mode,"A guided experience to nail down your product idea",planning_artifacts,"product brief",
|
||||
bmm,1-analysis,Validate Brief,VB,40,_bmad/bmm/workflows/1-analysis/create-product-brief/workflow.md,bmad:bmm:validate-brief,false,analyst,Validate Mode,"Validates product brief completeness",planning_artifacts,"brief validation report",
|
||||
bmm,2-planning,Create PRD,CP,10,_bmad/bmm/workflows/2-plan-workflows/prd/workflow.md,bmad:bmm:create-prd,true,pm,Create Mode,"Expert led facilitation to produce your Product Requirements Document",planning_artifacts,prd,
|
||||
bmm,2-planning,Validate PRD,VP,20,_bmad/bmm/workflows/2-plan-workflows/prd/workflow.md,bmad:bmm:validate-prd,false,pm,Validate Mode,"Validate PRD is comprehensive lean well organized and cohesive",planning_artifacts,"prd validation report",
|
||||
bmm,2-planning,Create UX,CU,30,_bmad/bmm/workflows/2-plan-workflows/create-ux-design/workflow.md,bmad:bmm:create-ux,false,ux-designer,Create Mode,"Guidance through realizing the plan for your UX, strongly recommended if a UI is a primary piece of the proposed project",planning_artifacts,"ux design",
|
||||
bmm,2-planning,Validate UX,VU,40,_bmad/bmm/workflows/2-plan-workflows/create-ux-design/workflow.md,bmad:bmm:validate-ux,false,ux-designer,Validate Mode,"Validates UX design deliverables",planning_artifacts,"ux validation report",
|
||||
,,Create Dataflow,CDF,50,_bmad/bmm/workflows/excalidraw-diagrams/create-dataflow/workflow.yaml,bmad:bmm:create-dataflow,false,ux-designer,Create Mode,"Create data flow diagrams (DFD) in Excalidraw format - can be called standalone or during any workflow to add visual documentation",planning_artifacts,"dataflow diagram",
|
||||
,,Create Diagram,CED,51,_bmad/bmm/workflows/excalidraw-diagrams/create-diagram/workflow.yaml,bmad:bmm:create-diagram,false,ux-designer,Create Mode,"Create system architecture diagrams ERDs UML diagrams or general technical diagrams in Excalidraw format - use anytime or call from architecture workflow to add visual documentation",planning_artifacts,"diagram",
|
||||
,,Create Flowchart,CFC,52,_bmad/bmm/workflows/excalidraw-diagrams/create-flowchart/workflow.yaml,bmad:bmm:create-flowchart,false,ux-designer,Create Mode,"Create a flowchart visualization in Excalidraw format for processes pipelines or logic flows - use anytime or during architecture to add process documentation",planning_artifacts,"flowchart",
|
||||
,,Create Wireframe,CEW,53,_bmad/bmm/workflows/excalidraw-diagrams/create-wireframe/workflow.yaml,bmad:bmm:create-wireframe,false,ux-designer,Create Mode,"Create website or app wireframes in Excalidraw format - use anytime standalone or call from UX workflow to add UI mockups",planning_artifacts,"wireframe",
|
||||
bmm,3-solutioning,Create Architecture,CA,10,_bmad/bmm/workflows/3-solutioning/create-architecture/workflow.md,bmad:bmm:create-architecture,true,architect,Create Mode,"Guided Workflow to document technical decisions",planning_artifacts,architecture,
|
||||
bmm,3-solutioning,Validate Architecture,VA,20,_bmad/bmm/workflows/3-solutioning/create-architecture/workflow.md,bmad:bmm:validate-architecture,false,architect,Validate Mode,"Validates architecture completeness",planning_artifacts,"architecture validation report",
|
||||
bmm,3-solutioning,Create Epics and Stories,CE,30,_bmad/bmm/workflows/3-solutioning/create-epics-and-stories/workflow.md,bmad:bmm:create-epics-and-stories,true,pm,Create Mode,"Create the Epics and Stories Listing",planning_artifacts,"epics and stories",
|
||||
bmm,3-solutioning,Validate Epics and Stories,VE,40,_bmad/bmm/workflows/3-solutioning/create-epics-and-stories/workflow.md,bmad:bmm:validate-epics-and-stories,false,pm,Validate Mode,"Validates epics and stories completeness",planning_artifacts,"epics validation report",
|
||||
bmm,3-solutioning,Test Design,TD,50,_bmad/bmm/workflows/testarch/test-design/workflow.yaml,bmad:bmm:test-design,false,tea,Create Mode,"Create comprehensive test scenarios ahead of development, recommended if string test compliance or assurance is needed. Very critical for distributed applications with separate front ends and backends outside of a monorepo.",planning_artifacts,"test design",
|
||||
bmm,3-solutioning,Validate Test Design,VT,60,_bmad/bmm/workflows/testarch/test-design/workflow.yaml,bmad:bmm:validate-test-design,false,tea,Validate Mode,"Validates test design coverage",planning_artifacts,"test design validation report",
|
||||
bmm,3-solutioning,Implementation Readiness,IR,70,_bmad/bmm/workflows/3-solutioning/check-implementation-readiness/workflow.md,bmad:bmm:implementation-readiness,true,architect,Validate Mode,"Ensure PRD UX Architecture and Epics Stories are aligned",planning_artifacts,"readiness report",
|
||||
bmm,4-implementation,Sprint Planning,SP,10,_bmad/bmm/workflows/4-implementation/sprint-planning/workflow.yaml,bmad:bmm:sprint-planning,true,sm,Create Mode,"Generate sprint plan for development tasks - this kicks off the implementation phase by producing a plan the implementation agents will follow in sequence for every story in the plan.",implementation_artifacts,"sprint status",
|
||||
bmm,4-implementation,Sprint Status,SS,20,_bmad/bmm/workflows/4-implementation/sprint-status/workflow.yaml,bmad:bmm:sprint-status,false,sm,Create Mode,"Anytime: Summarize sprint status and route to next workflow",,,
|
||||
bmm,4-implementation,Create Story,CS,30,_bmad/bmm/workflows/4-implementation/create-story/workflow.yaml,bmad:bmm:create-story,true,sm,Create Mode,"Story cycle start: Prepare first found story in the sprint plan that is next, or if the command is run with a specific epic and story designation with context. Once complete, then VS then DS then CR then back to DS if needed or next CS or ER",implementation_artifacts,story,
|
||||
bmm,4-implementation,Validate Story,VS,35,_bmad/bmm/workflows/4-implementation/create-story/workflow.yaml,bmad:bmm:validate-story,false,sm,Validate Mode,"Validates story readiness and completeness before development work begins",implementation_artifacts,"story validation report",
|
||||
bmm,4-implementation,Dev Story,DS,40,_bmad/bmm/workflows/4-implementation/dev-story/workflow.yaml,bmad:bmm:dev-story,true,dev,Create Mode,"Story cycle: Execute story implementation tasks and tests then CR then back to DS if fixes needed",,,
|
||||
bmm,4-implementation,Code Review,CR,50,_bmad/bmm/workflows/4-implementation/code-review/workflow.yaml,bmad:bmm:code-review,false,dev,Create Mode,"Story cycle: If issues back to DS if approved then next CS or ER if epic complete",,,
|
||||
bmm,4-implementation,Retrospective,ER,60,_bmad/bmm/workflows/4-implementation/retrospective/workflow.yaml,bmad:bmm:retrospective,false,sm,Create Mode,"Optional at epic end: Review completed work lessons learned and next epic or if major issues consider CC",implementation_artifacts,retrospective,
|
||||
bmm,anytime,Document Project,DP,10,_bmad/bmm/workflows/document-project/workflow.yaml,bmad_bmm_document-project,false,analyst,Create Mode,"Analyze an existing project to produce useful documentation",project-knowledge,*,
|
||||
bmm,anytime,Tech Spec,TS,20,_bmad/bmm/workflows/bmad-quick-flow/quick-spec/workflow.md,bmad_bmm_tech-spec,false,quick-flow-solo-dev,Create Mode,"Do not suggest for potentially very complex things unless requested or if the user complains that they do not want to follow the extensive planning of the bmad method. Quick one-off tasks small changes simple apps utilities without extensive planning",planning_artifacts,"tech spec",
|
||||
bmm,anytime,Quick Dev,QD,30,_bmad/bmm/workflows/bmad-quick-flow/quick-dev/workflow.md,bmad_bmm_quick-dev,false,quick-flow-solo-dev,Create Mode,"Quick one-off tasks small changes simple apps utilities without extensive planning - Do not suggest for potentially very complex things unless requested or if the user complains that they do not want to follow the extensive planning of the bmad method, unless the user is already working through the implementation phase and just requests a 1 off things not already in the plan",,,
|
||||
bmm,anytime,Correct Course,CC,40,_bmad/bmm/workflows/4-implementation/correct-course/workflow.yaml,bmad_bmm_correct-course,false,sm,Create Mode,"Anytime: Navigate significant changes. May recommend start over update PRD redo architecture sprint planning or correct epics and stories",planning_artifacts,"change proposal",
|
||||
bmm,1-analysis,Brainstorm Project,BP,10,_bmad/core/workflows/brainstorming/workflow.md,bmad_bmm_brainstorming,false,analyst,"data=_bmad/bmm/data/project-context-template.md","Expert Guided Facilitation through a single or multiple techniques",planning_artifacts,"brainstorming session",
|
||||
bmm,1-analysis,Market Research,MR,20,_bmad/bmm/workflows/1-analysis/research/workflow.md,bmad_bmm_research,false,analyst,Create Mode,"research_type=""market""","Market analysis competitive landscape customer needs and trends","planning_artifacts|project-knowledge","research documents"
|
||||
bmm,1-analysis,Domain Research,DR,21,_bmad/bmm/workflows/1-analysis/research/workflow.md,bmad_bmm_research,false,analyst,Create Mode,"research_type=""domain""","Industry domain deep dive subject matter expertise and terminology","planning_artifacts|project-knowledge","research documents"
|
||||
bmm,1-analysis,Technical Research,TR,22,_bmad/bmm/workflows/1-analysis/research/workflow.md,bmad_bmm_research,false,analyst,Create Mode,"research_type=""technical""","Technical feasibility architecture options and implementation approaches","planning_artifacts|project-knowledge","research documents"
|
||||
bmm,1-analysis,Create Brief,CB,30,_bmad/bmm/workflows/1-analysis/create-product-brief/workflow.md,bmad_bmm_create-brief,false,analyst,Create Mode,"A guided experience to nail down your product idea",planning_artifacts,"product brief",
|
||||
bmm,1-analysis,Validate Brief,VB,40,_bmad/bmm/workflows/1-analysis/create-product-brief/workflow.md,bmad_bmm_validate-brief,false,analyst,Validate Mode,"Validates product brief completeness",planning_artifacts,"brief validation report",
|
||||
bmm,2-planning,Create PRD,CP,10,_bmad/bmm/workflows/2-plan-workflows/prd/workflow.md,bmad_bmm_create-prd,true,pm,Create Mode,"Expert led facilitation to produce your Product Requirements Document",planning_artifacts,prd,
|
||||
bmm,2-planning,Validate PRD,VP,20,_bmad/bmm/workflows/2-plan-workflows/prd/workflow.md,bmad_bmm_validate-prd,false,pm,Validate Mode,"Validate PRD is comprehensive lean well organized and cohesive",planning_artifacts,"prd validation report",
|
||||
bmm,2-planning,Create UX,CU,30,_bmad/bmm/workflows/2-plan-workflows/create-ux-design/workflow.md,bmad_bmm_create-ux,false,ux-designer,Create Mode,"Guidance through realizing the plan for your UX, strongly recommended if a UI is a primary piece of the proposed project",planning_artifacts,"ux design",
|
||||
bmm,2-planning,Validate UX,VU,40,_bmad/bmm/workflows/2-plan-workflows/create-ux-design/workflow.md,bmad_bmm_validate-ux,false,ux-designer,Validate Mode,"Validates UX design deliverables",planning_artifacts,"ux validation report",
|
||||
,,Create Dataflow,CDF,50,_bmad/bmm/workflows/excalidraw-diagrams/create-dataflow/workflow.yaml,bmad_bmm_create-dataflow,false,ux-designer,Create Mode,"Create data flow diagrams (DFD) in Excalidraw format - can be called standalone or during any workflow to add visual documentation",planning_artifacts,"dataflow diagram",
|
||||
,,Create Diagram,CED,51,_bmad/bmm/workflows/excalidraw-diagrams/create-diagram/workflow.yaml,bmad_bmm_create-diagram,false,ux-designer,Create Mode,"Create system architecture diagrams ERDs UML diagrams or general technical diagrams in Excalidraw format - use anytime or call from architecture workflow to add visual documentation",planning_artifacts,"diagram",
|
||||
,,Create Flowchart,CFC,52,_bmad/bmm/workflows/excalidraw-diagrams/create-flowchart/workflow.yaml,bmad_bmm_create-flowchart,false,ux-designer,Create Mode,"Create a flowchart visualization in Excalidraw format for processes pipelines or logic flows - use anytime or during architecture to add process documentation",planning_artifacts,"flowchart",
|
||||
,,Create Wireframe,CEW,53,_bmad/bmm/workflows/excalidraw-diagrams/create-wireframe/workflow.yaml,bmad_bmm_create-wireframe,false,ux-designer,Create Mode,"Create website or app wireframes in Excalidraw format - use anytime standalone or call from UX workflow to add UI mockups",planning_artifacts,"wireframe",
|
||||
bmm,3-solutioning,Create Architecture,CA,10,_bmad/bmm/workflows/3-solutioning/create-architecture/workflow.md,bmad_bmm_create-architecture,true,architect,Create Mode,"Guided Workflow to document technical decisions",planning_artifacts,architecture,
|
||||
bmm,3-solutioning,Validate Architecture,VA,20,_bmad/bmm/workflows/3-solutioning/create-architecture/workflow.md,bmad_bmm_validate-architecture,false,architect,Validate Mode,"Validates architecture completeness",planning_artifacts,"architecture validation report",
|
||||
bmm,3-solutioning,Create Epics and Stories,CE,30,_bmad/bmm/workflows/3-solutioning/create-epics-and-stories/workflow.md,bmad_bmm_create-epics-and-stories,true,pm,Create Mode,"Create the Epics and Stories Listing",planning_artifacts,"epics and stories",
|
||||
bmm,3-solutioning,Validate Epics and Stories,VE,40,_bmad/bmm/workflows/3-solutioning/create-epics-and-stories/workflow.md,bmad_bmm_validate-epics-and-stories,false,pm,Validate Mode,"Validates epics and stories completeness",planning_artifacts,"epics validation report",
|
||||
bmm,3-solutioning,Test Design,TD,50,_bmad/bmm/workflows/testarch/test-design/workflow.yaml,bmad_bmm_test-design,false,tea,Create Mode,"Create comprehensive test scenarios ahead of development, recommended if string test compliance or assurance is needed. Very critical for distributed applications with separate front ends and backends outside of a monorepo.",planning_artifacts,"test design",
|
||||
bmm,3-solutioning,Validate Test Design,VT,60,_bmad/bmm/workflows/testarch/test-design/workflow.yaml,bmad_bmm_validate-test-design,false,tea,Validate Mode,"Validates test design coverage",planning_artifacts,"test design validation report",
|
||||
bmm,3-solutioning,Implementation Readiness,IR,70,_bmad/bmm/workflows/3-solutioning/check-implementation-readiness/workflow.md,bmad_bmm_implementation-readiness,true,architect,Validate Mode,"Ensure PRD UX Architecture and Epics Stories are aligned",planning_artifacts,"readiness report",
|
||||
bmm,4-implementation,Sprint Planning,SP,10,_bmad/bmm/workflows/4-implementation/sprint-planning/workflow.yaml,bmad_bmm_sprint-planning,true,sm,Create Mode,"Generate sprint plan for development tasks - this kicks off the implementation phase by producing a plan the implementation agents will follow in sequence for every story in the plan.",implementation_artifacts,"sprint status",
|
||||
bmm,4-implementation,Sprint Status,SS,20,_bmad/bmm/workflows/4-implementation/sprint-status/workflow.yaml,bmad_bmm_sprint-status,false,sm,Create Mode,"Anytime: Summarize sprint status and route to next workflow",,,
|
||||
bmm,4-implementation,Create Story,CS,30,_bmad/bmm/workflows/4-implementation/create-story/workflow.yaml,bmad_bmm_create-story,true,sm,Create Mode,"Story cycle start: Prepare first found story in the sprint plan that is next, or if the command is run with a specific epic and story designation with context. Once complete, then VS then DS then CR then back to DS if needed or next CS or ER",implementation_artifacts,story,
|
||||
bmm,4-implementation,Validate Story,VS,35,_bmad/bmm/workflows/4-implementation/create-story/workflow.yaml,bmad_bmm_validate-story,false,sm,Validate Mode,"Validates story readiness and completeness before development work begins",implementation_artifacts,"story validation report",
|
||||
bmm,4-implementation,Dev Story,DS,40,_bmad/bmm/workflows/4-implementation/dev-story/workflow.yaml,bmad_bmm_dev-story,true,dev,Create Mode,"Story cycle: Execute story implementation tasks and tests then CR then back to DS if fixes needed",,,
|
||||
bmm,4-implementation,Code Review,CR,50,_bmad/bmm/workflows/4-implementation/code-review/workflow.yaml,bmad_bmm_code-review,false,dev,Create Mode,"Story cycle: If issues back to DS if approved then next CS or ER if epic complete",,,
|
||||
bmm,4-implementation,Retrospective,ER,60,_bmad/bmm/workflows/4-implementation/retrospective/workflow.yaml,bmad_bmm_retrospective,false,sm,Create Mode,"Optional at epic end: Review completed work lessons learned and next epic or if major issues consider CC",implementation_artifacts,retrospective,
|
||||
|
|
|
|||
|
|
|
@ -1,11 +1,11 @@
|
|||
module,phase,name,code,sequence,workflow-file,command,required,agent,options,description,output-location,outputs
|
||||
core,,Advanced Elicitation,AE,10,_bmad/core/workflows/advanced-elicitation/workflow.xml,bmad:advanced-elicitation,false,,,"Apply elicitation methods iteratively to enhance content being generated, presenting options and allowing reshuffle or full method listing for comprehensive content improvement",,
|
||||
core,,Brainstorming,BS,20,_bmad/core/workflows/brainstorming/workflow.md,bmad:brainstorming,false,analyst,,Facilitate interactive brainstorming sessions using diverse creative techniques and ideation methods,{output_folder}/brainstorming/brainstorming-session-{{date}}.md,,
|
||||
core,,Party Mode,PM,30,_bmad/core/workflows/party-mode/workflow.md,bmad:party-mode,false,party-mode facilitator,,Orchestrates group discussions between all installed BMAD agents enabling natural multi-agent conversations,,
|
||||
core,,bmad-help,BH,40,_bmad/core/tasks/bmad-help.md,bmad:help,false,system,,Get unstuck by showing what workflow steps come next or answering questions about what to do in the BMad Method,,
|
||||
core,,Index Docs,ID,50,_bmad/core/tasks/index-docs.xml,bmad:index-docs,false,llm,,Generates or updates an index.md of all documents in the specified directory,,
|
||||
core,,Execute Workflow,WF,60,_bmad/core/tasks/workflow.xml,bmad:workflow,false,llm,,Execute given workflow by loading its configuration following instructions and producing output,,
|
||||
core,,Shard Document,SD,70,_bmad/core/tasks/shard-doc.xml,bmad:shard-doc,false,llm,,Splits large markdown documents into smaller organized files based on level 2 sections,,
|
||||
core,,Editorial Review - Prose,EP,80,_bmad/core/tasks/editorial-review-prose.xml,bmad:editorial-review-prose,false,llm,reader_type,Clinical copy-editor that reviews text for communication issues,,"three-column markdown table with suggested fixes",
|
||||
core,,Editorial Review - Structure,ES,90,_bmad/core/tasks/editorial-review-structure.xml,bmad:editorial-review-structure,false,llm,,Structural editor that proposes cuts reorganization and simplification while preserving comprehension,,
|
||||
core,,Adversarial Review (General),AR,100,_bmad/core/tasks/review-adversarial-general.xml,bmad:review-adversarial-general,false,llm,,Cynically review content and produce findings,,
|
||||
core,,Advanced Elicitation,AE,10,_bmad/core/workflows/advanced-elicitation/workflow.xml,bmad_advanced-elicitation,false,,,"Apply elicitation methods iteratively to enhance content being generated, presenting options and allowing reshuffle or full method listing for comprehensive content improvement",,
|
||||
core,,Brainstorming,BS,20,_bmad/core/workflows/brainstorming/workflow.md,bmad_brainstorming,false,analyst,,Facilitate interactive brainstorming sessions using diverse creative techniques and ideation methods,{output_folder}/brainstorming/brainstorming-session-{{date}}.md,,
|
||||
core,,Party Mode,PM,30,_bmad/core/workflows/party-mode/workflow.md,bmad_party-mode,false,party-mode facilitator,,Orchestrates group discussions between all installed BMAD agents enabling natural multi-agent conversations,,
|
||||
core,,bmad-help,BH,40,_bmad/core/tasks/bmad-help.md,bmad_help,false,system,,Get unstuck by showing what workflow steps come next or answering questions about what to do in the BMad Method,,
|
||||
core,,Index Docs,ID,50,_bmad/core/tasks/index-docs.xml,bmad_index-docs,false,llm,,Generates or updates an index.md of all documents in the specified directory,,
|
||||
core,,Execute Workflow,WF,60,_bmad/core/tasks/workflow.xml,bmad_workflow,false,llm,,Execute given workflow by loading its configuration following instructions and producing output,,
|
||||
core,,Shard Document,SD,70,_bmad/core/tasks/shard-doc.xml,bmad_shard-doc,false,llm,,Splits large markdown documents into smaller organized files based on level 2 sections,,
|
||||
core,,Editorial Review - Prose,EP,80,_bmad/core/tasks/editorial-review-prose.xml,bmad_editorial-review-prose,false,llm,reader_type,Clinical copy-editor that reviews text for communication issues,,"three-column markdown table with suggested fixes",
|
||||
core,,Editorial Review - Structure,ES,90,_bmad/core/tasks/editorial-review-structure.xml,bmad_editorial-review-structure,false,llm,,Structural editor that proposes cuts reorganization and simplification while preserving comprehension,,
|
||||
core,,Adversarial Review (General),AR,100,_bmad/core/tasks/review-adversarial-general.xml,bmad_review-adversarial-general,false,llm,,Cynically review content and produce findings,,
|
||||
|
|
|
|||
|
Can't render this file because it has a wrong number of fields in line 3.
|
|
|
@ -6,6 +6,8 @@
|
|||
|
||||
<inputs>
|
||||
<input name="content" desc="Content to review - diff, spec, story, doc, or any artifact" />
|
||||
<input name="also_consider" required="false"
|
||||
desc="Optional areas to keep in mind during review alongside normal adversarial analysis" />
|
||||
</inputs>
|
||||
|
||||
<llm critical="true">
|
||||
|
|
|
|||
|
|
@ -0,0 +1,56 @@
|
|||
# Adversarial Review Test Suite
|
||||
|
||||
Tests for the `also_consider` optional input in `review-adversarial-general.xml`.
|
||||
|
||||
## Purpose
|
||||
|
||||
Evaluate whether the `also_consider` input gently nudges the reviewer toward specific areas without overriding normal adversarial analysis.
|
||||
|
||||
## Test Content
|
||||
|
||||
All tests use `sample-content.md` - a deliberately imperfect User Authentication API doc with:
|
||||
|
||||
- Vague error handling section
|
||||
- Missing rate limit details
|
||||
- No token expiration info
|
||||
- Password in plain text example
|
||||
- Missing authentication headers
|
||||
- No error response examples
|
||||
|
||||
## Running Tests
|
||||
|
||||
For each test case in `test-cases.yaml`, invoke the adversarial review task.
|
||||
|
||||
### Manual Test Invocation
|
||||
|
||||
```
|
||||
Review this content using the adversarial review task:
|
||||
|
||||
<content>
|
||||
[paste sample-content.md]
|
||||
</content>
|
||||
|
||||
<also_consider>
|
||||
[paste items from test case, or omit for TC01]
|
||||
</also_consider>
|
||||
```
|
||||
|
||||
## Evaluation Criteria
|
||||
|
||||
For each test, note:
|
||||
|
||||
1. **Total findings** - Still hitting ~10 issues?
|
||||
2. **Distribution** - Are findings spread across concerns or clustered?
|
||||
3. **Relevance** - Do findings relate to `also_consider` items when provided?
|
||||
4. **Balance** - Are `also_consider` findings elevated over others, or naturally mixed?
|
||||
5. **Quality** - Are findings actionable regardless of source?
|
||||
|
||||
## Expected Outcomes
|
||||
|
||||
- **TC01 (baseline)**: Generic spread of findings
|
||||
- **TC02-TC05 (domain-focused)**: Some findings align with domain, others still organic
|
||||
- **TC06 (single item)**: Light influence, not dominant
|
||||
- **TC07 (vague items)**: Minimal change from baseline
|
||||
- **TC08 (specific items)**: Direct answers if gaps exist
|
||||
- **TC09 (mixed)**: Balanced across domains
|
||||
- **TC10 (contradictory)**: Graceful handling
|
||||
|
|
@ -0,0 +1,46 @@
|
|||
# User Authentication API
|
||||
|
||||
## Overview
|
||||
|
||||
This API provides endpoints for user authentication and session management.
|
||||
|
||||
## Endpoints
|
||||
|
||||
### POST /api/auth/login
|
||||
|
||||
Authenticates a user and returns a token.
|
||||
|
||||
**Request Body:**
|
||||
```json
|
||||
{
|
||||
"email": "user@example.com",
|
||||
"password": "password123"
|
||||
}
|
||||
```
|
||||
|
||||
**Response:**
|
||||
```json
|
||||
{
|
||||
"token": "eyJhbGciOiJIUzI1NiIs...",
|
||||
"user": {
|
||||
"id": 1,
|
||||
"email": "user@example.com"
|
||||
}
|
||||
}
|
||||
```
|
||||
|
||||
### POST /api/auth/logout
|
||||
|
||||
Logs out the current user.
|
||||
|
||||
### GET /api/auth/me
|
||||
|
||||
Returns the current user's profile.
|
||||
|
||||
## Error Handling
|
||||
|
||||
Errors return appropriate HTTP status codes.
|
||||
|
||||
## Rate Limiting
|
||||
|
||||
Rate limiting is applied to prevent abuse.
|
||||
|
|
@ -0,0 +1,103 @@
|
|||
# Test Cases for review-adversarial-general.xml with also_consider input
|
||||
#
|
||||
# Purpose: Evaluate how the optional also_consider input influences review findings
|
||||
# Content: All tests use sample-content.md (User Authentication API docs)
|
||||
#
|
||||
# To run: Manually invoke the task with each configuration and compare outputs
|
||||
|
||||
test_cases:
|
||||
# BASELINE - No also_consider
|
||||
- id: TC01
|
||||
name: "Baseline - no also_consider"
|
||||
description: "Control test with no also_consider input"
|
||||
also_consider: null
|
||||
expected_behavior: "Generic adversarial findings across all aspects"
|
||||
|
||||
# DOCUMENTATION-FOCUSED
|
||||
- id: TC02
|
||||
name: "Documentation - reader confusion"
|
||||
description: "Nudge toward documentation UX issues"
|
||||
also_consider:
|
||||
- What would confuse a first-time reader?
|
||||
- What questions are left unanswered?
|
||||
- What could be interpreted multiple ways?
|
||||
- What jargon is unexplained?
|
||||
expected_behavior: "More findings about clarity, completeness, reader experience"
|
||||
|
||||
- id: TC03
|
||||
name: "Documentation - examples and usage"
|
||||
description: "Nudge toward practical usage gaps"
|
||||
also_consider:
|
||||
- Missing code examples
|
||||
- Unclear usage patterns
|
||||
- Edge cases not documented
|
||||
expected_behavior: "More findings about practical application gaps"
|
||||
|
||||
# SECURITY-FOCUSED
|
||||
- id: TC04
|
||||
name: "Security review"
|
||||
description: "Nudge toward security concerns"
|
||||
also_consider:
|
||||
- Authentication vulnerabilities
|
||||
- Token handling issues
|
||||
- Input validation gaps
|
||||
- Information disclosure risks
|
||||
expected_behavior: "More security-related findings"
|
||||
|
||||
# API DESIGN-FOCUSED
|
||||
- id: TC05
|
||||
name: "API design"
|
||||
description: "Nudge toward API design best practices"
|
||||
also_consider:
|
||||
- REST conventions not followed
|
||||
- Inconsistent response formats
|
||||
- Missing pagination or filtering
|
||||
- Versioning concerns
|
||||
expected_behavior: "More API design pattern findings"
|
||||
|
||||
# SINGLE ITEM
|
||||
- id: TC06
|
||||
name: "Single item - error handling"
|
||||
description: "Test with just one also_consider item"
|
||||
also_consider:
|
||||
- Error handling completeness
|
||||
expected_behavior: "Some emphasis on error handling while still covering other areas"
|
||||
|
||||
# BROAD/VAGUE
|
||||
- id: TC07
|
||||
name: "Broad items"
|
||||
description: "Test with vague also_consider items"
|
||||
also_consider:
|
||||
- Quality issues
|
||||
- Things that seem off
|
||||
expected_behavior: "Minimal change from baseline - items too vague to steer"
|
||||
|
||||
# VERY SPECIFIC
|
||||
- id: TC08
|
||||
name: "Very specific items"
|
||||
description: "Test with highly specific also_consider items"
|
||||
also_consider:
|
||||
- Is the JWT token expiration documented?
|
||||
- Are refresh token mechanics explained?
|
||||
- What happens on concurrent sessions?
|
||||
expected_behavior: "Specific findings addressing these exact questions if gaps exist"
|
||||
|
||||
# MIXED DOMAINS
|
||||
- id: TC09
|
||||
name: "Mixed domain concerns"
|
||||
description: "Test with items from different domains"
|
||||
also_consider:
|
||||
- Security vulnerabilities
|
||||
- Reader confusion points
|
||||
- API design inconsistencies
|
||||
- Performance implications
|
||||
expected_behavior: "Balanced findings across multiple domains"
|
||||
|
||||
# CONTRADICTORY/UNUSUAL
|
||||
- id: TC10
|
||||
name: "Contradictory items"
|
||||
description: "Test resilience with odd inputs"
|
||||
also_consider:
|
||||
- Things that are too detailed
|
||||
- Things that are not detailed enough
|
||||
expected_behavior: "Reviewer handles gracefully, finds issues in both directions"
|
||||
|
|
@ -0,0 +1,83 @@
|
|||
import fs from 'fs-extra';
|
||||
import path from 'node:path';
|
||||
import { fileURLToPath } from 'node:url';
|
||||
import yaml from 'yaml';
|
||||
import xml2js from 'xml2js';
|
||||
|
||||
// Get the directory of this module
|
||||
const __filename = fileURLToPath(import.meta.url);
|
||||
const __dirname = path.dirname(__filename);
|
||||
|
||||
/**
|
||||
* Load a fixture file
|
||||
* @param {string} fixturePath - Relative path to fixture from test/fixtures/
|
||||
* @returns {Promise<string>} File content
|
||||
*/
|
||||
export async function loadFixture(fixturePath) {
|
||||
const fullPath = path.join(__dirname, '..', 'fixtures', fixturePath);
|
||||
return fs.readFile(fullPath, 'utf8');
|
||||
}
|
||||
|
||||
/**
|
||||
* Load a YAML fixture
|
||||
* @param {string} fixturePath - Relative path to YAML fixture
|
||||
* @returns {Promise<Object>} Parsed YAML object
|
||||
*/
|
||||
export async function loadYamlFixture(fixturePath) {
|
||||
const content = await loadFixture(fixturePath);
|
||||
return yaml.parse(content);
|
||||
}
|
||||
|
||||
/**
|
||||
* Load an XML fixture
|
||||
* @param {string} fixturePath - Relative path to XML fixture
|
||||
* @returns {Promise<Object>} Parsed XML object
|
||||
*/
|
||||
export async function loadXmlFixture(fixturePath) {
|
||||
const content = await loadFixture(fixturePath);
|
||||
return xml2js.parseStringPromise(content);
|
||||
}
|
||||
|
||||
/**
|
||||
* Load a JSON fixture
|
||||
* @param {string} fixturePath - Relative path to JSON fixture
|
||||
* @returns {Promise<Object>} Parsed JSON object
|
||||
*/
|
||||
export async function loadJsonFixture(fixturePath) {
|
||||
const content = await loadFixture(fixturePath);
|
||||
return JSON.parse(content);
|
||||
}
|
||||
|
||||
/**
|
||||
* Check if a fixture file exists
|
||||
* @param {string} fixturePath - Relative path to fixture
|
||||
* @returns {Promise<boolean>} True if fixture exists
|
||||
*/
|
||||
export async function fixtureExists(fixturePath) {
|
||||
const fullPath = path.join(__dirname, '..', 'fixtures', fixturePath);
|
||||
return fs.pathExists(fullPath);
|
||||
}
|
||||
|
||||
/**
|
||||
* Get the full path to a fixture
|
||||
* @param {string} fixturePath - Relative path to fixture
|
||||
* @returns {string} Full path to fixture
|
||||
*/
|
||||
export function getFixturePath(fixturePath) {
|
||||
return path.join(__dirname, '..', 'fixtures', fixturePath);
|
||||
}
|
||||
|
||||
/**
|
||||
* Create a test file in a temporary directory
|
||||
* (Re-exported from temp-dir for convenience)
|
||||
* @param {string} tmpDir - Temporary directory path
|
||||
* @param {string} relativePath - Relative path for the file
|
||||
* @param {string} content - File content
|
||||
* @returns {Promise<string>} Full path to the created file
|
||||
*/
|
||||
export async function createTestFile(tmpDir, relativePath, content) {
|
||||
const fullPath = path.join(tmpDir, relativePath);
|
||||
await fs.ensureDir(path.dirname(fullPath));
|
||||
await fs.writeFile(fullPath, content, 'utf8');
|
||||
return fullPath;
|
||||
}
|
||||
|
|
@ -0,0 +1,82 @@
|
|||
import fs from 'fs-extra';
|
||||
import path from 'node:path';
|
||||
import os from 'node:os';
|
||||
import { randomUUID } from 'node:crypto';
|
||||
|
||||
/**
|
||||
* Create a temporary directory for testing
|
||||
* @param {string} prefix - Prefix for the directory name
|
||||
* @returns {Promise<string>} Path to the created temporary directory
|
||||
*/
|
||||
export async function createTempDir(prefix = 'bmad-test-') {
|
||||
const tmpDir = path.join(os.tmpdir(), `${prefix}${randomUUID()}`);
|
||||
await fs.ensureDir(tmpDir);
|
||||
return tmpDir;
|
||||
}
|
||||
|
||||
/**
|
||||
* Clean up a temporary directory
|
||||
* @param {string} tmpDir - Path to the temporary directory
|
||||
* @returns {Promise<void>}
|
||||
*/
|
||||
export async function cleanupTempDir(tmpDir) {
|
||||
if (await fs.pathExists(tmpDir)) {
|
||||
await fs.remove(tmpDir);
|
||||
}
|
||||
}
|
||||
|
||||
/**
|
||||
* Execute a test function with a temporary directory
|
||||
* Automatically creates and cleans up the directory
|
||||
* @param {Function} testFn - Test function that receives the temp directory path
|
||||
* @returns {Promise<void>}
|
||||
*/
|
||||
export async function withTempDir(testFn) {
|
||||
const tmpDir = await createTempDir();
|
||||
try {
|
||||
await testFn(tmpDir);
|
||||
} finally {
|
||||
await cleanupTempDir(tmpDir);
|
||||
}
|
||||
}
|
||||
|
||||
/**
|
||||
* Create a test file in a temporary directory
|
||||
* @param {string} tmpDir - Temporary directory path
|
||||
* @param {string} relativePath - Relative path for the file
|
||||
* @param {string} content - File content
|
||||
* @returns {Promise<string>} Full path to the created file
|
||||
*/
|
||||
export async function createTestFile(tmpDir, relativePath, content) {
|
||||
const fullPath = path.join(tmpDir, relativePath);
|
||||
await fs.ensureDir(path.dirname(fullPath));
|
||||
await fs.writeFile(fullPath, content, 'utf8');
|
||||
return fullPath;
|
||||
}
|
||||
|
||||
/**
|
||||
* Create multiple test files in a temporary directory
|
||||
* @param {string} tmpDir - Temporary directory path
|
||||
* @param {Object} files - Object mapping relative paths to content
|
||||
* @returns {Promise<string[]>} Array of created file paths
|
||||
*/
|
||||
export async function createTestFiles(tmpDir, files) {
|
||||
const paths = [];
|
||||
for (const [relativePath, content] of Object.entries(files)) {
|
||||
const fullPath = await createTestFile(tmpDir, relativePath, content);
|
||||
paths.push(fullPath);
|
||||
}
|
||||
return paths;
|
||||
}
|
||||
|
||||
/**
|
||||
* Create a test directory structure
|
||||
* @param {string} tmpDir - Temporary directory path
|
||||
* @param {string[]} dirs - Array of relative directory paths
|
||||
* @returns {Promise<void>}
|
||||
*/
|
||||
export async function createTestDirs(tmpDir, dirs) {
|
||||
for (const dir of dirs) {
|
||||
await fs.ensureDir(path.join(tmpDir, dir));
|
||||
}
|
||||
}
|
||||
|
|
@ -0,0 +1,26 @@
|
|||
import { beforeEach, afterEach } from 'vitest';
|
||||
|
||||
// Global test setup
|
||||
beforeEach(() => {
|
||||
// Reset environment variables to prevent test pollution
|
||||
// Store original env for restoration
|
||||
if (!globalThis.__originalEnv) {
|
||||
globalThis.__originalEnv = { ...process.env };
|
||||
}
|
||||
});
|
||||
|
||||
afterEach(async () => {
|
||||
// Restore original environment variables
|
||||
if (globalThis.__originalEnv) {
|
||||
process.env = { ...globalThis.__originalEnv };
|
||||
}
|
||||
|
||||
// Any global cleanup can go here
|
||||
});
|
||||
|
||||
// Increase timeout for file system operations
|
||||
// (Individual tests can override this if needed)
|
||||
const DEFAULT_TIMEOUT = 10_000; // 10 seconds
|
||||
|
||||
// Make timeout available globally
|
||||
globalThis.DEFAULT_TEST_TIMEOUT = DEFAULT_TIMEOUT;
|
||||
|
|
@ -0,0 +1,428 @@
|
|||
import { describe, it, expect, beforeEach, afterEach } from 'vitest';
|
||||
import { Config } from '../../../tools/cli/lib/config.js';
|
||||
import { createTempDir, cleanupTempDir, createTestFile } from '../../helpers/temp-dir.js';
|
||||
import fs from 'fs-extra';
|
||||
import path from 'node:path';
|
||||
import yaml from 'yaml';
|
||||
|
||||
describe('Config', () => {
|
||||
let tmpDir;
|
||||
let config;
|
||||
|
||||
beforeEach(async () => {
|
||||
tmpDir = await createTempDir();
|
||||
config = new Config();
|
||||
});
|
||||
|
||||
afterEach(async () => {
|
||||
await cleanupTempDir(tmpDir);
|
||||
});
|
||||
|
||||
describe('loadYaml()', () => {
|
||||
it('should load and parse YAML file', async () => {
|
||||
const yamlContent = {
|
||||
key1: 'value1',
|
||||
key2: { nested: 'value2' },
|
||||
array: [1, 2, 3],
|
||||
};
|
||||
|
||||
const configPath = path.join(tmpDir, 'config.yaml');
|
||||
await fs.writeFile(configPath, yaml.stringify(yamlContent));
|
||||
|
||||
const result = await config.loadYaml(configPath);
|
||||
|
||||
expect(result).toEqual(yamlContent);
|
||||
});
|
||||
|
||||
it('should throw error for non-existent file', async () => {
|
||||
const nonExistent = path.join(tmpDir, 'missing.yaml');
|
||||
|
||||
await expect(config.loadYaml(nonExistent)).rejects.toThrow('Configuration file not found');
|
||||
});
|
||||
|
||||
it('should handle Unicode content', async () => {
|
||||
const yamlContent = {
|
||||
chinese: '测试',
|
||||
russian: 'Тест',
|
||||
japanese: 'テスト',
|
||||
};
|
||||
|
||||
const configPath = path.join(tmpDir, 'unicode.yaml');
|
||||
await fs.writeFile(configPath, yaml.stringify(yamlContent));
|
||||
|
||||
const result = await config.loadYaml(configPath);
|
||||
|
||||
expect(result.chinese).toBe('测试');
|
||||
expect(result.russian).toBe('Тест');
|
||||
expect(result.japanese).toBe('テスト');
|
||||
});
|
||||
});
|
||||
|
||||
// Note: saveYaml() is not tested because it uses yaml.dump() which doesn't exist
|
||||
// in yaml 2.7.0 (should use yaml.stringify). This method is never called in production
|
||||
// and represents dead code with a latent bug.
|
||||
|
||||
describe('processConfig()', () => {
|
||||
it('should replace {project-root} placeholder', async () => {
|
||||
const configPath = path.join(tmpDir, 'config.txt');
|
||||
await fs.writeFile(configPath, 'Root is {project-root}/bmad');
|
||||
|
||||
await config.processConfig(configPath, { root: '/home/user/project' });
|
||||
|
||||
const content = await fs.readFile(configPath, 'utf8');
|
||||
expect(content).toBe('Root is /home/user/project/bmad');
|
||||
});
|
||||
|
||||
it('should replace {module} placeholder', async () => {
|
||||
const configPath = path.join(tmpDir, 'config.txt');
|
||||
await fs.writeFile(configPath, 'Module: {module}');
|
||||
|
||||
await config.processConfig(configPath, { module: 'bmm' });
|
||||
|
||||
const content = await fs.readFile(configPath, 'utf8');
|
||||
expect(content).toBe('Module: bmm');
|
||||
});
|
||||
|
||||
it('should replace {version} placeholder with package version', async () => {
|
||||
const configPath = path.join(tmpDir, 'config.txt');
|
||||
await fs.writeFile(configPath, 'Version: {version}');
|
||||
|
||||
await config.processConfig(configPath);
|
||||
|
||||
const content = await fs.readFile(configPath, 'utf8');
|
||||
expect(content).toMatch(/Version: \d+\.\d+\.\d+/); // Semver format
|
||||
});
|
||||
|
||||
it('should replace {date} placeholder with current date', async () => {
|
||||
const configPath = path.join(tmpDir, 'config.txt');
|
||||
await fs.writeFile(configPath, 'Date: {date}');
|
||||
|
||||
await config.processConfig(configPath);
|
||||
|
||||
const content = await fs.readFile(configPath, 'utf8');
|
||||
expect(content).toMatch(/Date: \d{4}-\d{2}-\d{2}/); // YYYY-MM-DD
|
||||
});
|
||||
|
||||
it('should replace multiple placeholders', async () => {
|
||||
const configPath = path.join(tmpDir, 'config.txt');
|
||||
await fs.writeFile(configPath, 'Root: {project-root}, Module: {module}, Version: {version}');
|
||||
|
||||
await config.processConfig(configPath, {
|
||||
root: '/project',
|
||||
module: 'test',
|
||||
});
|
||||
|
||||
const content = await fs.readFile(configPath, 'utf8');
|
||||
expect(content).toContain('Root: /project');
|
||||
expect(content).toContain('Module: test');
|
||||
expect(content).toMatch(/Version: \d+\.\d+/);
|
||||
});
|
||||
|
||||
it('should replace custom placeholders', async () => {
|
||||
const configPath = path.join(tmpDir, 'config.txt');
|
||||
await fs.writeFile(configPath, 'Custom: {custom-placeholder}');
|
||||
|
||||
await config.processConfig(configPath, { '{custom-placeholder}': 'custom-value' });
|
||||
|
||||
const content = await fs.readFile(configPath, 'utf8');
|
||||
expect(content).toBe('Custom: custom-value');
|
||||
});
|
||||
|
||||
it('should escape regex special characters in placeholders', async () => {
|
||||
const configPath = path.join(tmpDir, 'config.txt');
|
||||
await fs.writeFile(configPath, 'Path: {project-root}/test');
|
||||
|
||||
// Test that {project-root} doesn't get interpreted as regex
|
||||
await config.processConfig(configPath, {
|
||||
root: '/path/with/special$chars^',
|
||||
});
|
||||
|
||||
const content = await fs.readFile(configPath, 'utf8');
|
||||
expect(content).toBe('Path: /path/with/special$chars^/test');
|
||||
});
|
||||
|
||||
it('should handle placeholders with regex metacharacters in values', async () => {
|
||||
const configPath = path.join(tmpDir, 'config.txt');
|
||||
await fs.writeFile(configPath, 'Value: {placeholder}');
|
||||
|
||||
await config.processConfig(configPath, {
|
||||
'{placeholder}': String.raw`value with $1 and \backslash`,
|
||||
});
|
||||
|
||||
const content = await fs.readFile(configPath, 'utf8');
|
||||
expect(content).toBe(String.raw`Value: value with $1 and \backslash`);
|
||||
});
|
||||
|
||||
it('should replace all occurrences of placeholder', async () => {
|
||||
const configPath = path.join(tmpDir, 'config.txt');
|
||||
await fs.writeFile(configPath, '{module} is here and {module} is there and {module} everywhere');
|
||||
|
||||
await config.processConfig(configPath, { module: 'BMM' });
|
||||
|
||||
const content = await fs.readFile(configPath, 'utf8');
|
||||
expect(content).toBe('BMM is here and BMM is there and BMM everywhere');
|
||||
});
|
||||
});
|
||||
|
||||
describe('deepMerge()', () => {
|
||||
it('should merge shallow objects', () => {
|
||||
const target = { a: 1, b: 2 };
|
||||
const source = { b: 3, c: 4 };
|
||||
|
||||
const result = config.deepMerge(target, source);
|
||||
|
||||
expect(result).toEqual({ a: 1, b: 3, c: 4 });
|
||||
});
|
||||
|
||||
it('should merge nested objects', () => {
|
||||
const target = { level1: { a: 1, b: 2 } };
|
||||
const source = { level1: { b: 3, c: 4 } };
|
||||
|
||||
const result = config.deepMerge(target, source);
|
||||
|
||||
expect(result.level1).toEqual({ a: 1, b: 3, c: 4 });
|
||||
});
|
||||
|
||||
it('should not merge arrays (just replace)', () => {
|
||||
const target = { items: [1, 2, 3] };
|
||||
const source = { items: [4, 5] };
|
||||
|
||||
const result = config.deepMerge(target, source);
|
||||
|
||||
expect(result.items).toEqual([4, 5]); // Replaced, not merged
|
||||
});
|
||||
|
||||
it('should handle null values', () => {
|
||||
const target = { a: 'value', b: null };
|
||||
const source = { a: null, c: 'new' };
|
||||
|
||||
const result = config.deepMerge(target, source);
|
||||
|
||||
expect(result).toEqual({ a: null, b: null, c: 'new' });
|
||||
});
|
||||
|
||||
it('should not mutate original objects', () => {
|
||||
const target = { a: 1 };
|
||||
const source = { b: 2 };
|
||||
|
||||
config.deepMerge(target, source);
|
||||
|
||||
expect(target).toEqual({ a: 1 });
|
||||
expect(source).toEqual({ b: 2 });
|
||||
});
|
||||
});
|
||||
|
||||
describe('mergeConfigs()', () => {
|
||||
it('should delegate to deepMerge', () => {
|
||||
const base = { setting1: 'base' };
|
||||
const override = { setting2: 'override' };
|
||||
|
||||
const result = config.mergeConfigs(base, override);
|
||||
|
||||
expect(result).toEqual({ setting1: 'base', setting2: 'override' });
|
||||
});
|
||||
});
|
||||
|
||||
describe('isObject()', () => {
|
||||
it('should return true for plain objects', () => {
|
||||
expect(config.isObject({})).toBe(true);
|
||||
expect(config.isObject({ key: 'value' })).toBe(true);
|
||||
});
|
||||
|
||||
it('should return false for arrays', () => {
|
||||
expect(config.isObject([])).toBe(false);
|
||||
});
|
||||
|
||||
it('should return false for null', () => {
|
||||
expect(config.isObject(null)).toBeFalsy();
|
||||
});
|
||||
|
||||
it('should return false for primitives', () => {
|
||||
expect(config.isObject('string')).toBe(false);
|
||||
expect(config.isObject(42)).toBe(false);
|
||||
});
|
||||
});
|
||||
|
||||
describe('getValue() and setValue()', () => {
|
||||
it('should get value by dot notation path', () => {
|
||||
const obj = {
|
||||
level1: {
|
||||
level2: {
|
||||
value: 'test',
|
||||
},
|
||||
},
|
||||
};
|
||||
|
||||
const result = config.getValue(obj, 'level1.level2.value');
|
||||
|
||||
expect(result).toBe('test');
|
||||
});
|
||||
|
||||
it('should set value by dot notation path', () => {
|
||||
const obj = {
|
||||
level1: {
|
||||
level2: {},
|
||||
},
|
||||
};
|
||||
|
||||
config.setValue(obj, 'level1.level2.value', 'new value');
|
||||
|
||||
expect(obj.level1.level2.value).toBe('new value');
|
||||
});
|
||||
|
||||
it('should return default value for non-existent path', () => {
|
||||
const obj = { a: { b: 'value' } };
|
||||
|
||||
const result = config.getValue(obj, 'a.c.d', 'default');
|
||||
|
||||
expect(result).toBe('default');
|
||||
});
|
||||
|
||||
it('should return null default when path not found', () => {
|
||||
const obj = { a: { b: 'value' } };
|
||||
|
||||
const result = config.getValue(obj, 'a.c.d');
|
||||
|
||||
expect(result).toBeNull();
|
||||
});
|
||||
|
||||
it('should handle simple (non-nested) paths', () => {
|
||||
const obj = { key: 'value' };
|
||||
|
||||
expect(config.getValue(obj, 'key')).toBe('value');
|
||||
|
||||
config.setValue(obj, 'newKey', 'newValue');
|
||||
expect(obj.newKey).toBe('newValue');
|
||||
});
|
||||
|
||||
it('should create intermediate objects when setting deep paths', () => {
|
||||
const obj = {};
|
||||
|
||||
config.setValue(obj, 'a.b.c.d', 'deep value');
|
||||
|
||||
expect(obj.a.b.c.d).toBe('deep value');
|
||||
});
|
||||
});
|
||||
|
||||
describe('validateConfig()', () => {
|
||||
it('should validate required fields', () => {
|
||||
const cfg = { field1: 'value1' };
|
||||
const schema = {
|
||||
required: ['field1', 'field2'],
|
||||
};
|
||||
|
||||
const result = config.validateConfig(cfg, schema);
|
||||
|
||||
expect(result.valid).toBe(false);
|
||||
expect(result.errors).toContain('Missing required field: field2');
|
||||
});
|
||||
|
||||
it('should pass when all required fields present', () => {
|
||||
const cfg = { field1: 'value1', field2: 'value2' };
|
||||
const schema = {
|
||||
required: ['field1', 'field2'],
|
||||
};
|
||||
|
||||
const result = config.validateConfig(cfg, schema);
|
||||
|
||||
expect(result.valid).toBe(true);
|
||||
expect(result.errors).toHaveLength(0);
|
||||
});
|
||||
|
||||
it('should validate field types', () => {
|
||||
const cfg = {
|
||||
stringField: 'text',
|
||||
numberField: '42', // Wrong type
|
||||
arrayField: [1, 2, 3],
|
||||
objectField: 'not-object', // Wrong type
|
||||
boolField: true,
|
||||
};
|
||||
|
||||
const schema = {
|
||||
properties: {
|
||||
stringField: { type: 'string' },
|
||||
numberField: { type: 'number' },
|
||||
arrayField: { type: 'array' },
|
||||
objectField: { type: 'object' },
|
||||
boolField: { type: 'boolean' },
|
||||
},
|
||||
};
|
||||
|
||||
const result = config.validateConfig(cfg, schema);
|
||||
|
||||
expect(result.valid).toBe(false);
|
||||
expect(result.errors.some((e) => e.includes('numberField'))).toBe(true);
|
||||
expect(result.errors.some((e) => e.includes('objectField'))).toBe(true);
|
||||
});
|
||||
|
||||
it('should validate enum values', () => {
|
||||
const cfg = { level: 'expert' };
|
||||
const schema = {
|
||||
properties: {
|
||||
level: { type: 'string', enum: ['beginner', 'intermediate', 'advanced'] },
|
||||
},
|
||||
};
|
||||
|
||||
const result = config.validateConfig(cfg, schema);
|
||||
|
||||
expect(result.valid).toBe(false);
|
||||
expect(result.errors.some((e) => e.includes('must be one of'))).toBe(true);
|
||||
});
|
||||
|
||||
it('should pass validation for valid enum value', () => {
|
||||
const cfg = { level: 'intermediate' };
|
||||
const schema = {
|
||||
properties: {
|
||||
level: { type: 'string', enum: ['beginner', 'intermediate', 'advanced'] },
|
||||
},
|
||||
};
|
||||
|
||||
const result = config.validateConfig(cfg, schema);
|
||||
|
||||
expect(result.valid).toBe(true);
|
||||
});
|
||||
|
||||
it('should return warnings array', () => {
|
||||
const cfg = { field: 'value' };
|
||||
const schema = { required: ['field'] };
|
||||
|
||||
const result = config.validateConfig(cfg, schema);
|
||||
|
||||
expect(result.warnings).toBeDefined();
|
||||
expect(Array.isArray(result.warnings)).toBe(true);
|
||||
});
|
||||
});
|
||||
|
||||
describe('edge cases', () => {
|
||||
it('should handle empty YAML file', async () => {
|
||||
const configPath = path.join(tmpDir, 'empty.yaml');
|
||||
await fs.writeFile(configPath, '');
|
||||
|
||||
const result = await config.loadYaml(configPath);
|
||||
|
||||
expect(result).toBeNull(); // Empty YAML parses to null
|
||||
});
|
||||
|
||||
it('should handle YAML with only comments', async () => {
|
||||
const configPath = path.join(tmpDir, 'comments.yaml');
|
||||
await fs.writeFile(configPath, '# Just a comment\n# Another comment\n');
|
||||
|
||||
const result = await config.loadYaml(configPath);
|
||||
|
||||
expect(result).toBeNull();
|
||||
});
|
||||
|
||||
it('should handle very deep object nesting', () => {
|
||||
const deep = {
|
||||
l1: { l2: { l3: { l4: { l5: { l6: { l7: { l8: { value: 'deep' } } } } } } } },
|
||||
};
|
||||
const override = {
|
||||
l1: { l2: { l3: { l4: { l5: { l6: { l7: { l8: { value: 'updated' } } } } } } } },
|
||||
};
|
||||
|
||||
const result = config.deepMerge(deep, override);
|
||||
|
||||
expect(result.l1.l2.l3.l4.l5.l6.l7.l8.value).toBe('updated');
|
||||
});
|
||||
});
|
||||
});
|
||||
|
|
@ -0,0 +1,558 @@
|
|||
import { describe, it, expect, beforeEach, afterEach } from 'vitest';
|
||||
import { DependencyResolver } from '../../../tools/cli/installers/lib/core/dependency-resolver.js';
|
||||
import { createTempDir, cleanupTempDir, createTestFile } from '../../helpers/temp-dir.js';
|
||||
import fs from 'fs-extra';
|
||||
import path from 'node:path';
|
||||
|
||||
describe('DependencyResolver - Advanced Scenarios', () => {
|
||||
let tmpDir;
|
||||
let bmadDir;
|
||||
|
||||
beforeEach(async () => {
|
||||
tmpDir = await createTempDir();
|
||||
bmadDir = path.join(tmpDir, 'src');
|
||||
await fs.ensureDir(path.join(bmadDir, 'core', 'agents'));
|
||||
await fs.ensureDir(path.join(bmadDir, 'core', 'tasks'));
|
||||
await fs.ensureDir(path.join(bmadDir, 'core', 'templates'));
|
||||
await fs.ensureDir(path.join(bmadDir, 'modules', 'bmm', 'agents'));
|
||||
await fs.ensureDir(path.join(bmadDir, 'modules', 'bmm', 'tasks'));
|
||||
await fs.ensureDir(path.join(bmadDir, 'modules', 'bmm', 'templates'));
|
||||
});
|
||||
|
||||
afterEach(async () => {
|
||||
await cleanupTempDir(tmpDir);
|
||||
});
|
||||
|
||||
describe('module path resolution', () => {
|
||||
it('should resolve bmad/bmm/tasks/task.md (module path)', async () => {
|
||||
await createTestFile(
|
||||
bmadDir,
|
||||
'core/agents/agent.md',
|
||||
`---
|
||||
dependencies: ["{project-root}/bmad/bmm/tasks/analyze.md"]
|
||||
---
|
||||
<agent>Agent</agent>`,
|
||||
);
|
||||
await createTestFile(bmadDir, 'modules/bmm/tasks/analyze.md', 'BMM Task');
|
||||
|
||||
const resolver = new DependencyResolver();
|
||||
const result = await resolver.resolve(bmadDir, []);
|
||||
|
||||
expect([...result.allFiles].some((f) => f.includes('bmm'))).toBe(true);
|
||||
expect([...result.allFiles].some((f) => f.includes('analyze.md'))).toBe(true);
|
||||
});
|
||||
|
||||
it('should handle glob in module path bmad/bmm/tasks/*.md', async () => {
|
||||
await createTestFile(
|
||||
bmadDir,
|
||||
'core/agents/agent.md',
|
||||
`---
|
||||
dependencies: ["{project-root}/bmad/bmm/tasks/*.md"]
|
||||
---
|
||||
<agent>Agent</agent>`,
|
||||
);
|
||||
await createTestFile(bmadDir, 'modules/bmm/tasks/task1.md', 'Task 1');
|
||||
await createTestFile(bmadDir, 'modules/bmm/tasks/task2.md', 'Task 2');
|
||||
|
||||
const resolver = new DependencyResolver();
|
||||
const result = await resolver.resolve(bmadDir, ['bmm']); // Include bmm module
|
||||
|
||||
// Should resolve glob pattern
|
||||
expect(result.allFiles.length).toBeGreaterThanOrEqual(1);
|
||||
});
|
||||
|
||||
it('should handle non-existent module path gracefully', async () => {
|
||||
await createTestFile(
|
||||
bmadDir,
|
||||
'core/agents/agent.md',
|
||||
`---
|
||||
dependencies: ["{project-root}/bmad/nonexistent/tasks/task.md"]
|
||||
---
|
||||
<agent>Agent</agent>`,
|
||||
);
|
||||
|
||||
const resolver = new DependencyResolver();
|
||||
const result = await resolver.resolve(bmadDir, []);
|
||||
|
||||
// Should not crash, just skip missing dependency
|
||||
expect(result.primaryFiles).toHaveLength(1);
|
||||
});
|
||||
});
|
||||
|
||||
describe('relative glob patterns', () => {
|
||||
it('should resolve relative glob patterns ../tasks/*.md', async () => {
|
||||
await createTestFile(
|
||||
bmadDir,
|
||||
'core/agents/agent.md',
|
||||
`---
|
||||
dependencies: ["../tasks/*.md"]
|
||||
---
|
||||
<agent>Agent</agent>`,
|
||||
);
|
||||
await createTestFile(bmadDir, 'core/tasks/task1.md', 'Task 1');
|
||||
await createTestFile(bmadDir, 'core/tasks/task2.md', 'Task 2');
|
||||
|
||||
const resolver = new DependencyResolver();
|
||||
const result = await resolver.resolve(bmadDir, []);
|
||||
|
||||
expect(result.allFiles.length).toBeGreaterThanOrEqual(3);
|
||||
});
|
||||
|
||||
it('should handle glob pattern with no matches', async () => {
|
||||
await createTestFile(
|
||||
bmadDir,
|
||||
'core/agents/agent.md',
|
||||
`---
|
||||
dependencies: ["../tasks/nonexistent-*.md"]
|
||||
---
|
||||
<agent>Agent</agent>`,
|
||||
);
|
||||
|
||||
const resolver = new DependencyResolver();
|
||||
const result = await resolver.resolve(bmadDir, []);
|
||||
|
||||
// Should handle gracefully - just the agent
|
||||
expect(result.primaryFiles).toHaveLength(1);
|
||||
});
|
||||
|
||||
it('should handle glob in non-existent directory', async () => {
|
||||
await createTestFile(
|
||||
bmadDir,
|
||||
'core/agents/agent.md',
|
||||
`---
|
||||
dependencies: ["../nonexistent/*.md"]
|
||||
---
|
||||
<agent>Agent</agent>`,
|
||||
);
|
||||
|
||||
const resolver = new DependencyResolver();
|
||||
const result = await resolver.resolve(bmadDir, []);
|
||||
|
||||
// Should handle gracefully
|
||||
expect(result.primaryFiles).toHaveLength(1);
|
||||
});
|
||||
});
|
||||
|
||||
describe('template dependencies', () => {
|
||||
it('should resolve template with {project-root} prefix', async () => {
|
||||
await createTestFile(bmadDir, 'core/agents/agent.md', '<agent>Agent</agent>');
|
||||
await createTestFile(
|
||||
bmadDir,
|
||||
'core/tasks/task.md',
|
||||
`---
|
||||
template: "{project-root}/bmad/core/templates/form.yaml"
|
||||
---
|
||||
Task content`,
|
||||
);
|
||||
await createTestFile(bmadDir, 'core/templates/form.yaml', 'template');
|
||||
|
||||
const resolver = new DependencyResolver();
|
||||
const result = await resolver.resolve(bmadDir, []);
|
||||
|
||||
// Template dependency should be resolved
|
||||
expect(result.allFiles.length).toBeGreaterThanOrEqual(1);
|
||||
});
|
||||
|
||||
it('should resolve template from module path', async () => {
|
||||
await createTestFile(bmadDir, 'modules/bmm/agents/agent.md', '<agent>BMM Agent</agent>');
|
||||
await createTestFile(
|
||||
bmadDir,
|
||||
'modules/bmm/tasks/task.md',
|
||||
`---
|
||||
template: "{project-root}/bmad/bmm/templates/prd-template.yaml"
|
||||
---
|
||||
Task`,
|
||||
);
|
||||
await createTestFile(bmadDir, 'modules/bmm/templates/prd-template.yaml', 'template');
|
||||
|
||||
const resolver = new DependencyResolver();
|
||||
const result = await resolver.resolve(bmadDir, ['bmm']);
|
||||
|
||||
// Should resolve files from BMM module
|
||||
expect(result.allFiles.length).toBeGreaterThanOrEqual(1);
|
||||
});
|
||||
|
||||
it('should handle missing template gracefully', async () => {
|
||||
await createTestFile(
|
||||
bmadDir,
|
||||
'core/tasks/task.md',
|
||||
`---
|
||||
template: "../templates/missing.yaml"
|
||||
---
|
||||
Task`,
|
||||
);
|
||||
|
||||
const resolver = new DependencyResolver();
|
||||
const result = await resolver.resolve(bmadDir, []);
|
||||
|
||||
// Should not crash
|
||||
expect(result).toBeDefined();
|
||||
});
|
||||
});
|
||||
|
||||
describe('bmad-path type resolution', () => {
|
||||
it('should resolve bmad-path dependencies', async () => {
|
||||
await createTestFile(
|
||||
bmadDir,
|
||||
'core/agents/agent.md',
|
||||
`<agent>
|
||||
<command exec="bmad/core/tasks/analyze" />
|
||||
</agent>`,
|
||||
);
|
||||
await createTestFile(bmadDir, 'core/tasks/analyze.md', 'Task');
|
||||
|
||||
const resolver = new DependencyResolver();
|
||||
const result = await resolver.resolve(bmadDir, []);
|
||||
|
||||
expect([...result.allFiles].some((f) => f.includes('analyze.md'))).toBe(true);
|
||||
});
|
||||
|
||||
it('should resolve bmad-path for module files', async () => {
|
||||
await createTestFile(
|
||||
bmadDir,
|
||||
'core/agents/agent.md',
|
||||
`<agent>
|
||||
<command exec="bmad/bmm/tasks/create-prd" />
|
||||
</agent>`,
|
||||
);
|
||||
await createTestFile(bmadDir, 'modules/bmm/tasks/create-prd.md', 'PRD Task');
|
||||
|
||||
const resolver = new DependencyResolver();
|
||||
const result = await resolver.resolve(bmadDir, []);
|
||||
|
||||
expect([...result.allFiles].some((f) => f.includes('create-prd.md'))).toBe(true);
|
||||
});
|
||||
|
||||
it('should handle non-existent bmad-path gracefully', async () => {
|
||||
await createTestFile(
|
||||
bmadDir,
|
||||
'core/agents/agent.md',
|
||||
`<agent>
|
||||
<command exec="bmad/core/tasks/missing" />
|
||||
</agent>`,
|
||||
);
|
||||
|
||||
const resolver = new DependencyResolver();
|
||||
const result = await resolver.resolve(bmadDir, []);
|
||||
|
||||
// Should not crash
|
||||
expect(result.primaryFiles).toHaveLength(1);
|
||||
});
|
||||
});
|
||||
|
||||
describe('command resolution with modules', () => {
|
||||
it('should search multiple modules for @task-name', async () => {
|
||||
await createTestFile(
|
||||
bmadDir,
|
||||
'core/agents/agent.md',
|
||||
`<agent>
|
||||
Use @task-custom-task
|
||||
</agent>`,
|
||||
);
|
||||
await createTestFile(bmadDir, 'modules/bmm/tasks/custom-task.md', 'Custom Task');
|
||||
|
||||
const resolver = new DependencyResolver();
|
||||
const result = await resolver.resolve(bmadDir, ['bmm']);
|
||||
|
||||
expect([...result.allFiles].some((f) => f.includes('custom-task.md'))).toBe(true);
|
||||
});
|
||||
|
||||
it('should search multiple modules for @agent-name', async () => {
|
||||
await createTestFile(
|
||||
bmadDir,
|
||||
'core/agents/main.md',
|
||||
`<agent>
|
||||
Use @agent-pm
|
||||
</agent>`,
|
||||
);
|
||||
await createTestFile(bmadDir, 'modules/bmm/agents/pm.md', '<agent>PM</agent>');
|
||||
|
||||
const resolver = new DependencyResolver();
|
||||
const result = await resolver.resolve(bmadDir, ['bmm']);
|
||||
|
||||
expect([...result.allFiles].some((f) => f.includes('pm.md'))).toBe(true);
|
||||
});
|
||||
|
||||
it('should handle bmad/ path with 4+ segments', async () => {
|
||||
await createTestFile(
|
||||
bmadDir,
|
||||
'core/agents/agent.md',
|
||||
`<agent>
|
||||
Reference bmad/core/tasks/nested/deep/task
|
||||
</agent>`,
|
||||
);
|
||||
await createTestFile(bmadDir, 'core/tasks/nested/deep/task.md', 'Deep task');
|
||||
|
||||
const resolver = new DependencyResolver();
|
||||
const result = await resolver.resolve(bmadDir, []);
|
||||
|
||||
// Implementation may or may not support deeply nested paths in commands
|
||||
// Just verify it doesn't crash
|
||||
expect(result.primaryFiles.length).toBeGreaterThanOrEqual(1);
|
||||
});
|
||||
|
||||
it('should handle bmad path with .md extension already', async () => {
|
||||
await createTestFile(
|
||||
bmadDir,
|
||||
'core/agents/agent.md',
|
||||
`<agent>
|
||||
Use bmad/core/tasks/task.md explicitly
|
||||
</agent>`,
|
||||
);
|
||||
await createTestFile(bmadDir, 'core/tasks/task.md', 'Task');
|
||||
|
||||
const resolver = new DependencyResolver();
|
||||
const result = await resolver.resolve(bmadDir, []);
|
||||
|
||||
expect([...result.allFiles].some((f) => f.includes('task.md'))).toBe(true);
|
||||
});
|
||||
});
|
||||
|
||||
describe('verbose mode', () => {
|
||||
it('should include console output when verbose is true', async () => {
|
||||
await createTestFile(bmadDir, 'core/agents/agent.md', '<agent>Test</agent>');
|
||||
|
||||
const resolver = new DependencyResolver();
|
||||
|
||||
// Mock console.log to capture output
|
||||
const logs = [];
|
||||
const originalLog = console.log;
|
||||
console.log = (...args) => logs.push(args.join(' '));
|
||||
|
||||
await resolver.resolve(bmadDir, [], { verbose: true });
|
||||
|
||||
console.log = originalLog;
|
||||
|
||||
// Should have logged something in verbose mode
|
||||
expect(logs.length).toBeGreaterThan(0);
|
||||
});
|
||||
|
||||
it('should not log when verbose is false', async () => {
|
||||
await createTestFile(bmadDir, 'core/agents/agent.md', '<agent>Test</agent>');
|
||||
|
||||
const resolver = new DependencyResolver();
|
||||
|
||||
const logs = [];
|
||||
const originalLog = console.log;
|
||||
console.log = (...args) => logs.push(args.join(' '));
|
||||
|
||||
await resolver.resolve(bmadDir, [], { verbose: false });
|
||||
|
||||
console.log = originalLog;
|
||||
|
||||
// Should not have logged in non-verbose mode
|
||||
// (There might be warns but no regular logs)
|
||||
expect(logs.length).toBe(0);
|
||||
});
|
||||
});
|
||||
|
||||
describe('createWebBundle()', () => {
|
||||
it('should create bundle with metadata', async () => {
|
||||
await createTestFile(bmadDir, 'core/agents/agent.md', '<agent>Agent</agent>');
|
||||
await createTestFile(bmadDir, 'core/tasks/task.md', 'Task');
|
||||
|
||||
const resolver = new DependencyResolver();
|
||||
const resolution = await resolver.resolve(bmadDir, []);
|
||||
|
||||
const bundle = await resolver.createWebBundle(resolution);
|
||||
|
||||
expect(bundle.metadata).toBeDefined();
|
||||
expect(bundle.metadata.modules).toContain('core');
|
||||
expect(bundle.metadata.totalFiles).toBeGreaterThan(0);
|
||||
});
|
||||
|
||||
it('should organize bundle by file type', async () => {
|
||||
await createTestFile(bmadDir, 'core/agents/agent.md', '<agent>Agent</agent>');
|
||||
await createTestFile(bmadDir, 'core/tasks/task.md', 'Task');
|
||||
await createTestFile(bmadDir, 'core/templates/template.yaml', 'template');
|
||||
|
||||
const resolver = new DependencyResolver();
|
||||
const resolution = await resolver.resolve(bmadDir, []);
|
||||
|
||||
const bundle = await resolver.createWebBundle(resolution);
|
||||
|
||||
expect(bundle.agents).toBeDefined();
|
||||
expect(bundle.tasks).toBeDefined();
|
||||
expect(bundle.templates).toBeDefined();
|
||||
});
|
||||
});
|
||||
|
||||
describe('single string dependency (not array)', () => {
|
||||
it('should handle single string dependency (converted to array)', async () => {
|
||||
await createTestFile(
|
||||
bmadDir,
|
||||
'core/agents/agent.md',
|
||||
`---
|
||||
dependencies: "{project-root}/bmad/core/tasks/task.md"
|
||||
---
|
||||
<agent>Agent</agent>`,
|
||||
);
|
||||
await createTestFile(bmadDir, 'core/tasks/task.md', 'Task');
|
||||
|
||||
const resolver = new DependencyResolver();
|
||||
const result = await resolver.resolve(bmadDir, []);
|
||||
|
||||
// Single string should be converted to array internally
|
||||
expect(result.allFiles.length).toBeGreaterThanOrEqual(2);
|
||||
});
|
||||
|
||||
it('should handle single string template', async () => {
|
||||
await createTestFile(
|
||||
bmadDir,
|
||||
'core/tasks/task.md',
|
||||
`---
|
||||
template: "../templates/form.yaml"
|
||||
---
|
||||
Task`,
|
||||
);
|
||||
await createTestFile(bmadDir, 'core/templates/form.yaml', 'template');
|
||||
|
||||
const resolver = new DependencyResolver();
|
||||
const result = await resolver.resolve(bmadDir, []);
|
||||
|
||||
expect([...result.allFiles].some((f) => f.includes('form.yaml'))).toBe(true);
|
||||
});
|
||||
});
|
||||
|
||||
describe('missing dependency tracking', () => {
|
||||
it('should track missing relative file dependencies', async () => {
|
||||
await createTestFile(
|
||||
bmadDir,
|
||||
'core/agents/agent.md',
|
||||
`---
|
||||
dependencies: ["../tasks/missing-file.md"]
|
||||
---
|
||||
<agent>Agent</agent>`,
|
||||
);
|
||||
|
||||
const resolver = new DependencyResolver();
|
||||
const result = await resolver.resolve(bmadDir, []);
|
||||
|
||||
// Missing dependency should be tracked
|
||||
expect(result.missing.length).toBeGreaterThanOrEqual(0);
|
||||
// Should not crash
|
||||
expect(result).toBeDefined();
|
||||
});
|
||||
});
|
||||
|
||||
describe('reportResults()', () => {
|
||||
it('should report results with file counts', async () => {
|
||||
await createTestFile(bmadDir, 'core/agents/agent1.md', '<agent>1</agent>');
|
||||
await createTestFile(bmadDir, 'core/agents/agent2.md', '<agent>2</agent>');
|
||||
await createTestFile(bmadDir, 'core/tasks/task1.md', 'Task 1');
|
||||
await createTestFile(bmadDir, 'core/tasks/task2.md', 'Task 2');
|
||||
await createTestFile(bmadDir, 'core/templates/template.yaml', 'Template');
|
||||
|
||||
const resolver = new DependencyResolver();
|
||||
|
||||
// Mock console.log
|
||||
const logs = [];
|
||||
const originalLog = console.log;
|
||||
console.log = (...args) => logs.push(args.join(' '));
|
||||
|
||||
const result = await resolver.resolve(bmadDir, [], { verbose: true });
|
||||
|
||||
console.log = originalLog;
|
||||
|
||||
// Should have reported module statistics
|
||||
expect(logs.some((log) => log.includes('CORE'))).toBe(true);
|
||||
expect(logs.some((log) => log.includes('Agents:'))).toBe(true);
|
||||
expect(logs.some((log) => log.includes('Tasks:'))).toBe(true);
|
||||
});
|
||||
|
||||
it('should report missing dependencies', async () => {
|
||||
await createTestFile(
|
||||
bmadDir,
|
||||
'core/agents/agent.md',
|
||||
`---
|
||||
dependencies: ["../tasks/missing.md"]
|
||||
---
|
||||
<agent>Agent</agent>`,
|
||||
);
|
||||
|
||||
const resolver = new DependencyResolver();
|
||||
|
||||
const logs = [];
|
||||
const originalLog = console.log;
|
||||
console.log = (...args) => logs.push(args.join(' '));
|
||||
|
||||
await resolver.resolve(bmadDir, [], { verbose: true });
|
||||
|
||||
console.log = originalLog;
|
||||
|
||||
// May log warning about missing dependencies
|
||||
expect(logs.length).toBeGreaterThan(0);
|
||||
});
|
||||
});
|
||||
|
||||
describe('file without .md extension in command', () => {
|
||||
it('should add .md extension to bmad/ commands without extension', async () => {
|
||||
await createTestFile(
|
||||
bmadDir,
|
||||
'core/agents/agent.md',
|
||||
`<agent>
|
||||
Use bmad/core/tasks/analyze without extension
|
||||
</agent>`,
|
||||
);
|
||||
await createTestFile(bmadDir, 'core/tasks/analyze.md', 'Analyze');
|
||||
|
||||
const resolver = new DependencyResolver();
|
||||
const result = await resolver.resolve(bmadDir, []);
|
||||
|
||||
expect([...result.allFiles].some((f) => f.includes('analyze.md'))).toBe(true);
|
||||
});
|
||||
});
|
||||
|
||||
describe('module structure detection', () => {
|
||||
it('should detect source directory structure (src/)', async () => {
|
||||
// Default structure already uses src/
|
||||
await createTestFile(bmadDir, 'core/agents/agent.md', '<agent>Core</agent>');
|
||||
|
||||
const resolver = new DependencyResolver();
|
||||
const result = await resolver.resolve(bmadDir, []);
|
||||
|
||||
expect(result.primaryFiles.length).toBeGreaterThanOrEqual(1);
|
||||
});
|
||||
|
||||
it('should detect installed directory structure (no src/)', async () => {
|
||||
// Create installed structure
|
||||
const installedDir = path.join(tmpDir, 'installed');
|
||||
await fs.ensureDir(path.join(installedDir, 'core', 'agents'));
|
||||
await fs.ensureDir(path.join(installedDir, 'modules', 'bmm', 'agents'));
|
||||
await createTestFile(installedDir, 'core/agents/agent.md', '<agent>Core</agent>');
|
||||
|
||||
const resolver = new DependencyResolver();
|
||||
const result = await resolver.resolve(installedDir, []);
|
||||
|
||||
expect(result.primaryFiles.length).toBeGreaterThanOrEqual(1);
|
||||
});
|
||||
});
|
||||
|
||||
describe('dependency deduplication', () => {
|
||||
it('should not include same file twice', async () => {
|
||||
await createTestFile(
|
||||
bmadDir,
|
||||
'core/agents/agent1.md',
|
||||
`---
|
||||
dependencies: ["{project-root}/bmad/core/tasks/shared.md"]
|
||||
---
|
||||
<agent>1</agent>`,
|
||||
);
|
||||
await createTestFile(
|
||||
bmadDir,
|
||||
'core/agents/agent2.md',
|
||||
`---
|
||||
dependencies: ["{project-root}/bmad/core/tasks/shared.md"]
|
||||
---
|
||||
<agent>2</agent>`,
|
||||
);
|
||||
await createTestFile(bmadDir, 'core/tasks/shared.md', 'Shared');
|
||||
|
||||
const resolver = new DependencyResolver();
|
||||
const result = await resolver.resolve(bmadDir, []);
|
||||
|
||||
// Should have 2 agents + 1 shared task = 3 unique files
|
||||
expect(result.allFiles).toHaveLength(3);
|
||||
});
|
||||
});
|
||||
});
|
||||
|
|
@ -0,0 +1,796 @@
|
|||
import { describe, it, expect, beforeEach, afterEach } from 'vitest';
|
||||
import { DependencyResolver } from '../../../tools/cli/installers/lib/core/dependency-resolver.js';
|
||||
import { createTempDir, cleanupTempDir, createTestFile } from '../../helpers/temp-dir.js';
|
||||
import fs from 'fs-extra';
|
||||
import path from 'node:path';
|
||||
|
||||
describe('DependencyResolver', () => {
|
||||
let tmpDir;
|
||||
let bmadDir;
|
||||
|
||||
beforeEach(async () => {
|
||||
tmpDir = await createTempDir();
|
||||
// Create structure: tmpDir/src/core and tmpDir/src/modules/
|
||||
bmadDir = path.join(tmpDir, 'src');
|
||||
await fs.ensureDir(path.join(bmadDir, 'core', 'agents'));
|
||||
await fs.ensureDir(path.join(bmadDir, 'core', 'tasks'));
|
||||
await fs.ensureDir(path.join(bmadDir, 'core', 'templates'));
|
||||
await fs.ensureDir(path.join(bmadDir, 'modules', 'bmm', 'agents'));
|
||||
await fs.ensureDir(path.join(bmadDir, 'modules', 'bmm', 'tasks'));
|
||||
});
|
||||
|
||||
afterEach(async () => {
|
||||
await cleanupTempDir(tmpDir);
|
||||
});
|
||||
|
||||
describe('basic resolution', () => {
|
||||
it('should resolve core agents with no dependencies', async () => {
|
||||
await createTestFile(
|
||||
bmadDir,
|
||||
'core/agents/simple.md',
|
||||
`---
|
||||
name: simple
|
||||
---
|
||||
<agent>Simple agent</agent>`,
|
||||
);
|
||||
|
||||
const resolver = new DependencyResolver();
|
||||
const result = await resolver.resolve(bmadDir, []);
|
||||
|
||||
expect(result.primaryFiles).toHaveLength(1);
|
||||
expect(result.primaryFiles[0].type).toBe('agent');
|
||||
expect(result.primaryFiles[0].module).toBe('core');
|
||||
expect(result.allFiles).toHaveLength(1);
|
||||
});
|
||||
|
||||
it('should resolve multiple agents from same module', async () => {
|
||||
await createTestFile(bmadDir, 'core/agents/agent1.md', '<agent>Agent 1</agent>');
|
||||
await createTestFile(bmadDir, 'core/agents/agent2.md', '<agent>Agent 2</agent>');
|
||||
await createTestFile(bmadDir, 'core/agents/agent3.md', '<agent>Agent 3</agent>');
|
||||
|
||||
const resolver = new DependencyResolver();
|
||||
const result = await resolver.resolve(bmadDir, []);
|
||||
|
||||
expect(result.primaryFiles).toHaveLength(3);
|
||||
expect(result.allFiles).toHaveLength(3);
|
||||
});
|
||||
|
||||
it('should always include core module', async () => {
|
||||
await createTestFile(bmadDir, 'core/agents/core-agent.md', '<agent>Core</agent>');
|
||||
|
||||
const resolver = new DependencyResolver();
|
||||
const result = await resolver.resolve(bmadDir, ['bmm']);
|
||||
|
||||
// Core should be included even though only 'bmm' was requested
|
||||
expect(result.byModule.core).toBeDefined();
|
||||
});
|
||||
|
||||
it('should skip agents with localskip="true"', async () => {
|
||||
await createTestFile(bmadDir, 'core/agents/normal.md', '<agent>Normal agent</agent>');
|
||||
await createTestFile(bmadDir, 'core/agents/webonly.md', '<agent localskip="true">Web only agent</agent>');
|
||||
|
||||
const resolver = new DependencyResolver();
|
||||
const result = await resolver.resolve(bmadDir, []);
|
||||
|
||||
expect(result.primaryFiles).toHaveLength(1);
|
||||
expect(result.primaryFiles[0].name).toBe('normal');
|
||||
});
|
||||
});
|
||||
|
||||
describe('path resolution variations', () => {
|
||||
it('should resolve {project-root}/bmad/core/tasks/foo.md dependencies', async () => {
|
||||
await createTestFile(
|
||||
bmadDir,
|
||||
'core/agents/agent.md',
|
||||
`---
|
||||
dependencies: ["{project-root}/bmad/core/tasks/task.md"]
|
||||
---
|
||||
<agent>Agent with task dependency</agent>`,
|
||||
);
|
||||
await createTestFile(bmadDir, 'core/tasks/task.md', 'Task content');
|
||||
|
||||
const resolver = new DependencyResolver();
|
||||
const result = await resolver.resolve(bmadDir, []);
|
||||
|
||||
expect(result.allFiles).toHaveLength(2);
|
||||
expect(result.dependencies.size).toBeGreaterThan(0);
|
||||
expect([...result.dependencies].some((d) => d.includes('task.md'))).toBe(true);
|
||||
});
|
||||
|
||||
it('should resolve relative path dependencies', async () => {
|
||||
await createTestFile(
|
||||
bmadDir,
|
||||
'core/agents/agent.md',
|
||||
`---
|
||||
template: "../templates/template.yaml"
|
||||
---
|
||||
<agent>Agent with template</agent>`,
|
||||
);
|
||||
await createTestFile(bmadDir, 'core/templates/template.yaml', 'template: data');
|
||||
|
||||
const resolver = new DependencyResolver();
|
||||
const result = await resolver.resolve(bmadDir, []);
|
||||
|
||||
expect(result.allFiles).toHaveLength(2);
|
||||
expect([...result.dependencies].some((d) => d.includes('template.yaml'))).toBe(true);
|
||||
});
|
||||
|
||||
it('should resolve glob pattern dependencies', async () => {
|
||||
await createTestFile(
|
||||
bmadDir,
|
||||
'core/agents/agent.md',
|
||||
`---
|
||||
dependencies: ["{project-root}/bmad/core/tasks/*.md"]
|
||||
---
|
||||
<agent>Agent with multiple tasks</agent>`,
|
||||
);
|
||||
await createTestFile(bmadDir, 'core/tasks/task1.md', 'Task 1');
|
||||
await createTestFile(bmadDir, 'core/tasks/task2.md', 'Task 2');
|
||||
await createTestFile(bmadDir, 'core/tasks/task3.md', 'Task 3');
|
||||
|
||||
const resolver = new DependencyResolver();
|
||||
const result = await resolver.resolve(bmadDir, []);
|
||||
|
||||
// Should find agent + 3 tasks
|
||||
expect(result.allFiles).toHaveLength(4);
|
||||
});
|
||||
|
||||
it('should resolve array of dependencies', async () => {
|
||||
await createTestFile(
|
||||
bmadDir,
|
||||
'core/agents/agent.md',
|
||||
`---
|
||||
dependencies:
|
||||
- "{project-root}/bmad/core/tasks/task1.md"
|
||||
- "{project-root}/bmad/core/tasks/task2.md"
|
||||
- "../templates/template.yaml"
|
||||
---
|
||||
<agent>Agent</agent>`,
|
||||
);
|
||||
await createTestFile(bmadDir, 'core/tasks/task1.md', 'Task 1');
|
||||
await createTestFile(bmadDir, 'core/tasks/task2.md', 'Task 2');
|
||||
await createTestFile(bmadDir, 'core/templates/template.yaml', 'template');
|
||||
|
||||
const resolver = new DependencyResolver();
|
||||
const result = await resolver.resolve(bmadDir, []);
|
||||
|
||||
expect(result.allFiles).toHaveLength(4); // agent + 2 tasks + template
|
||||
});
|
||||
});
|
||||
|
||||
describe('command reference resolution', () => {
|
||||
it('should resolve @task-name references', async () => {
|
||||
await createTestFile(
|
||||
bmadDir,
|
||||
'core/agents/agent.md',
|
||||
`<agent>
|
||||
Use @task-analyze for analysis
|
||||
</agent>`,
|
||||
);
|
||||
await createTestFile(bmadDir, 'core/tasks/analyze.md', 'Analyze task');
|
||||
|
||||
const resolver = new DependencyResolver();
|
||||
const result = await resolver.resolve(bmadDir, []);
|
||||
|
||||
expect(result.allFiles.length).toBeGreaterThanOrEqual(2);
|
||||
expect([...result.allFiles].some((f) => f.includes('analyze.md'))).toBe(true);
|
||||
});
|
||||
|
||||
it('should resolve @agent-name references', async () => {
|
||||
await createTestFile(
|
||||
bmadDir,
|
||||
'core/agents/main.md',
|
||||
`<agent>
|
||||
Reference @agent-helper for help
|
||||
</agent>`,
|
||||
);
|
||||
await createTestFile(bmadDir, 'core/agents/helper.md', '<agent>Helper</agent>');
|
||||
|
||||
const resolver = new DependencyResolver();
|
||||
const result = await resolver.resolve(bmadDir, []);
|
||||
|
||||
expect(result.allFiles).toHaveLength(2);
|
||||
expect([...result.allFiles].some((f) => f.includes('helper.md'))).toBe(true);
|
||||
});
|
||||
|
||||
it('should resolve bmad/module/type/name references', async () => {
|
||||
await createTestFile(
|
||||
bmadDir,
|
||||
'core/agents/agent.md',
|
||||
`<agent>
|
||||
See bmad/core/tasks/review
|
||||
</agent>`,
|
||||
);
|
||||
await createTestFile(bmadDir, 'core/tasks/review.md', 'Review task');
|
||||
|
||||
const resolver = new DependencyResolver();
|
||||
const result = await resolver.resolve(bmadDir, []);
|
||||
|
||||
expect([...result.allFiles].some((f) => f.includes('review.md'))).toBe(true);
|
||||
});
|
||||
});
|
||||
|
||||
describe('exec and tmpl attribute parsing', () => {
|
||||
it('should parse exec attributes from command tags', async () => {
|
||||
await createTestFile(
|
||||
bmadDir,
|
||||
'core/agents/agent.md',
|
||||
`<agent>
|
||||
<command exec="{project-root}/bmad/core/tasks/task.md" />
|
||||
</agent>`,
|
||||
);
|
||||
await createTestFile(bmadDir, 'core/tasks/task.md', 'Task');
|
||||
|
||||
const resolver = new DependencyResolver();
|
||||
const result = await resolver.resolve(bmadDir, []);
|
||||
|
||||
expect([...result.allFiles].some((f) => f.includes('task.md'))).toBe(true);
|
||||
});
|
||||
|
||||
it('should parse tmpl attributes from command tags', async () => {
|
||||
await createTestFile(
|
||||
bmadDir,
|
||||
'core/agents/agent.md',
|
||||
`<agent>
|
||||
<command tmpl="../templates/form.yaml" />
|
||||
</agent>`,
|
||||
);
|
||||
await createTestFile(bmadDir, 'core/templates/form.yaml', 'template');
|
||||
|
||||
const resolver = new DependencyResolver();
|
||||
const result = await resolver.resolve(bmadDir, []);
|
||||
|
||||
expect([...result.allFiles].some((f) => f.includes('form.yaml'))).toBe(true);
|
||||
});
|
||||
|
||||
it('should ignore exec="*" wildcard', async () => {
|
||||
await createTestFile(
|
||||
bmadDir,
|
||||
'core/agents/agent.md',
|
||||
`<agent>
|
||||
<command exec="*" description="Dynamic" />
|
||||
</agent>`,
|
||||
);
|
||||
|
||||
const resolver = new DependencyResolver();
|
||||
const result = await resolver.resolve(bmadDir, []);
|
||||
|
||||
// Should only have the agent itself
|
||||
expect(result.primaryFiles).toHaveLength(1);
|
||||
});
|
||||
});
|
||||
|
||||
describe('multi-pass dependency resolution', () => {
|
||||
it('should resolve single-level dependencies (A→B)', async () => {
|
||||
await createTestFile(
|
||||
bmadDir,
|
||||
'core/agents/agent-a.md',
|
||||
`---
|
||||
dependencies: ["{project-root}/bmad/core/tasks/task-b.md"]
|
||||
---
|
||||
<agent>Agent A</agent>`,
|
||||
);
|
||||
await createTestFile(bmadDir, 'core/tasks/task-b.md', 'Task B');
|
||||
|
||||
const resolver = new DependencyResolver();
|
||||
const result = await resolver.resolve(bmadDir, []);
|
||||
|
||||
expect(result.allFiles).toHaveLength(2);
|
||||
// Primary files includes both agents and tasks from selected modules
|
||||
expect(result.primaryFiles.length).toBeGreaterThanOrEqual(1);
|
||||
expect(result.dependencies.size).toBeGreaterThanOrEqual(1);
|
||||
});
|
||||
|
||||
it('should resolve two-level dependencies (A→B→C)', async () => {
|
||||
await createTestFile(
|
||||
bmadDir,
|
||||
'core/agents/agent-a.md',
|
||||
`---
|
||||
dependencies: ["{project-root}/bmad/core/tasks/task-b.md"]
|
||||
---
|
||||
<agent>Agent A</agent>`,
|
||||
);
|
||||
await createTestFile(
|
||||
bmadDir,
|
||||
'core/tasks/task-b.md',
|
||||
`---
|
||||
template: "../templates/template-c.yaml"
|
||||
---
|
||||
Task B content`,
|
||||
);
|
||||
await createTestFile(bmadDir, 'core/templates/template-c.yaml', 'template: data');
|
||||
|
||||
const resolver = new DependencyResolver();
|
||||
const result = await resolver.resolve(bmadDir, []);
|
||||
|
||||
expect(result.allFiles).toHaveLength(3);
|
||||
// Primary files includes agents and tasks
|
||||
expect(result.primaryFiles.length).toBeGreaterThanOrEqual(1);
|
||||
// Total dependencies (direct + transitive) should be at least 2
|
||||
const totalDeps = result.dependencies.size + result.transitiveDependencies.size;
|
||||
expect(totalDeps).toBeGreaterThanOrEqual(1);
|
||||
});
|
||||
|
||||
it('should resolve three-level dependencies (A→B→C→D)', async () => {
|
||||
await createTestFile(
|
||||
bmadDir,
|
||||
'core/agents/agent-a.md',
|
||||
`---
|
||||
dependencies: ["{project-root}/bmad/core/tasks/task-b.md"]
|
||||
---
|
||||
<agent>A</agent>`,
|
||||
);
|
||||
await createTestFile(
|
||||
bmadDir,
|
||||
'core/tasks/task-b.md',
|
||||
`---
|
||||
dependencies: ["{project-root}/bmad/core/tasks/task-c.md"]
|
||||
---
|
||||
Task B`,
|
||||
);
|
||||
await createTestFile(
|
||||
bmadDir,
|
||||
'core/tasks/task-c.md',
|
||||
`---
|
||||
template: "../templates/template-d.yaml"
|
||||
---
|
||||
Task C`,
|
||||
);
|
||||
await createTestFile(bmadDir, 'core/templates/template-d.yaml', 'Template D');
|
||||
|
||||
const resolver = new DependencyResolver();
|
||||
const result = await resolver.resolve(bmadDir, []);
|
||||
|
||||
expect(result.allFiles).toHaveLength(4);
|
||||
});
|
||||
|
||||
it('should resolve multiple branches (A→B, A→C)', async () => {
|
||||
await createTestFile(
|
||||
bmadDir,
|
||||
'core/agents/agent-a.md',
|
||||
`---
|
||||
dependencies:
|
||||
- "{project-root}/bmad/core/tasks/task-b.md"
|
||||
- "{project-root}/bmad/core/tasks/task-c.md"
|
||||
---
|
||||
<agent>A</agent>`,
|
||||
);
|
||||
await createTestFile(bmadDir, 'core/tasks/task-b.md', 'Task B');
|
||||
await createTestFile(bmadDir, 'core/tasks/task-c.md', 'Task C');
|
||||
|
||||
const resolver = new DependencyResolver();
|
||||
const result = await resolver.resolve(bmadDir, []);
|
||||
|
||||
expect(result.allFiles).toHaveLength(3);
|
||||
expect(result.dependencies.size).toBe(2);
|
||||
});
|
||||
|
||||
it('should deduplicate diamond pattern (A→B,C; B,C→D)', async () => {
|
||||
await createTestFile(
|
||||
bmadDir,
|
||||
'core/agents/agent-a.md',
|
||||
`---
|
||||
dependencies:
|
||||
- "{project-root}/bmad/core/tasks/task-b.md"
|
||||
- "{project-root}/bmad/core/tasks/task-c.md"
|
||||
---
|
||||
<agent>A</agent>`,
|
||||
);
|
||||
await createTestFile(
|
||||
bmadDir,
|
||||
'core/tasks/task-b.md',
|
||||
`---
|
||||
template: "../templates/shared.yaml"
|
||||
---
|
||||
Task B`,
|
||||
);
|
||||
await createTestFile(
|
||||
bmadDir,
|
||||
'core/tasks/task-c.md',
|
||||
`---
|
||||
template: "../templates/shared.yaml"
|
||||
---
|
||||
Task C`,
|
||||
);
|
||||
await createTestFile(bmadDir, 'core/templates/shared.yaml', 'Shared template');
|
||||
|
||||
const resolver = new DependencyResolver();
|
||||
const result = await resolver.resolve(bmadDir, []);
|
||||
|
||||
// A + B + C + shared = 4 unique files (D appears twice but should be deduped)
|
||||
expect(result.allFiles).toHaveLength(4);
|
||||
});
|
||||
});
|
||||
|
||||
describe('circular dependency detection', () => {
|
||||
it('should detect direct circular dependency (A→B→A)', async () => {
|
||||
await createTestFile(
|
||||
bmadDir,
|
||||
'core/agents/agent-a.md',
|
||||
`---
|
||||
dependencies: ["{project-root}/bmad/core/tasks/task-b.md"]
|
||||
---
|
||||
<agent>A</agent>`,
|
||||
);
|
||||
await createTestFile(
|
||||
bmadDir,
|
||||
'core/tasks/task-b.md',
|
||||
`---
|
||||
dependencies: ["{project-root}/bmad/core/agents/agent-a.md"]
|
||||
---
|
||||
Task B`,
|
||||
);
|
||||
|
||||
const resolver = new DependencyResolver();
|
||||
|
||||
// Should not hang or crash
|
||||
const resultPromise = resolver.resolve(bmadDir, []);
|
||||
await expect(resultPromise).resolves.toBeDefined();
|
||||
|
||||
const result = await resultPromise;
|
||||
// Should process both files without infinite loop
|
||||
expect(result.allFiles.length).toBeGreaterThanOrEqual(2);
|
||||
}, 5000); // 5 second timeout to ensure no infinite loop
|
||||
|
||||
it('should detect indirect circular dependency (A→B→C→A)', async () => {
|
||||
await createTestFile(
|
||||
bmadDir,
|
||||
'core/agents/agent-a.md',
|
||||
`---
|
||||
dependencies: ["{project-root}/bmad/core/tasks/task-b.md"]
|
||||
---
|
||||
<agent>A</agent>`,
|
||||
);
|
||||
await createTestFile(
|
||||
bmadDir,
|
||||
'core/tasks/task-b.md',
|
||||
`---
|
||||
dependencies: ["{project-root}/bmad/core/tasks/task-c.md"]
|
||||
---
|
||||
Task B`,
|
||||
);
|
||||
await createTestFile(
|
||||
bmadDir,
|
||||
'core/tasks/task-c.md',
|
||||
`---
|
||||
dependencies: ["{project-root}/bmad/core/agents/agent-a.md"]
|
||||
---
|
||||
Task C`,
|
||||
);
|
||||
|
||||
const resolver = new DependencyResolver();
|
||||
const resultPromise = resolver.resolve(bmadDir, []);
|
||||
|
||||
await expect(resultPromise).resolves.toBeDefined();
|
||||
const result = await resultPromise;
|
||||
|
||||
// Should include all 3 files without duplicates
|
||||
expect(result.allFiles.length).toBeGreaterThanOrEqual(3);
|
||||
}, 5000);
|
||||
|
||||
it('should handle self-reference (A→A)', async () => {
|
||||
await createTestFile(
|
||||
bmadDir,
|
||||
'core/agents/agent-a.md',
|
||||
`---
|
||||
dependencies: ["{project-root}/bmad/core/agents/agent-a.md"]
|
||||
---
|
||||
<agent>A</agent>`,
|
||||
);
|
||||
|
||||
const resolver = new DependencyResolver();
|
||||
const result = await resolver.resolve(bmadDir, []);
|
||||
|
||||
// Should include the file once, not infinite times
|
||||
expect(result.allFiles).toHaveLength(1);
|
||||
}, 5000);
|
||||
});
|
||||
|
||||
describe('command reference parsing', () => {
|
||||
describe('parseCommandReferences()', () => {
|
||||
it('should extract @task- references', () => {
|
||||
const resolver = new DependencyResolver();
|
||||
const content = 'Use @task-analyze for analysis\nThen @task-review';
|
||||
|
||||
const refs = resolver.parseCommandReferences(content);
|
||||
|
||||
expect(refs).toContain('@task-analyze');
|
||||
expect(refs).toContain('@task-review');
|
||||
});
|
||||
|
||||
it('should extract @agent- references', () => {
|
||||
const resolver = new DependencyResolver();
|
||||
const content = 'Call @agent-architect then @agent-developer';
|
||||
|
||||
const refs = resolver.parseCommandReferences(content);
|
||||
|
||||
expect(refs).toContain('@agent-architect');
|
||||
expect(refs).toContain('@agent-developer');
|
||||
});
|
||||
|
||||
it('should extract bmad/ path references', () => {
|
||||
const resolver = new DependencyResolver();
|
||||
const content = 'See bmad/core/agents/analyst and bmad/bmm/tasks/review';
|
||||
|
||||
const refs = resolver.parseCommandReferences(content);
|
||||
|
||||
expect(refs).toContain('bmad/core/agents/analyst');
|
||||
expect(refs).toContain('bmad/bmm/tasks/review');
|
||||
});
|
||||
|
||||
it('should extract @bmad- references', () => {
|
||||
const resolver = new DependencyResolver();
|
||||
const content = 'Use @bmad-master command';
|
||||
|
||||
const refs = resolver.parseCommandReferences(content);
|
||||
|
||||
expect(refs).toContain('@bmad-master');
|
||||
});
|
||||
|
||||
it('should handle multiple reference types in same content', () => {
|
||||
const resolver = new DependencyResolver();
|
||||
const content = `
|
||||
Use @task-analyze for analysis
|
||||
Then run @agent-architect
|
||||
Finally check bmad/core/tasks/review
|
||||
`;
|
||||
|
||||
const refs = resolver.parseCommandReferences(content);
|
||||
|
||||
expect(refs.length).toBeGreaterThanOrEqual(3);
|
||||
});
|
||||
});
|
||||
|
||||
describe('parseFileReferences()', () => {
|
||||
it('should extract exec attribute paths', () => {
|
||||
const resolver = new DependencyResolver();
|
||||
const content = '<command exec="{project-root}/bmad/core/tasks/foo.md" />';
|
||||
|
||||
const refs = resolver.parseFileReferences(content);
|
||||
|
||||
expect(refs).toContain('/bmad/core/tasks/foo.md');
|
||||
});
|
||||
|
||||
it('should extract tmpl attribute paths', () => {
|
||||
const resolver = new DependencyResolver();
|
||||
const content = '<command tmpl="../templates/bar.yaml" />';
|
||||
|
||||
const refs = resolver.parseFileReferences(content);
|
||||
|
||||
expect(refs).toContain('../templates/bar.yaml');
|
||||
});
|
||||
|
||||
it('should extract relative file paths', () => {
|
||||
const resolver = new DependencyResolver();
|
||||
const content = 'Load "./data/config.json" and "../templates/form.yaml"';
|
||||
|
||||
const refs = resolver.parseFileReferences(content);
|
||||
|
||||
expect(refs).toContain('./data/config.json');
|
||||
expect(refs).toContain('../templates/form.yaml');
|
||||
});
|
||||
|
||||
it('should skip exec="*" wildcards', () => {
|
||||
const resolver = new DependencyResolver();
|
||||
const content = '<command exec="*" description="Dynamic" />';
|
||||
|
||||
const refs = resolver.parseFileReferences(content);
|
||||
|
||||
// Should not include "*"
|
||||
expect(refs).not.toContain('*');
|
||||
});
|
||||
});
|
||||
});
|
||||
|
||||
describe('module organization', () => {
|
||||
it('should organize files by module correctly', async () => {
|
||||
await createTestFile(bmadDir, 'core/agents/core-agent.md', '<agent>Core</agent>');
|
||||
await createTestFile(bmadDir, 'modules/bmm/agents/bmm-agent.md', '<agent>BMM</agent>');
|
||||
|
||||
const resolver = new DependencyResolver();
|
||||
const result = await resolver.resolve(bmadDir, ['bmm']);
|
||||
|
||||
expect(result.byModule.core).toBeDefined();
|
||||
expect(result.byModule.bmm).toBeDefined();
|
||||
expect(result.byModule.core.agents).toHaveLength(1);
|
||||
expect(result.byModule.bmm.agents).toHaveLength(1);
|
||||
});
|
||||
|
||||
it('should categorize files by type', async () => {
|
||||
await createTestFile(bmadDir, 'core/agents/agent.md', '<agent>Agent</agent>');
|
||||
await createTestFile(bmadDir, 'core/tasks/task.md', 'Task');
|
||||
await createTestFile(bmadDir, 'core/templates/template.yaml', 'template');
|
||||
|
||||
const resolver = new DependencyResolver();
|
||||
const files = [
|
||||
path.join(bmadDir, 'core/agents/agent.md'),
|
||||
path.join(bmadDir, 'core/tasks/task.md'),
|
||||
path.join(bmadDir, 'core/templates/template.yaml'),
|
||||
];
|
||||
|
||||
const organized = resolver.organizeByModule(bmadDir, new Set(files));
|
||||
|
||||
expect(organized.core.agents).toHaveLength(1);
|
||||
expect(organized.core.tasks).toHaveLength(1);
|
||||
expect(organized.core.templates).toHaveLength(1);
|
||||
});
|
||||
|
||||
it('should treat brain-tech as data, not tasks', async () => {
|
||||
await createTestFile(bmadDir, 'core/tasks/brain-tech/data.csv', 'col1,col2\nval1,val2');
|
||||
|
||||
const resolver = new DependencyResolver();
|
||||
const files = [path.join(bmadDir, 'core/tasks/brain-tech/data.csv')];
|
||||
|
||||
const organized = resolver.organizeByModule(bmadDir, new Set(files));
|
||||
|
||||
expect(organized.core.data).toHaveLength(1);
|
||||
expect(organized.core.tasks).toHaveLength(0);
|
||||
});
|
||||
});
|
||||
|
||||
describe('getModuleFromPath()', () => {
|
||||
it('should extract module from src/core path', () => {
|
||||
const resolver = new DependencyResolver();
|
||||
const filePath = path.join(bmadDir, 'core/agents/agent.md');
|
||||
|
||||
const module = resolver.getModuleFromPath(bmadDir, filePath);
|
||||
|
||||
expect(module).toBe('core');
|
||||
});
|
||||
|
||||
it('should extract module from src/modules/bmm path', () => {
|
||||
const resolver = new DependencyResolver();
|
||||
const filePath = path.join(bmadDir, 'modules/bmm/agents/pm.md');
|
||||
|
||||
const module = resolver.getModuleFromPath(bmadDir, filePath);
|
||||
|
||||
expect(module).toBe('bmm');
|
||||
});
|
||||
|
||||
it('should handle installed directory structure', async () => {
|
||||
// Create installed structure (no src/ prefix)
|
||||
const installedDir = path.join(tmpDir, 'installed');
|
||||
await fs.ensureDir(path.join(installedDir, 'core/agents'));
|
||||
await fs.ensureDir(path.join(installedDir, 'modules/bmm/agents'));
|
||||
|
||||
const resolver = new DependencyResolver();
|
||||
|
||||
const coreFile = path.join(installedDir, 'core/agents/agent.md');
|
||||
const moduleFile = path.join(installedDir, 'modules/bmm/agents/pm.md');
|
||||
|
||||
expect(resolver.getModuleFromPath(installedDir, coreFile)).toBe('core');
|
||||
expect(resolver.getModuleFromPath(installedDir, moduleFile)).toBe('bmm');
|
||||
});
|
||||
});
|
||||
|
||||
describe('edge cases', () => {
|
||||
it('should handle malformed YAML frontmatter', async () => {
|
||||
await createTestFile(
|
||||
bmadDir,
|
||||
'core/agents/bad-yaml.md',
|
||||
`---
|
||||
dependencies: [invalid: yaml: here
|
||||
---
|
||||
<agent>Agent</agent>`,
|
||||
);
|
||||
|
||||
const resolver = new DependencyResolver();
|
||||
|
||||
// Should not crash, just warn and continue
|
||||
await expect(resolver.resolve(bmadDir, [])).resolves.toBeDefined();
|
||||
});
|
||||
|
||||
it('should handle backticks in YAML values', async () => {
|
||||
await createTestFile(
|
||||
bmadDir,
|
||||
'core/agents/backticks.md',
|
||||
`---
|
||||
name: \`test\`
|
||||
dependencies: [\`{project-root}/bmad/core/tasks/task.md\`]
|
||||
---
|
||||
<agent>Agent</agent>`,
|
||||
);
|
||||
await createTestFile(bmadDir, 'core/tasks/task.md', 'Task');
|
||||
|
||||
const resolver = new DependencyResolver();
|
||||
const result = await resolver.resolve(bmadDir, []);
|
||||
|
||||
// Backticks should be pre-processed
|
||||
expect(result.allFiles.length).toBeGreaterThanOrEqual(1);
|
||||
});
|
||||
|
||||
it('should handle missing dependencies gracefully', async () => {
|
||||
await createTestFile(
|
||||
bmadDir,
|
||||
'core/agents/agent.md',
|
||||
`---
|
||||
dependencies: ["{project-root}/bmad/core/tasks/missing.md"]
|
||||
---
|
||||
<agent>Agent</agent>`,
|
||||
);
|
||||
// Don't create missing.md
|
||||
|
||||
const resolver = new DependencyResolver();
|
||||
const result = await resolver.resolve(bmadDir, []);
|
||||
|
||||
expect(result.primaryFiles.length).toBeGreaterThanOrEqual(1);
|
||||
// Implementation may or may not track missing dependencies
|
||||
// Just verify it doesn't crash
|
||||
expect(result).toBeDefined();
|
||||
});
|
||||
|
||||
it('should handle empty dependencies array', async () => {
|
||||
await createTestFile(
|
||||
bmadDir,
|
||||
'core/agents/agent.md',
|
||||
`---
|
||||
dependencies: []
|
||||
---
|
||||
<agent>Agent</agent>`,
|
||||
);
|
||||
|
||||
const resolver = new DependencyResolver();
|
||||
const result = await resolver.resolve(bmadDir, []);
|
||||
|
||||
expect(result.primaryFiles).toHaveLength(1);
|
||||
expect(result.allFiles).toHaveLength(1);
|
||||
});
|
||||
|
||||
it('should handle missing frontmatter', async () => {
|
||||
await createTestFile(bmadDir, 'core/agents/no-frontmatter.md', '<agent>Agent</agent>');
|
||||
|
||||
const resolver = new DependencyResolver();
|
||||
const result = await resolver.resolve(bmadDir, []);
|
||||
|
||||
expect(result.primaryFiles).toHaveLength(1);
|
||||
expect(result.allFiles).toHaveLength(1);
|
||||
});
|
||||
|
||||
it('should handle non-existent module directory', async () => {
|
||||
// Create at least one core file so core module appears
|
||||
await createTestFile(bmadDir, 'core/agents/core-agent.md', '<agent>Core</agent>');
|
||||
|
||||
const resolver = new DependencyResolver();
|
||||
const result = await resolver.resolve(bmadDir, ['nonexistent']);
|
||||
|
||||
// Should include core even though nonexistent module not found
|
||||
expect(result.byModule.core).toBeDefined();
|
||||
expect(result.byModule.nonexistent).toBeUndefined();
|
||||
});
|
||||
});
|
||||
|
||||
describe('cross-module dependencies', () => {
|
||||
it('should resolve dependencies across modules', async () => {
|
||||
await createTestFile(bmadDir, 'core/agents/core-agent.md', '<agent>Core</agent>');
|
||||
await createTestFile(
|
||||
bmadDir,
|
||||
'modules/bmm/agents/bmm-agent.md',
|
||||
`---
|
||||
dependencies: ["{project-root}/bmad/core/tasks/shared-task.md"]
|
||||
---
|
||||
<agent>BMM Agent</agent>`,
|
||||
);
|
||||
await createTestFile(bmadDir, 'core/tasks/shared-task.md', 'Shared task');
|
||||
|
||||
const resolver = new DependencyResolver();
|
||||
const result = await resolver.resolve(bmadDir, ['bmm']);
|
||||
|
||||
// Should include: core agent + bmm agent + shared task
|
||||
expect(result.allFiles.length).toBeGreaterThanOrEqual(3);
|
||||
expect(result.byModule.core).toBeDefined();
|
||||
expect(result.byModule.bmm).toBeDefined();
|
||||
});
|
||||
|
||||
it('should resolve module tasks', async () => {
|
||||
await createTestFile(bmadDir, 'core/agents/core-agent.md', '<agent>Core</agent>');
|
||||
await createTestFile(bmadDir, 'modules/bmm/agents/pm.md', '<agent>PM</agent>');
|
||||
await createTestFile(bmadDir, 'modules/bmm/tasks/create-prd.md', 'Create PRD task');
|
||||
|
||||
const resolver = new DependencyResolver();
|
||||
const result = await resolver.resolve(bmadDir, ['bmm']);
|
||||
|
||||
expect(result.byModule.bmm.agents).toHaveLength(1);
|
||||
expect(result.byModule.bmm.tasks).toHaveLength(1);
|
||||
});
|
||||
});
|
||||
});
|
||||
|
|
@ -0,0 +1,243 @@
|
|||
import { describe, it, expect, beforeEach, afterEach } from 'vitest';
|
||||
import { FileOps } from '../../../tools/cli/lib/file-ops.js';
|
||||
import { createTempDir, cleanupTempDir, createTestFile } from '../../helpers/temp-dir.js';
|
||||
import fs from 'fs-extra';
|
||||
import path from 'node:path';
|
||||
|
||||
describe('FileOps', () => {
|
||||
describe('copyDirectory()', () => {
|
||||
const fileOps = new FileOps();
|
||||
let tmpDir;
|
||||
let sourceDir;
|
||||
let destDir;
|
||||
|
||||
beforeEach(async () => {
|
||||
tmpDir = await createTempDir();
|
||||
sourceDir = path.join(tmpDir, 'source');
|
||||
destDir = path.join(tmpDir, 'dest');
|
||||
await fs.ensureDir(sourceDir);
|
||||
await fs.ensureDir(destDir);
|
||||
});
|
||||
|
||||
afterEach(async () => {
|
||||
await cleanupTempDir(tmpDir);
|
||||
});
|
||||
|
||||
describe('basic copying', () => {
|
||||
it('should copy a single file', async () => {
|
||||
await createTestFile(sourceDir, 'test.txt', 'content');
|
||||
|
||||
await fileOps.copyDirectory(sourceDir, destDir);
|
||||
|
||||
const destFile = path.join(destDir, 'test.txt');
|
||||
expect(await fs.pathExists(destFile)).toBe(true);
|
||||
expect(await fs.readFile(destFile, 'utf8')).toBe('content');
|
||||
});
|
||||
|
||||
it('should copy multiple files', async () => {
|
||||
await createTestFile(sourceDir, 'file1.txt', 'content1');
|
||||
await createTestFile(sourceDir, 'file2.md', 'content2');
|
||||
await createTestFile(sourceDir, 'file3.json', '{}');
|
||||
|
||||
await fileOps.copyDirectory(sourceDir, destDir);
|
||||
|
||||
expect(await fs.pathExists(path.join(destDir, 'file1.txt'))).toBe(true);
|
||||
expect(await fs.pathExists(path.join(destDir, 'file2.md'))).toBe(true);
|
||||
expect(await fs.pathExists(path.join(destDir, 'file3.json'))).toBe(true);
|
||||
});
|
||||
|
||||
it('should copy nested directory structure', async () => {
|
||||
await createTestFile(sourceDir, 'root.txt', 'root');
|
||||
await createTestFile(sourceDir, 'level1/file.txt', 'level1');
|
||||
await createTestFile(sourceDir, 'level1/level2/deep.txt', 'deep');
|
||||
|
||||
await fileOps.copyDirectory(sourceDir, destDir);
|
||||
|
||||
expect(await fs.pathExists(path.join(destDir, 'root.txt'))).toBe(true);
|
||||
expect(await fs.pathExists(path.join(destDir, 'level1', 'file.txt'))).toBe(true);
|
||||
expect(await fs.pathExists(path.join(destDir, 'level1', 'level2', 'deep.txt'))).toBe(true);
|
||||
});
|
||||
|
||||
it('should create destination directory if it does not exist', async () => {
|
||||
const newDest = path.join(tmpDir, 'new-dest');
|
||||
await createTestFile(sourceDir, 'test.txt', 'content');
|
||||
|
||||
await fileOps.copyDirectory(sourceDir, newDest);
|
||||
|
||||
expect(await fs.pathExists(newDest)).toBe(true);
|
||||
expect(await fs.pathExists(path.join(newDest, 'test.txt'))).toBe(true);
|
||||
});
|
||||
});
|
||||
|
||||
describe('overwrite behavior', () => {
|
||||
it('should overwrite existing files by default', async () => {
|
||||
await createTestFile(sourceDir, 'file.txt', 'new content');
|
||||
await createTestFile(destDir, 'file.txt', 'old content');
|
||||
|
||||
await fileOps.copyDirectory(sourceDir, destDir);
|
||||
|
||||
const content = await fs.readFile(path.join(destDir, 'file.txt'), 'utf8');
|
||||
expect(content).toBe('new content');
|
||||
});
|
||||
|
||||
it('should preserve file content when overwriting', async () => {
|
||||
await createTestFile(sourceDir, 'data.json', '{"new": true}');
|
||||
await createTestFile(destDir, 'data.json', '{"old": true}');
|
||||
await createTestFile(destDir, 'keep.txt', 'preserve this');
|
||||
|
||||
await fileOps.copyDirectory(sourceDir, destDir);
|
||||
|
||||
expect(await fs.readFile(path.join(destDir, 'data.json'), 'utf8')).toBe('{"new": true}');
|
||||
// Files not in source should be preserved
|
||||
expect(await fs.pathExists(path.join(destDir, 'keep.txt'))).toBe(true);
|
||||
});
|
||||
});
|
||||
|
||||
describe('filtering with shouldIgnore', () => {
|
||||
it('should filter out .git directories', async () => {
|
||||
await createTestFile(sourceDir, 'file.txt', 'content');
|
||||
await createTestFile(sourceDir, '.git/config', 'git config');
|
||||
|
||||
await fileOps.copyDirectory(sourceDir, destDir);
|
||||
|
||||
expect(await fs.pathExists(path.join(destDir, 'file.txt'))).toBe(true);
|
||||
expect(await fs.pathExists(path.join(destDir, '.git'))).toBe(false);
|
||||
});
|
||||
|
||||
it('should filter out node_modules directories', async () => {
|
||||
await createTestFile(sourceDir, 'package.json', '{}');
|
||||
await createTestFile(sourceDir, 'node_modules/lib/code.js', 'code');
|
||||
|
||||
await fileOps.copyDirectory(sourceDir, destDir);
|
||||
|
||||
expect(await fs.pathExists(path.join(destDir, 'package.json'))).toBe(true);
|
||||
expect(await fs.pathExists(path.join(destDir, 'node_modules'))).toBe(false);
|
||||
});
|
||||
|
||||
it('should filter out *.swp and *.tmp files', async () => {
|
||||
await createTestFile(sourceDir, 'document.txt', 'content');
|
||||
await createTestFile(sourceDir, 'document.txt.swp', 'vim swap');
|
||||
await createTestFile(sourceDir, 'temp.tmp', 'temporary');
|
||||
|
||||
await fileOps.copyDirectory(sourceDir, destDir);
|
||||
|
||||
expect(await fs.pathExists(path.join(destDir, 'document.txt'))).toBe(true);
|
||||
expect(await fs.pathExists(path.join(destDir, 'document.txt.swp'))).toBe(false);
|
||||
expect(await fs.pathExists(path.join(destDir, 'temp.tmp'))).toBe(false);
|
||||
});
|
||||
|
||||
it('should filter out .DS_Store files', async () => {
|
||||
await createTestFile(sourceDir, 'file.txt', 'content');
|
||||
await createTestFile(sourceDir, '.DS_Store', 'mac metadata');
|
||||
|
||||
await fileOps.copyDirectory(sourceDir, destDir);
|
||||
|
||||
expect(await fs.pathExists(path.join(destDir, 'file.txt'))).toBe(true);
|
||||
expect(await fs.pathExists(path.join(destDir, '.DS_Store'))).toBe(false);
|
||||
});
|
||||
});
|
||||
|
||||
describe('edge cases', () => {
|
||||
it('should handle empty source directory', async () => {
|
||||
await fileOps.copyDirectory(sourceDir, destDir);
|
||||
|
||||
const files = await fs.readdir(destDir);
|
||||
expect(files).toHaveLength(0);
|
||||
});
|
||||
|
||||
it('should handle Unicode filenames', async () => {
|
||||
await createTestFile(sourceDir, '测试.txt', 'chinese');
|
||||
await createTestFile(sourceDir, 'файл.json', 'russian');
|
||||
|
||||
await fileOps.copyDirectory(sourceDir, destDir);
|
||||
|
||||
expect(await fs.pathExists(path.join(destDir, '测试.txt'))).toBe(true);
|
||||
expect(await fs.pathExists(path.join(destDir, 'файл.json'))).toBe(true);
|
||||
});
|
||||
|
||||
it('should handle filenames with special characters', async () => {
|
||||
await createTestFile(sourceDir, 'file with spaces.txt', 'content');
|
||||
await createTestFile(sourceDir, 'special-chars!@#.md', 'content');
|
||||
|
||||
await fileOps.copyDirectory(sourceDir, destDir);
|
||||
|
||||
expect(await fs.pathExists(path.join(destDir, 'file with spaces.txt'))).toBe(true);
|
||||
expect(await fs.pathExists(path.join(destDir, 'special-chars!@#.md'))).toBe(true);
|
||||
});
|
||||
|
||||
it('should handle very deep directory nesting', async () => {
|
||||
const deepPath = Array.from({ length: 10 }, (_, i) => `level${i}`).join('/');
|
||||
await createTestFile(sourceDir, `${deepPath}/deep.txt`, 'very deep');
|
||||
|
||||
await fileOps.copyDirectory(sourceDir, destDir);
|
||||
|
||||
expect(await fs.pathExists(path.join(destDir, ...deepPath.split('/'), 'deep.txt'))).toBe(true);
|
||||
});
|
||||
|
||||
it('should preserve file permissions', async () => {
|
||||
const execFile = path.join(sourceDir, 'script.sh');
|
||||
await fs.writeFile(execFile, '#!/bin/bash\necho "test"');
|
||||
await fs.chmod(execFile, 0o755); // Make executable
|
||||
|
||||
await fileOps.copyDirectory(sourceDir, destDir);
|
||||
|
||||
const destFile = path.join(destDir, 'script.sh');
|
||||
const stats = await fs.stat(destFile);
|
||||
// Check if file is executable (user execute bit)
|
||||
expect((stats.mode & 0o100) !== 0).toBe(true);
|
||||
});
|
||||
|
||||
it('should handle large number of files', async () => {
|
||||
// Create 50 files
|
||||
const promises = Array.from({ length: 50 }, (_, i) => createTestFile(sourceDir, `file${i}.txt`, `content ${i}`));
|
||||
await Promise.all(promises);
|
||||
|
||||
await fileOps.copyDirectory(sourceDir, destDir);
|
||||
|
||||
const destFiles = await fs.readdir(destDir);
|
||||
expect(destFiles).toHaveLength(50);
|
||||
});
|
||||
});
|
||||
|
||||
describe('content integrity', () => {
|
||||
it('should preserve file content exactly', async () => {
|
||||
const content = 'Line 1\nLine 2\nLine 3\n';
|
||||
await createTestFile(sourceDir, 'file.txt', content);
|
||||
|
||||
await fileOps.copyDirectory(sourceDir, destDir);
|
||||
|
||||
const copiedContent = await fs.readFile(path.join(destDir, 'file.txt'), 'utf8');
|
||||
expect(copiedContent).toBe(content);
|
||||
});
|
||||
|
||||
it('should preserve binary file content', async () => {
|
||||
const buffer = Buffer.from([0x89, 0x50, 0x4e, 0x47, 0x0d, 0x0a, 0x1a, 0x0a]);
|
||||
await fs.writeFile(path.join(sourceDir, 'binary.dat'), buffer);
|
||||
|
||||
await fileOps.copyDirectory(sourceDir, destDir);
|
||||
|
||||
const copiedBuffer = await fs.readFile(path.join(destDir, 'binary.dat'));
|
||||
expect(copiedBuffer).toEqual(buffer);
|
||||
});
|
||||
|
||||
it('should preserve UTF-8 content', async () => {
|
||||
const utf8Content = 'Hello 世界 🌍';
|
||||
await createTestFile(sourceDir, 'utf8.txt', utf8Content);
|
||||
|
||||
await fileOps.copyDirectory(sourceDir, destDir);
|
||||
|
||||
const copied = await fs.readFile(path.join(destDir, 'utf8.txt'), 'utf8');
|
||||
expect(copied).toBe(utf8Content);
|
||||
});
|
||||
|
||||
it('should preserve empty files', async () => {
|
||||
await createTestFile(sourceDir, 'empty.txt', '');
|
||||
|
||||
await fileOps.copyDirectory(sourceDir, destDir);
|
||||
|
||||
const content = await fs.readFile(path.join(destDir, 'empty.txt'), 'utf8');
|
||||
expect(content).toBe('');
|
||||
});
|
||||
});
|
||||
});
|
||||
});
|
||||
|
|
@ -0,0 +1,211 @@
|
|||
import { describe, it, expect, beforeEach, afterEach } from 'vitest';
|
||||
import { FileOps } from '../../../tools/cli/lib/file-ops.js';
|
||||
import { createTempDir, cleanupTempDir, createTestFile } from '../../helpers/temp-dir.js';
|
||||
|
||||
describe('FileOps', () => {
|
||||
describe('getFileHash()', () => {
|
||||
const fileOps = new FileOps();
|
||||
let tmpDir;
|
||||
|
||||
beforeEach(async () => {
|
||||
tmpDir = await createTempDir();
|
||||
});
|
||||
|
||||
afterEach(async () => {
|
||||
await cleanupTempDir(tmpDir);
|
||||
});
|
||||
|
||||
describe('basic hashing', () => {
|
||||
it('should return SHA256 hash for a simple file', async () => {
|
||||
const filePath = await createTestFile(tmpDir, 'test.txt', 'hello');
|
||||
const hash = await fileOps.getFileHash(filePath);
|
||||
|
||||
// SHA256 of 'hello' is known
|
||||
expect(hash).toBe('2cf24dba5fb0a30e26e83b2ac5b9e29e1b161e5c1fa7425e73043362938b9824');
|
||||
expect(hash).toHaveLength(64); // SHA256 is 64 hex characters
|
||||
});
|
||||
|
||||
it('should return consistent hash for same content', async () => {
|
||||
const content = 'test content for hashing';
|
||||
const file1 = await createTestFile(tmpDir, 'file1.txt', content);
|
||||
const file2 = await createTestFile(tmpDir, 'file2.txt', content);
|
||||
|
||||
const hash1 = await fileOps.getFileHash(file1);
|
||||
const hash2 = await fileOps.getFileHash(file2);
|
||||
|
||||
expect(hash1).toBe(hash2);
|
||||
});
|
||||
|
||||
it('should return different hash for different content', async () => {
|
||||
const file1 = await createTestFile(tmpDir, 'file1.txt', 'content A');
|
||||
const file2 = await createTestFile(tmpDir, 'file2.txt', 'content B');
|
||||
|
||||
const hash1 = await fileOps.getFileHash(file1);
|
||||
const hash2 = await fileOps.getFileHash(file2);
|
||||
|
||||
expect(hash1).not.toBe(hash2);
|
||||
});
|
||||
});
|
||||
|
||||
describe('file size handling', () => {
|
||||
it('should handle empty file', async () => {
|
||||
const filePath = await createTestFile(tmpDir, 'empty.txt', '');
|
||||
const hash = await fileOps.getFileHash(filePath);
|
||||
|
||||
// SHA256 of empty string
|
||||
expect(hash).toBe('e3b0c44298fc1c149afbf4c8996fb92427ae41e4649b934ca495991b7852b855');
|
||||
});
|
||||
|
||||
it('should handle small file (<4KB)', async () => {
|
||||
const content = 'a'.repeat(1000); // 1KB
|
||||
const filePath = await createTestFile(tmpDir, 'small.txt', content);
|
||||
const hash = await fileOps.getFileHash(filePath);
|
||||
|
||||
expect(hash).toHaveLength(64);
|
||||
expect(hash).toMatch(/^[a-f0-9]{64}$/);
|
||||
});
|
||||
|
||||
it('should handle medium file (~1MB)', async () => {
|
||||
const content = 'x'.repeat(1024 * 1024); // 1MB
|
||||
const filePath = await createTestFile(tmpDir, 'medium.txt', content);
|
||||
const hash = await fileOps.getFileHash(filePath);
|
||||
|
||||
expect(hash).toHaveLength(64);
|
||||
expect(hash).toMatch(/^[a-f0-9]{64}$/);
|
||||
});
|
||||
|
||||
it('should handle large file (~10MB) via streaming', async () => {
|
||||
// Create a 10MB file
|
||||
const chunkSize = 1024 * 1024; // 1MB chunks
|
||||
const chunks = Array.from({ length: 10 }, () => 'y'.repeat(chunkSize));
|
||||
const content = chunks.join('');
|
||||
|
||||
const filePath = await createTestFile(tmpDir, 'large.txt', content);
|
||||
const hash = await fileOps.getFileHash(filePath);
|
||||
|
||||
expect(hash).toHaveLength(64);
|
||||
expect(hash).toMatch(/^[a-f0-9]{64}$/);
|
||||
}, 15_000); // 15 second timeout for large file
|
||||
});
|
||||
|
||||
describe('content type handling', () => {
|
||||
it('should handle binary content', async () => {
|
||||
// Create a buffer with binary data
|
||||
const buffer = Buffer.from([0x89, 0x50, 0x4e, 0x47, 0x0d, 0x0a, 0x1a, 0x0a]);
|
||||
const filePath = await createTestFile(tmpDir, 'binary.dat', buffer.toString('binary'));
|
||||
const hash = await fileOps.getFileHash(filePath);
|
||||
|
||||
expect(hash).toHaveLength(64);
|
||||
expect(hash).toMatch(/^[a-f0-9]{64}$/);
|
||||
});
|
||||
|
||||
it('should handle UTF-8 content correctly', async () => {
|
||||
const content = 'Hello 世界 🌍';
|
||||
const filePath = await createTestFile(tmpDir, 'utf8.txt', content);
|
||||
const hash = await fileOps.getFileHash(filePath);
|
||||
|
||||
// Hash should be consistent for UTF-8 content
|
||||
const hash2 = await fileOps.getFileHash(filePath);
|
||||
expect(hash).toBe(hash2);
|
||||
expect(hash).toHaveLength(64);
|
||||
});
|
||||
|
||||
it('should handle newline characters', async () => {
|
||||
const contentLF = 'line1\nline2\nline3';
|
||||
const contentCRLF = 'line1\r\nline2\r\nline3';
|
||||
|
||||
const fileLF = await createTestFile(tmpDir, 'lf.txt', contentLF);
|
||||
const fileCRLF = await createTestFile(tmpDir, 'crlf.txt', contentCRLF);
|
||||
|
||||
const hashLF = await fileOps.getFileHash(fileLF);
|
||||
const hashCRLF = await fileOps.getFileHash(fileCRLF);
|
||||
|
||||
// Different line endings should produce different hashes
|
||||
expect(hashLF).not.toBe(hashCRLF);
|
||||
});
|
||||
|
||||
it('should handle JSON content', async () => {
|
||||
const json = JSON.stringify({ key: 'value', nested: { array: [1, 2, 3] } }, null, 2);
|
||||
const filePath = await createTestFile(tmpDir, 'data.json', json);
|
||||
const hash = await fileOps.getFileHash(filePath);
|
||||
|
||||
expect(hash).toHaveLength(64);
|
||||
});
|
||||
});
|
||||
|
||||
describe('edge cases', () => {
|
||||
it('should handle file with special characters in name', async () => {
|
||||
const filePath = await createTestFile(tmpDir, 'file with spaces & special-chars.txt', 'content');
|
||||
const hash = await fileOps.getFileHash(filePath);
|
||||
|
||||
expect(hash).toHaveLength(64);
|
||||
});
|
||||
|
||||
it('should handle concurrent hash calculations', async () => {
|
||||
const files = await Promise.all([
|
||||
createTestFile(tmpDir, 'file1.txt', 'content 1'),
|
||||
createTestFile(tmpDir, 'file2.txt', 'content 2'),
|
||||
createTestFile(tmpDir, 'file3.txt', 'content 3'),
|
||||
]);
|
||||
|
||||
// Calculate hashes concurrently
|
||||
const hashes = await Promise.all(files.map((file) => fileOps.getFileHash(file)));
|
||||
|
||||
// All hashes should be valid
|
||||
expect(hashes).toHaveLength(3);
|
||||
for (const hash of hashes) {
|
||||
expect(hash).toMatch(/^[a-f0-9]{64}$/);
|
||||
}
|
||||
|
||||
// Hashes should be different
|
||||
expect(hashes[0]).not.toBe(hashes[1]);
|
||||
expect(hashes[1]).not.toBe(hashes[2]);
|
||||
expect(hashes[0]).not.toBe(hashes[2]);
|
||||
});
|
||||
|
||||
it('should handle file with only whitespace', async () => {
|
||||
const filePath = await createTestFile(tmpDir, 'whitespace.txt', ' ');
|
||||
const hash = await fileOps.getFileHash(filePath);
|
||||
|
||||
expect(hash).toHaveLength(64);
|
||||
// Should be different from empty file
|
||||
expect(hash).not.toBe('e3b0c44298fc1c149afbf4c8996fb92427ae41e4649b934ca495991b7852b855');
|
||||
});
|
||||
|
||||
it('should handle very long single line', async () => {
|
||||
const longLine = 'x'.repeat(100_000); // 100KB single line
|
||||
const filePath = await createTestFile(tmpDir, 'longline.txt', longLine);
|
||||
const hash = await fileOps.getFileHash(filePath);
|
||||
|
||||
expect(hash).toHaveLength(64);
|
||||
});
|
||||
});
|
||||
|
||||
describe('error handling', () => {
|
||||
it('should reject for non-existent file', async () => {
|
||||
const nonExistentPath = `${tmpDir}/does-not-exist.txt`;
|
||||
|
||||
await expect(fileOps.getFileHash(nonExistentPath)).rejects.toThrow();
|
||||
});
|
||||
|
||||
it('should reject for directory instead of file', async () => {
|
||||
await expect(fileOps.getFileHash(tmpDir)).rejects.toThrow();
|
||||
});
|
||||
});
|
||||
|
||||
describe('streaming behavior', () => {
|
||||
it('should use streaming for efficiency (test implementation detail)', async () => {
|
||||
// This test verifies that the implementation uses streams
|
||||
// by checking that large files can be processed without loading entirely into memory
|
||||
const largeContent = 'z'.repeat(5 * 1024 * 1024); // 5MB
|
||||
const filePath = await createTestFile(tmpDir, 'stream.txt', largeContent);
|
||||
|
||||
// If this completes without memory issues, streaming is working
|
||||
const hash = await fileOps.getFileHash(filePath);
|
||||
|
||||
expect(hash).toHaveLength(64);
|
||||
expect(hash).toMatch(/^[a-f0-9]{64}$/);
|
||||
}, 10_000);
|
||||
});
|
||||
});
|
||||
});
|
||||
|
|
@ -0,0 +1,283 @@
|
|||
import { describe, it, expect, beforeEach, afterEach } from 'vitest';
|
||||
import { FileOps } from '../../../tools/cli/lib/file-ops.js';
|
||||
import { createTempDir, cleanupTempDir, createTestFile, createTestDirs } from '../../helpers/temp-dir.js';
|
||||
import path from 'node:path';
|
||||
|
||||
describe('FileOps', () => {
|
||||
describe('getFileList()', () => {
|
||||
const fileOps = new FileOps();
|
||||
let tmpDir;
|
||||
|
||||
beforeEach(async () => {
|
||||
tmpDir = await createTempDir();
|
||||
});
|
||||
|
||||
afterEach(async () => {
|
||||
await cleanupTempDir(tmpDir);
|
||||
});
|
||||
|
||||
describe('basic functionality', () => {
|
||||
it('should return empty array for empty directory', async () => {
|
||||
const files = await fileOps.getFileList(tmpDir);
|
||||
expect(files).toEqual([]);
|
||||
});
|
||||
|
||||
it('should return single file in directory', async () => {
|
||||
await createTestFile(tmpDir, 'test.txt', 'content');
|
||||
|
||||
const files = await fileOps.getFileList(tmpDir);
|
||||
|
||||
expect(files).toHaveLength(1);
|
||||
expect(files[0]).toBe('test.txt');
|
||||
});
|
||||
|
||||
it('should return multiple files in directory', async () => {
|
||||
await createTestFile(tmpDir, 'file1.txt', 'content1');
|
||||
await createTestFile(tmpDir, 'file2.md', 'content2');
|
||||
await createTestFile(tmpDir, 'file3.json', 'content3');
|
||||
|
||||
const files = await fileOps.getFileList(tmpDir);
|
||||
|
||||
expect(files).toHaveLength(3);
|
||||
expect(files).toContain('file1.txt');
|
||||
expect(files).toContain('file2.md');
|
||||
expect(files).toContain('file3.json');
|
||||
});
|
||||
});
|
||||
|
||||
describe('recursive directory walking', () => {
|
||||
it('should recursively find files in nested directories', async () => {
|
||||
await createTestFile(tmpDir, 'root.txt', 'root');
|
||||
await createTestFile(tmpDir, 'level1/file1.txt', 'level1');
|
||||
await createTestFile(tmpDir, 'level1/level2/file2.txt', 'level2');
|
||||
await createTestFile(tmpDir, 'level1/level2/level3/file3.txt', 'level3');
|
||||
|
||||
const files = await fileOps.getFileList(tmpDir);
|
||||
|
||||
expect(files).toHaveLength(4);
|
||||
expect(files).toContain('root.txt');
|
||||
expect(files).toContain(path.join('level1', 'file1.txt'));
|
||||
expect(files).toContain(path.join('level1', 'level2', 'file2.txt'));
|
||||
expect(files).toContain(path.join('level1', 'level2', 'level3', 'file3.txt'));
|
||||
});
|
||||
|
||||
it('should handle multiple subdirectories at same level', async () => {
|
||||
await createTestFile(tmpDir, 'dir1/file1.txt', 'content');
|
||||
await createTestFile(tmpDir, 'dir2/file2.txt', 'content');
|
||||
await createTestFile(tmpDir, 'dir3/file3.txt', 'content');
|
||||
|
||||
const files = await fileOps.getFileList(tmpDir);
|
||||
|
||||
expect(files).toHaveLength(3);
|
||||
expect(files).toContain(path.join('dir1', 'file1.txt'));
|
||||
expect(files).toContain(path.join('dir2', 'file2.txt'));
|
||||
expect(files).toContain(path.join('dir3', 'file3.txt'));
|
||||
});
|
||||
|
||||
it('should not include empty directories in results', async () => {
|
||||
await createTestDirs(tmpDir, ['empty1', 'empty2', 'has-file']);
|
||||
await createTestFile(tmpDir, 'has-file/file.txt', 'content');
|
||||
|
||||
const files = await fileOps.getFileList(tmpDir);
|
||||
|
||||
expect(files).toHaveLength(1);
|
||||
expect(files[0]).toBe(path.join('has-file', 'file.txt'));
|
||||
});
|
||||
});
|
||||
|
||||
describe('ignore filtering', () => {
|
||||
it('should ignore .git directories', async () => {
|
||||
await createTestFile(tmpDir, 'normal.txt', 'content');
|
||||
await createTestFile(tmpDir, '.git/config', 'git config');
|
||||
await createTestFile(tmpDir, '.git/hooks/pre-commit', 'hook');
|
||||
|
||||
const files = await fileOps.getFileList(tmpDir);
|
||||
|
||||
expect(files).toHaveLength(1);
|
||||
expect(files[0]).toBe('normal.txt');
|
||||
});
|
||||
|
||||
it('should ignore node_modules directories', async () => {
|
||||
await createTestFile(tmpDir, 'package.json', '{}');
|
||||
await createTestFile(tmpDir, 'node_modules/package/index.js', 'code');
|
||||
await createTestFile(tmpDir, 'node_modules/package/lib/util.js', 'util');
|
||||
|
||||
const files = await fileOps.getFileList(tmpDir);
|
||||
|
||||
expect(files).toHaveLength(1);
|
||||
expect(files[0]).toBe('package.json');
|
||||
});
|
||||
|
||||
it('should ignore .DS_Store files', async () => {
|
||||
await createTestFile(tmpDir, 'file.txt', 'content');
|
||||
await createTestFile(tmpDir, '.DS_Store', 'mac metadata');
|
||||
await createTestFile(tmpDir, 'subdir/.DS_Store', 'mac metadata');
|
||||
|
||||
const files = await fileOps.getFileList(tmpDir);
|
||||
|
||||
expect(files).toHaveLength(1);
|
||||
expect(files[0]).toBe('file.txt');
|
||||
});
|
||||
|
||||
it('should ignore *.swp and *.tmp files', async () => {
|
||||
await createTestFile(tmpDir, 'document.txt', 'content');
|
||||
await createTestFile(tmpDir, 'document.txt.swp', 'vim swap');
|
||||
await createTestFile(tmpDir, 'temp.tmp', 'temporary');
|
||||
|
||||
const files = await fileOps.getFileList(tmpDir);
|
||||
|
||||
expect(files).toHaveLength(1);
|
||||
expect(files[0]).toBe('document.txt');
|
||||
});
|
||||
|
||||
it('should ignore multiple ignored patterns together', async () => {
|
||||
await createTestFile(tmpDir, 'src/index.js', 'source code');
|
||||
await createTestFile(tmpDir, 'node_modules/lib/code.js', 'dependency');
|
||||
await createTestFile(tmpDir, '.git/config', 'git config');
|
||||
await createTestFile(tmpDir, '.DS_Store', 'mac file');
|
||||
await createTestFile(tmpDir, 'file.swp', 'swap file');
|
||||
await createTestFile(tmpDir, '.idea/workspace.xml', 'ide');
|
||||
|
||||
const files = await fileOps.getFileList(tmpDir);
|
||||
|
||||
expect(files).toHaveLength(1);
|
||||
expect(files[0]).toBe(path.join('src', 'index.js'));
|
||||
});
|
||||
});
|
||||
|
||||
describe('relative path handling', () => {
|
||||
it('should return paths relative to base directory', async () => {
|
||||
await createTestFile(tmpDir, 'a/b/c/deep.txt', 'deep');
|
||||
|
||||
const files = await fileOps.getFileList(tmpDir);
|
||||
|
||||
expect(files[0]).toBe(path.join('a', 'b', 'c', 'deep.txt'));
|
||||
expect(path.isAbsolute(files[0])).toBe(false);
|
||||
});
|
||||
|
||||
it('should handle subdirectory as base', async () => {
|
||||
await createTestFile(tmpDir, 'root.txt', 'root');
|
||||
await createTestFile(tmpDir, 'sub/file1.txt', 'sub1');
|
||||
await createTestFile(tmpDir, 'sub/file2.txt', 'sub2');
|
||||
|
||||
const subDir = path.join(tmpDir, 'sub');
|
||||
const files = await fileOps.getFileList(subDir);
|
||||
|
||||
expect(files).toHaveLength(2);
|
||||
expect(files).toContain('file1.txt');
|
||||
expect(files).toContain('file2.txt');
|
||||
// Should not include root.txt
|
||||
expect(files).not.toContain('root.txt');
|
||||
});
|
||||
});
|
||||
|
||||
describe('edge cases', () => {
|
||||
it('should handle directory with special characters', async () => {
|
||||
await createTestFile(tmpDir, 'folder with spaces/file.txt', 'content');
|
||||
await createTestFile(tmpDir, 'special-chars!@#/data.json', 'data');
|
||||
|
||||
const files = await fileOps.getFileList(tmpDir);
|
||||
|
||||
expect(files).toHaveLength(2);
|
||||
expect(files).toContain(path.join('folder with spaces', 'file.txt'));
|
||||
expect(files).toContain(path.join('special-chars!@#', 'data.json'));
|
||||
});
|
||||
|
||||
it('should handle Unicode filenames', async () => {
|
||||
await createTestFile(tmpDir, '文档/测试.txt', 'chinese');
|
||||
await createTestFile(tmpDir, 'файл/данные.json', 'russian');
|
||||
await createTestFile(tmpDir, 'ファイル/データ.yaml', 'japanese');
|
||||
|
||||
const files = await fileOps.getFileList(tmpDir);
|
||||
|
||||
expect(files).toHaveLength(3);
|
||||
expect(files.some((f) => f.includes('测试.txt'))).toBe(true);
|
||||
expect(files.some((f) => f.includes('данные.json'))).toBe(true);
|
||||
expect(files.some((f) => f.includes('データ.yaml'))).toBe(true);
|
||||
});
|
||||
|
||||
it('should return empty array for non-existent directory', async () => {
|
||||
const nonExistent = path.join(tmpDir, 'does-not-exist');
|
||||
|
||||
const files = await fileOps.getFileList(nonExistent);
|
||||
|
||||
expect(files).toEqual([]);
|
||||
});
|
||||
|
||||
it('should handle very deep directory nesting', async () => {
|
||||
// Create a deeply nested structure (10 levels)
|
||||
const deepPath = Array.from({ length: 10 }, (_, i) => `level${i}`).join('/');
|
||||
await createTestFile(tmpDir, `${deepPath}/deep.txt`, 'very deep');
|
||||
|
||||
const files = await fileOps.getFileList(tmpDir);
|
||||
|
||||
expect(files).toHaveLength(1);
|
||||
expect(files[0]).toBe(path.join(...deepPath.split('/'), 'deep.txt'));
|
||||
});
|
||||
|
||||
it('should handle directory with many files', async () => {
|
||||
// Create 100 files
|
||||
const promises = Array.from({ length: 100 }, (_, i) => createTestFile(tmpDir, `file${i}.txt`, `content ${i}`));
|
||||
await Promise.all(promises);
|
||||
|
||||
const files = await fileOps.getFileList(tmpDir);
|
||||
|
||||
expect(files).toHaveLength(100);
|
||||
expect(files.every((f) => f.startsWith('file') && f.endsWith('.txt'))).toBe(true);
|
||||
});
|
||||
|
||||
it('should handle mixed ignored and non-ignored files', async () => {
|
||||
await createTestFile(tmpDir, 'src/main.js', 'code');
|
||||
await createTestFile(tmpDir, 'src/main.js.swp', 'swap');
|
||||
await createTestFile(tmpDir, 'lib/utils.js', 'utils');
|
||||
await createTestFile(tmpDir, 'node_modules/dep/index.js', 'dep');
|
||||
await createTestFile(tmpDir, 'test/test.js', 'test');
|
||||
|
||||
const files = await fileOps.getFileList(tmpDir);
|
||||
|
||||
expect(files).toHaveLength(3);
|
||||
expect(files).toContain(path.join('src', 'main.js'));
|
||||
expect(files).toContain(path.join('lib', 'utils.js'));
|
||||
expect(files).toContain(path.join('test', 'test.js'));
|
||||
});
|
||||
});
|
||||
|
||||
describe('file types', () => {
|
||||
it('should include files with no extension', async () => {
|
||||
await createTestFile(tmpDir, 'README', 'readme content');
|
||||
await createTestFile(tmpDir, 'LICENSE', 'license text');
|
||||
await createTestFile(tmpDir, 'Makefile', 'make commands');
|
||||
|
||||
const files = await fileOps.getFileList(tmpDir);
|
||||
|
||||
expect(files).toHaveLength(3);
|
||||
expect(files).toContain('README');
|
||||
expect(files).toContain('LICENSE');
|
||||
expect(files).toContain('Makefile');
|
||||
});
|
||||
|
||||
it('should include dotfiles (except ignored ones)', async () => {
|
||||
await createTestFile(tmpDir, '.gitignore', 'ignore patterns');
|
||||
await createTestFile(tmpDir, '.env', 'environment');
|
||||
await createTestFile(tmpDir, '.eslintrc', 'eslint config');
|
||||
|
||||
const files = await fileOps.getFileList(tmpDir);
|
||||
|
||||
expect(files).toHaveLength(3);
|
||||
expect(files).toContain('.gitignore');
|
||||
expect(files).toContain('.env');
|
||||
expect(files).toContain('.eslintrc');
|
||||
});
|
||||
|
||||
it('should include files with multiple extensions', async () => {
|
||||
await createTestFile(tmpDir, 'archive.tar.gz', 'archive');
|
||||
await createTestFile(tmpDir, 'backup.sql.bak', 'backup');
|
||||
await createTestFile(tmpDir, 'config.yaml.sample', 'sample config');
|
||||
|
||||
const files = await fileOps.getFileList(tmpDir);
|
||||
|
||||
expect(files).toHaveLength(3);
|
||||
});
|
||||
});
|
||||
});
|
||||
});
|
||||
|
|
@ -0,0 +1,177 @@
|
|||
import { describe, it, expect } from 'vitest';
|
||||
import { FileOps } from '../../../tools/cli/lib/file-ops.js';
|
||||
|
||||
describe('FileOps', () => {
|
||||
describe('shouldIgnore()', () => {
|
||||
const fileOps = new FileOps();
|
||||
|
||||
describe('exact matches', () => {
|
||||
it('should ignore .git directory', () => {
|
||||
expect(fileOps.shouldIgnore('.git')).toBe(true);
|
||||
expect(fileOps.shouldIgnore('/path/to/.git')).toBe(true);
|
||||
// Note: basename of '/project/.git/hooks' is 'hooks', not '.git'
|
||||
expect(fileOps.shouldIgnore('/project/.git/hooks')).toBe(false);
|
||||
});
|
||||
|
||||
it('should ignore .DS_Store files', () => {
|
||||
expect(fileOps.shouldIgnore('.DS_Store')).toBe(true);
|
||||
expect(fileOps.shouldIgnore('/path/to/.DS_Store')).toBe(true);
|
||||
});
|
||||
|
||||
it('should ignore node_modules directory', () => {
|
||||
expect(fileOps.shouldIgnore('node_modules')).toBe(true);
|
||||
expect(fileOps.shouldIgnore('/path/to/node_modules')).toBe(true);
|
||||
// Note: basename of '/project/node_modules/package' is 'package', not 'node_modules'
|
||||
expect(fileOps.shouldIgnore('/project/node_modules/package')).toBe(false);
|
||||
});
|
||||
|
||||
it('should ignore .idea directory', () => {
|
||||
expect(fileOps.shouldIgnore('.idea')).toBe(true);
|
||||
expect(fileOps.shouldIgnore('/path/to/.idea')).toBe(true);
|
||||
});
|
||||
|
||||
it('should ignore .vscode directory', () => {
|
||||
expect(fileOps.shouldIgnore('.vscode')).toBe(true);
|
||||
expect(fileOps.shouldIgnore('/path/to/.vscode')).toBe(true);
|
||||
});
|
||||
|
||||
it('should ignore __pycache__ directory', () => {
|
||||
expect(fileOps.shouldIgnore('__pycache__')).toBe(true);
|
||||
expect(fileOps.shouldIgnore('/path/to/__pycache__')).toBe(true);
|
||||
});
|
||||
});
|
||||
|
||||
describe('glob pattern matches', () => {
|
||||
it('should ignore *.swp files (Vim swap files)', () => {
|
||||
expect(fileOps.shouldIgnore('file.swp')).toBe(true);
|
||||
expect(fileOps.shouldIgnore('.config.yaml.swp')).toBe(true);
|
||||
expect(fileOps.shouldIgnore('/path/to/document.txt.swp')).toBe(true);
|
||||
});
|
||||
|
||||
it('should ignore *.tmp files (temporary files)', () => {
|
||||
expect(fileOps.shouldIgnore('file.tmp')).toBe(true);
|
||||
expect(fileOps.shouldIgnore('temp_data.tmp')).toBe(true);
|
||||
expect(fileOps.shouldIgnore('/path/to/cache.tmp')).toBe(true);
|
||||
});
|
||||
|
||||
it('should ignore *.pyc files (Python compiled)', () => {
|
||||
expect(fileOps.shouldIgnore('module.pyc')).toBe(true);
|
||||
expect(fileOps.shouldIgnore('__init__.pyc')).toBe(true);
|
||||
expect(fileOps.shouldIgnore('/path/to/script.pyc')).toBe(true);
|
||||
});
|
||||
});
|
||||
|
||||
describe('files that should NOT be ignored', () => {
|
||||
it('should not ignore normal files', () => {
|
||||
expect(fileOps.shouldIgnore('README.md')).toBe(false);
|
||||
expect(fileOps.shouldIgnore('package.json')).toBe(false);
|
||||
expect(fileOps.shouldIgnore('index.js')).toBe(false);
|
||||
});
|
||||
|
||||
it('should not ignore .gitignore itself', () => {
|
||||
expect(fileOps.shouldIgnore('.gitignore')).toBe(false);
|
||||
expect(fileOps.shouldIgnore('/path/to/.gitignore')).toBe(false);
|
||||
});
|
||||
|
||||
it('should not ignore files with similar but different names', () => {
|
||||
expect(fileOps.shouldIgnore('git-file.txt')).toBe(false);
|
||||
expect(fileOps.shouldIgnore('node_modules.backup')).toBe(false);
|
||||
expect(fileOps.shouldIgnore('swap-file.txt')).toBe(false);
|
||||
});
|
||||
|
||||
it('should not ignore files with ignored patterns in parent directory', () => {
|
||||
// The pattern matches basename, not full path
|
||||
expect(fileOps.shouldIgnore('/project/src/utils.js')).toBe(false);
|
||||
expect(fileOps.shouldIgnore('/code/main.py')).toBe(false);
|
||||
});
|
||||
|
||||
it('should not ignore directories with dot prefix (except specific ones)', () => {
|
||||
expect(fileOps.shouldIgnore('.github')).toBe(false);
|
||||
expect(fileOps.shouldIgnore('.husky')).toBe(false);
|
||||
expect(fileOps.shouldIgnore('.npmrc')).toBe(false);
|
||||
});
|
||||
});
|
||||
|
||||
describe('edge cases', () => {
|
||||
it('should handle empty string', () => {
|
||||
expect(fileOps.shouldIgnore('')).toBe(false);
|
||||
});
|
||||
|
||||
it('should handle paths with multiple segments', () => {
|
||||
// basename of '/very/deep/path/to/node_modules/package' is 'package'
|
||||
expect(fileOps.shouldIgnore('/very/deep/path/to/node_modules/package')).toBe(false);
|
||||
expect(fileOps.shouldIgnore('/very/deep/path/to/file.swp')).toBe(true);
|
||||
expect(fileOps.shouldIgnore('/very/deep/path/to/normal.js')).toBe(false);
|
||||
// But the directory itself would be ignored
|
||||
expect(fileOps.shouldIgnore('/very/deep/path/to/node_modules')).toBe(true);
|
||||
});
|
||||
|
||||
it('should handle Windows-style paths', () => {
|
||||
// Note: path.basename() on Unix doesn't recognize backslashes
|
||||
// On Unix: basename('C:\\project\\file.tmp') = 'C:\\project\\file.tmp'
|
||||
// So we test cross-platform path handling
|
||||
expect(fileOps.shouldIgnore(String.raw`C:\project\file.tmp`)).toBe(true); // .tmp matches
|
||||
expect(fileOps.shouldIgnore(String.raw`test\file.swp`)).toBe(true); // .swp matches
|
||||
// These won't be ignored because they don't match the patterns on Unix
|
||||
expect(fileOps.shouldIgnore(String.raw`C:\project\node_modules\pkg`)).toBe(false);
|
||||
expect(fileOps.shouldIgnore(String.raw`C:\project\src\main.js`)).toBe(false);
|
||||
});
|
||||
|
||||
it('should handle relative paths', () => {
|
||||
// basename of './node_modules/package' is 'package'
|
||||
expect(fileOps.shouldIgnore('./node_modules/package')).toBe(false);
|
||||
// basename of '../.git/hooks' is 'hooks'
|
||||
expect(fileOps.shouldIgnore('../.git/hooks')).toBe(false);
|
||||
expect(fileOps.shouldIgnore('./src/index.js')).toBe(false);
|
||||
// But the directories themselves would be ignored
|
||||
expect(fileOps.shouldIgnore('./node_modules')).toBe(true);
|
||||
expect(fileOps.shouldIgnore('../.git')).toBe(true);
|
||||
});
|
||||
|
||||
it('should handle files with multiple extensions', () => {
|
||||
expect(fileOps.shouldIgnore('file.tar.tmp')).toBe(true);
|
||||
expect(fileOps.shouldIgnore('backup.sql.swp')).toBe(true);
|
||||
expect(fileOps.shouldIgnore('data.json.gz')).toBe(false);
|
||||
});
|
||||
|
||||
it('should be case-sensitive for exact matches', () => {
|
||||
expect(fileOps.shouldIgnore('Node_Modules')).toBe(false);
|
||||
expect(fileOps.shouldIgnore('NODE_MODULES')).toBe(false);
|
||||
expect(fileOps.shouldIgnore('node_modules')).toBe(true);
|
||||
});
|
||||
|
||||
it('should handle files starting with ignored patterns', () => {
|
||||
expect(fileOps.shouldIgnore('.git-credentials')).toBe(false);
|
||||
expect(fileOps.shouldIgnore('.gitattributes')).toBe(false);
|
||||
expect(fileOps.shouldIgnore('.git')).toBe(true);
|
||||
});
|
||||
|
||||
it('should handle Unicode filenames', () => {
|
||||
expect(fileOps.shouldIgnore('文档.swp')).toBe(true);
|
||||
expect(fileOps.shouldIgnore('файл.tmp')).toBe(true);
|
||||
expect(fileOps.shouldIgnore('ドキュメント.txt')).toBe(false);
|
||||
});
|
||||
});
|
||||
|
||||
describe('pattern matching behavior', () => {
|
||||
it('should match patterns based on basename only', () => {
|
||||
// shouldIgnore uses path.basename(), so only the last segment matters
|
||||
expect(fileOps.shouldIgnore('/home/user/.git/config')).toBe(false); // basename is 'config'
|
||||
expect(fileOps.shouldIgnore('/home/user/project/node_modules')).toBe(true); // basename is 'node_modules'
|
||||
});
|
||||
|
||||
it('should handle trailing slashes', () => {
|
||||
// path.basename() returns the directory name, not empty string for trailing slash
|
||||
expect(fileOps.shouldIgnore('node_modules/')).toBe(true);
|
||||
expect(fileOps.shouldIgnore('.git/')).toBe(true);
|
||||
});
|
||||
|
||||
it('should treat patterns as partial regex matches', () => {
|
||||
// The *.swp pattern becomes /.*\.swp/ regex
|
||||
expect(fileOps.shouldIgnore('test.swp')).toBe(true);
|
||||
expect(fileOps.shouldIgnore('swp')).toBe(false); // doesn't match .*\.swp
|
||||
expect(fileOps.shouldIgnore('.swp')).toBe(true); // matches .*\.swp (. before swp)
|
||||
});
|
||||
});
|
||||
});
|
||||
});
|
||||
|
|
@ -0,0 +1,316 @@
|
|||
import { describe, it, expect, beforeEach, afterEach } from 'vitest';
|
||||
import { FileOps } from '../../../tools/cli/lib/file-ops.js';
|
||||
import { createTempDir, cleanupTempDir, createTestFile } from '../../helpers/temp-dir.js';
|
||||
import fs from 'fs-extra';
|
||||
import path from 'node:path';
|
||||
|
||||
describe('FileOps', () => {
|
||||
describe('syncDirectory()', () => {
|
||||
const fileOps = new FileOps();
|
||||
let tmpDir;
|
||||
let sourceDir;
|
||||
let destDir;
|
||||
|
||||
beforeEach(async () => {
|
||||
tmpDir = await createTempDir();
|
||||
sourceDir = path.join(tmpDir, 'source');
|
||||
destDir = path.join(tmpDir, 'dest');
|
||||
await fs.ensureDir(sourceDir);
|
||||
await fs.ensureDir(destDir);
|
||||
});
|
||||
|
||||
afterEach(async () => {
|
||||
await cleanupTempDir(tmpDir);
|
||||
});
|
||||
|
||||
describe('hash-based selective update', () => {
|
||||
it('should update file when hashes are identical (safe update)', async () => {
|
||||
const content = 'identical content';
|
||||
await createTestFile(sourceDir, 'file.txt', content);
|
||||
await createTestFile(destDir, 'file.txt', content);
|
||||
|
||||
await fileOps.syncDirectory(sourceDir, destDir);
|
||||
|
||||
// File should be updated (copied over) since hashes match
|
||||
const destContent = await fs.readFile(path.join(destDir, 'file.txt'), 'utf8');
|
||||
expect(destContent).toBe(content);
|
||||
});
|
||||
|
||||
it('should preserve modified file when dest is newer', async () => {
|
||||
await createTestFile(sourceDir, 'file.txt', 'source content');
|
||||
await createTestFile(destDir, 'file.txt', 'modified by user');
|
||||
|
||||
// Make dest file newer
|
||||
const destFile = path.join(destDir, 'file.txt');
|
||||
const futureTime = new Date(Date.now() + 10_000);
|
||||
await fs.utimes(destFile, futureTime, futureTime);
|
||||
|
||||
await fileOps.syncDirectory(sourceDir, destDir);
|
||||
|
||||
// User modification should be preserved
|
||||
const destContent = await fs.readFile(destFile, 'utf8');
|
||||
expect(destContent).toBe('modified by user');
|
||||
});
|
||||
|
||||
it('should update file when source is newer than modified dest', async () => {
|
||||
// Create both files first
|
||||
await createTestFile(sourceDir, 'file.txt', 'new source content');
|
||||
await createTestFile(destDir, 'file.txt', 'old modified content');
|
||||
|
||||
// Make dest older and source newer with explicit times
|
||||
const destFile = path.join(destDir, 'file.txt');
|
||||
const sourceFile = path.join(sourceDir, 'file.txt');
|
||||
|
||||
const pastTime = new Date(Date.now() - 10_000);
|
||||
const futureTime = new Date(Date.now() + 10_000);
|
||||
|
||||
await fs.utimes(destFile, pastTime, pastTime);
|
||||
await fs.utimes(sourceFile, futureTime, futureTime);
|
||||
|
||||
await fileOps.syncDirectory(sourceDir, destDir);
|
||||
|
||||
// Should update to source content since source is newer
|
||||
const destContent = await fs.readFile(destFile, 'utf8');
|
||||
expect(destContent).toBe('new source content');
|
||||
});
|
||||
});
|
||||
|
||||
describe('new file handling', () => {
|
||||
it('should copy new files from source', async () => {
|
||||
await createTestFile(sourceDir, 'new-file.txt', 'new content');
|
||||
|
||||
await fileOps.syncDirectory(sourceDir, destDir);
|
||||
|
||||
expect(await fs.pathExists(path.join(destDir, 'new-file.txt'))).toBe(true);
|
||||
expect(await fs.readFile(path.join(destDir, 'new-file.txt'), 'utf8')).toBe('new content');
|
||||
});
|
||||
|
||||
it('should copy multiple new files', async () => {
|
||||
await createTestFile(sourceDir, 'file1.txt', 'content1');
|
||||
await createTestFile(sourceDir, 'file2.md', 'content2');
|
||||
await createTestFile(sourceDir, 'file3.json', 'content3');
|
||||
|
||||
await fileOps.syncDirectory(sourceDir, destDir);
|
||||
|
||||
expect(await fs.pathExists(path.join(destDir, 'file1.txt'))).toBe(true);
|
||||
expect(await fs.pathExists(path.join(destDir, 'file2.md'))).toBe(true);
|
||||
expect(await fs.pathExists(path.join(destDir, 'file3.json'))).toBe(true);
|
||||
});
|
||||
|
||||
it('should create nested directories for new files', async () => {
|
||||
await createTestFile(sourceDir, 'level1/level2/deep.txt', 'deep content');
|
||||
|
||||
await fileOps.syncDirectory(sourceDir, destDir);
|
||||
|
||||
expect(await fs.pathExists(path.join(destDir, 'level1', 'level2', 'deep.txt'))).toBe(true);
|
||||
});
|
||||
});
|
||||
|
||||
describe('orphaned file removal', () => {
|
||||
it('should remove files that no longer exist in source', async () => {
|
||||
await createTestFile(sourceDir, 'keep.txt', 'keep this');
|
||||
await createTestFile(destDir, 'keep.txt', 'keep this');
|
||||
await createTestFile(destDir, 'remove.txt', 'delete this');
|
||||
|
||||
await fileOps.syncDirectory(sourceDir, destDir);
|
||||
|
||||
expect(await fs.pathExists(path.join(destDir, 'keep.txt'))).toBe(true);
|
||||
expect(await fs.pathExists(path.join(destDir, 'remove.txt'))).toBe(false);
|
||||
});
|
||||
|
||||
it('should remove multiple orphaned files', async () => {
|
||||
await createTestFile(sourceDir, 'current.txt', 'current');
|
||||
await createTestFile(destDir, 'current.txt', 'current');
|
||||
await createTestFile(destDir, 'old1.txt', 'orphan 1');
|
||||
await createTestFile(destDir, 'old2.txt', 'orphan 2');
|
||||
await createTestFile(destDir, 'old3.txt', 'orphan 3');
|
||||
|
||||
await fileOps.syncDirectory(sourceDir, destDir);
|
||||
|
||||
expect(await fs.pathExists(path.join(destDir, 'current.txt'))).toBe(true);
|
||||
expect(await fs.pathExists(path.join(destDir, 'old1.txt'))).toBe(false);
|
||||
expect(await fs.pathExists(path.join(destDir, 'old2.txt'))).toBe(false);
|
||||
expect(await fs.pathExists(path.join(destDir, 'old3.txt'))).toBe(false);
|
||||
});
|
||||
|
||||
it('should remove orphaned directories', async () => {
|
||||
await createTestFile(sourceDir, 'keep/file.txt', 'keep');
|
||||
await createTestFile(destDir, 'keep/file.txt', 'keep');
|
||||
await createTestFile(destDir, 'remove/orphan.txt', 'orphan');
|
||||
|
||||
await fileOps.syncDirectory(sourceDir, destDir);
|
||||
|
||||
expect(await fs.pathExists(path.join(destDir, 'keep'))).toBe(true);
|
||||
expect(await fs.pathExists(path.join(destDir, 'remove', 'orphan.txt'))).toBe(false);
|
||||
});
|
||||
});
|
||||
|
||||
describe('complex scenarios', () => {
|
||||
it('should handle mixed operations in single sync', async () => {
|
||||
const now = Date.now();
|
||||
const pastTime = now - 100_000; // 100 seconds ago
|
||||
const futureTime = now + 100_000; // 100 seconds from now
|
||||
|
||||
// Identical file (update)
|
||||
await createTestFile(sourceDir, 'identical.txt', 'same');
|
||||
await createTestFile(destDir, 'identical.txt', 'same');
|
||||
|
||||
// Modified file with newer dest (preserve)
|
||||
await createTestFile(sourceDir, 'modified.txt', 'original');
|
||||
await createTestFile(destDir, 'modified.txt', 'user modified');
|
||||
const modifiedFile = path.join(destDir, 'modified.txt');
|
||||
await fs.utimes(modifiedFile, futureTime, futureTime);
|
||||
|
||||
// New file (copy)
|
||||
await createTestFile(sourceDir, 'new.txt', 'new content');
|
||||
|
||||
// Orphaned file (remove)
|
||||
await createTestFile(destDir, 'orphan.txt', 'delete me');
|
||||
|
||||
await fileOps.syncDirectory(sourceDir, destDir);
|
||||
|
||||
// Verify operations
|
||||
expect(await fs.pathExists(path.join(destDir, 'identical.txt'))).toBe(true);
|
||||
|
||||
expect(await fs.readFile(modifiedFile, 'utf8')).toBe('user modified');
|
||||
|
||||
expect(await fs.pathExists(path.join(destDir, 'new.txt'))).toBe(true);
|
||||
|
||||
expect(await fs.pathExists(path.join(destDir, 'orphan.txt'))).toBe(false);
|
||||
});
|
||||
|
||||
it('should handle nested directory changes', async () => {
|
||||
// Create nested structure in source
|
||||
await createTestFile(sourceDir, 'level1/keep.txt', 'keep');
|
||||
await createTestFile(sourceDir, 'level1/level2/deep.txt', 'deep');
|
||||
|
||||
// Create different nested structure in dest
|
||||
await createTestFile(destDir, 'level1/keep.txt', 'keep');
|
||||
await createTestFile(destDir, 'level1/remove.txt', 'orphan');
|
||||
await createTestFile(destDir, 'old-level/file.txt', 'old');
|
||||
|
||||
await fileOps.syncDirectory(sourceDir, destDir);
|
||||
|
||||
expect(await fs.pathExists(path.join(destDir, 'level1', 'keep.txt'))).toBe(true);
|
||||
expect(await fs.pathExists(path.join(destDir, 'level1', 'level2', 'deep.txt'))).toBe(true);
|
||||
expect(await fs.pathExists(path.join(destDir, 'level1', 'remove.txt'))).toBe(false);
|
||||
expect(await fs.pathExists(path.join(destDir, 'old-level', 'file.txt'))).toBe(false);
|
||||
});
|
||||
});
|
||||
|
||||
describe('edge cases', () => {
|
||||
it('should handle empty source directory', async () => {
|
||||
await createTestFile(destDir, 'file.txt', 'content');
|
||||
|
||||
await fileOps.syncDirectory(sourceDir, destDir);
|
||||
|
||||
// All files should be removed
|
||||
expect(await fs.pathExists(path.join(destDir, 'file.txt'))).toBe(false);
|
||||
});
|
||||
|
||||
it('should handle empty destination directory', async () => {
|
||||
await createTestFile(sourceDir, 'file.txt', 'content');
|
||||
|
||||
await fileOps.syncDirectory(sourceDir, destDir);
|
||||
|
||||
expect(await fs.pathExists(path.join(destDir, 'file.txt'))).toBe(true);
|
||||
});
|
||||
|
||||
it('should handle Unicode filenames', async () => {
|
||||
await createTestFile(sourceDir, '测试.txt', 'chinese');
|
||||
await createTestFile(destDir, '测试.txt', 'modified chinese');
|
||||
|
||||
// Make dest newer
|
||||
await fs.utimes(path.join(destDir, '测试.txt'), Date.now() + 10_000, Date.now() + 10_000);
|
||||
|
||||
await fileOps.syncDirectory(sourceDir, destDir);
|
||||
|
||||
// Should preserve user modification
|
||||
expect(await fs.readFile(path.join(destDir, '测试.txt'), 'utf8')).toBe('modified chinese');
|
||||
});
|
||||
|
||||
it('should handle large number of files', async () => {
|
||||
// Create 50 files in source
|
||||
for (let i = 0; i < 50; i++) {
|
||||
await createTestFile(sourceDir, `file${i}.txt`, `content ${i}`);
|
||||
}
|
||||
|
||||
// Create 25 matching files and 25 orphaned files in dest
|
||||
for (let i = 0; i < 25; i++) {
|
||||
await createTestFile(destDir, `file${i}.txt`, `content ${i}`);
|
||||
await createTestFile(destDir, `orphan${i}.txt`, `orphan ${i}`);
|
||||
}
|
||||
|
||||
await fileOps.syncDirectory(sourceDir, destDir);
|
||||
|
||||
// All 50 source files should exist
|
||||
for (let i = 0; i < 50; i++) {
|
||||
expect(await fs.pathExists(path.join(destDir, `file${i}.txt`))).toBe(true);
|
||||
}
|
||||
|
||||
// All 25 orphaned files should be removed
|
||||
for (let i = 0; i < 25; i++) {
|
||||
expect(await fs.pathExists(path.join(destDir, `orphan${i}.txt`))).toBe(false);
|
||||
}
|
||||
});
|
||||
|
||||
it('should handle binary files correctly', async () => {
|
||||
const buffer = Buffer.from([0x89, 0x50, 0x4e, 0x47]);
|
||||
await fs.writeFile(path.join(sourceDir, 'binary.dat'), buffer);
|
||||
await fs.writeFile(path.join(destDir, 'binary.dat'), buffer);
|
||||
|
||||
await fileOps.syncDirectory(sourceDir, destDir);
|
||||
|
||||
const destBuffer = await fs.readFile(path.join(destDir, 'binary.dat'));
|
||||
expect(destBuffer).toEqual(buffer);
|
||||
});
|
||||
});
|
||||
|
||||
describe('timestamp precision', () => {
|
||||
it('should handle files with very close modification times', async () => {
|
||||
await createTestFile(sourceDir, 'file.txt', 'source');
|
||||
await createTestFile(destDir, 'file.txt', 'dest modified');
|
||||
|
||||
// Make dest just slightly newer (100ms)
|
||||
const destFile = path.join(destDir, 'file.txt');
|
||||
await fs.utimes(destFile, Date.now() + 100, Date.now() + 100);
|
||||
|
||||
await fileOps.syncDirectory(sourceDir, destDir);
|
||||
|
||||
// Should preserve user modification even with small time difference
|
||||
expect(await fs.readFile(destFile, 'utf8')).toBe('dest modified');
|
||||
});
|
||||
});
|
||||
|
||||
describe('data integrity', () => {
|
||||
it('should not corrupt files during sync', async () => {
|
||||
const content = 'Important data\nLine 2\nLine 3\n';
|
||||
await createTestFile(sourceDir, 'data.txt', content);
|
||||
|
||||
await fileOps.syncDirectory(sourceDir, destDir);
|
||||
|
||||
expect(await fs.readFile(path.join(destDir, 'data.txt'), 'utf8')).toBe(content);
|
||||
});
|
||||
|
||||
it('should handle sync interruption gracefully', async () => {
|
||||
// This test verifies that partial syncs don't leave inconsistent state
|
||||
await createTestFile(sourceDir, 'file1.txt', 'content1');
|
||||
await createTestFile(sourceDir, 'file2.txt', 'content2');
|
||||
|
||||
// First sync
|
||||
await fileOps.syncDirectory(sourceDir, destDir);
|
||||
|
||||
// Modify source
|
||||
await createTestFile(sourceDir, 'file3.txt', 'content3');
|
||||
|
||||
// Second sync
|
||||
await fileOps.syncDirectory(sourceDir, destDir);
|
||||
|
||||
// All files should be present and correct
|
||||
expect(await fs.pathExists(path.join(destDir, 'file1.txt'))).toBe(true);
|
||||
expect(await fs.pathExists(path.join(destDir, 'file2.txt'))).toBe(true);
|
||||
expect(await fs.pathExists(path.join(destDir, 'file3.txt'))).toBe(true);
|
||||
});
|
||||
});
|
||||
});
|
||||
});
|
||||
|
|
@ -0,0 +1,214 @@
|
|||
import { describe, it, expect, beforeEach, afterEach } from 'vitest';
|
||||
import { FileOps } from '../../../tools/cli/lib/file-ops.js';
|
||||
import { createTempDir, cleanupTempDir, createTestFile } from '../../helpers/temp-dir.js';
|
||||
import fs from 'fs-extra';
|
||||
import path from 'node:path';
|
||||
|
||||
describe('FileOps', () => {
|
||||
const fileOps = new FileOps();
|
||||
let tmpDir;
|
||||
|
||||
beforeEach(async () => {
|
||||
tmpDir = await createTempDir();
|
||||
});
|
||||
|
||||
afterEach(async () => {
|
||||
await cleanupTempDir(tmpDir);
|
||||
});
|
||||
|
||||
describe('ensureDir()', () => {
|
||||
it('should create directory if it does not exist', async () => {
|
||||
const newDir = path.join(tmpDir, 'new-directory');
|
||||
|
||||
await fileOps.ensureDir(newDir);
|
||||
|
||||
expect(await fs.pathExists(newDir)).toBe(true);
|
||||
});
|
||||
|
||||
it('should not fail if directory already exists', async () => {
|
||||
const existingDir = path.join(tmpDir, 'existing');
|
||||
await fs.ensureDir(existingDir);
|
||||
|
||||
await expect(fileOps.ensureDir(existingDir)).resolves.not.toThrow();
|
||||
});
|
||||
|
||||
it('should create nested directories', async () => {
|
||||
const nestedDir = path.join(tmpDir, 'level1', 'level2', 'level3');
|
||||
|
||||
await fileOps.ensureDir(nestedDir);
|
||||
|
||||
expect(await fs.pathExists(nestedDir)).toBe(true);
|
||||
});
|
||||
});
|
||||
|
||||
describe('remove()', () => {
|
||||
it('should remove a file', async () => {
|
||||
const filePath = await createTestFile(tmpDir, 'test.txt', 'content');
|
||||
|
||||
await fileOps.remove(filePath);
|
||||
|
||||
expect(await fs.pathExists(filePath)).toBe(false);
|
||||
});
|
||||
|
||||
it('should remove a directory', async () => {
|
||||
const dirPath = path.join(tmpDir, 'test-dir');
|
||||
await fs.ensureDir(dirPath);
|
||||
await createTestFile(dirPath, 'file.txt', 'content');
|
||||
|
||||
await fileOps.remove(dirPath);
|
||||
|
||||
expect(await fs.pathExists(dirPath)).toBe(false);
|
||||
});
|
||||
|
||||
it('should not fail if path does not exist', async () => {
|
||||
const nonExistent = path.join(tmpDir, 'does-not-exist');
|
||||
|
||||
await expect(fileOps.remove(nonExistent)).resolves.not.toThrow();
|
||||
});
|
||||
|
||||
it('should remove nested directories', async () => {
|
||||
const nested = path.join(tmpDir, 'a', 'b', 'c');
|
||||
await fs.ensureDir(nested);
|
||||
await createTestFile(nested, 'file.txt', 'content');
|
||||
|
||||
await fileOps.remove(path.join(tmpDir, 'a'));
|
||||
|
||||
expect(await fs.pathExists(path.join(tmpDir, 'a'))).toBe(false);
|
||||
});
|
||||
});
|
||||
|
||||
describe('readFile()', () => {
|
||||
it('should read file content', async () => {
|
||||
const content = 'test content';
|
||||
const filePath = await createTestFile(tmpDir, 'test.txt', content);
|
||||
|
||||
const result = await fileOps.readFile(filePath);
|
||||
|
||||
expect(result).toBe(content);
|
||||
});
|
||||
|
||||
it('should read UTF-8 content', async () => {
|
||||
const content = 'Hello 世界 🌍';
|
||||
const filePath = await createTestFile(tmpDir, 'utf8.txt', content);
|
||||
|
||||
const result = await fileOps.readFile(filePath);
|
||||
|
||||
expect(result).toBe(content);
|
||||
});
|
||||
|
||||
it('should read empty file', async () => {
|
||||
const filePath = await createTestFile(tmpDir, 'empty.txt', '');
|
||||
|
||||
const result = await fileOps.readFile(filePath);
|
||||
|
||||
expect(result).toBe('');
|
||||
});
|
||||
|
||||
it('should reject for non-existent file', async () => {
|
||||
const nonExistent = path.join(tmpDir, 'does-not-exist.txt');
|
||||
|
||||
await expect(fileOps.readFile(nonExistent)).rejects.toThrow();
|
||||
});
|
||||
});
|
||||
|
||||
describe('writeFile()', () => {
|
||||
it('should write file content', async () => {
|
||||
const filePath = path.join(tmpDir, 'new-file.txt');
|
||||
const content = 'test content';
|
||||
|
||||
await fileOps.writeFile(filePath, content);
|
||||
|
||||
expect(await fs.readFile(filePath, 'utf8')).toBe(content);
|
||||
});
|
||||
|
||||
it('should create parent directories if they do not exist', async () => {
|
||||
const filePath = path.join(tmpDir, 'level1', 'level2', 'file.txt');
|
||||
|
||||
await fileOps.writeFile(filePath, 'content');
|
||||
|
||||
expect(await fs.pathExists(filePath)).toBe(true);
|
||||
expect(await fs.readFile(filePath, 'utf8')).toBe('content');
|
||||
});
|
||||
|
||||
it('should overwrite existing file', async () => {
|
||||
const filePath = await createTestFile(tmpDir, 'test.txt', 'old content');
|
||||
|
||||
await fileOps.writeFile(filePath, 'new content');
|
||||
|
||||
expect(await fs.readFile(filePath, 'utf8')).toBe('new content');
|
||||
});
|
||||
|
||||
it('should handle UTF-8 content', async () => {
|
||||
const content = '测试 Тест 🎉';
|
||||
const filePath = path.join(tmpDir, 'unicode.txt');
|
||||
|
||||
await fileOps.writeFile(filePath, content);
|
||||
|
||||
expect(await fs.readFile(filePath, 'utf8')).toBe(content);
|
||||
});
|
||||
});
|
||||
|
||||
describe('exists()', () => {
|
||||
it('should return true for existing file', async () => {
|
||||
const filePath = await createTestFile(tmpDir, 'test.txt', 'content');
|
||||
|
||||
const result = await fileOps.exists(filePath);
|
||||
|
||||
expect(result).toBe(true);
|
||||
});
|
||||
|
||||
it('should return true for existing directory', async () => {
|
||||
const dirPath = path.join(tmpDir, 'test-dir');
|
||||
await fs.ensureDir(dirPath);
|
||||
|
||||
const result = await fileOps.exists(dirPath);
|
||||
|
||||
expect(result).toBe(true);
|
||||
});
|
||||
|
||||
it('should return false for non-existent path', async () => {
|
||||
const nonExistent = path.join(tmpDir, 'does-not-exist');
|
||||
|
||||
const result = await fileOps.exists(nonExistent);
|
||||
|
||||
expect(result).toBe(false);
|
||||
});
|
||||
});
|
||||
|
||||
describe('stat()', () => {
|
||||
it('should return stats for file', async () => {
|
||||
const filePath = await createTestFile(tmpDir, 'test.txt', 'content');
|
||||
|
||||
const stats = await fileOps.stat(filePath);
|
||||
|
||||
expect(stats.isFile()).toBe(true);
|
||||
expect(stats.isDirectory()).toBe(false);
|
||||
expect(stats.size).toBeGreaterThan(0);
|
||||
});
|
||||
|
||||
it('should return stats for directory', async () => {
|
||||
const dirPath = path.join(tmpDir, 'test-dir');
|
||||
await fs.ensureDir(dirPath);
|
||||
|
||||
const stats = await fileOps.stat(dirPath);
|
||||
|
||||
expect(stats.isDirectory()).toBe(true);
|
||||
expect(stats.isFile()).toBe(false);
|
||||
});
|
||||
|
||||
it('should reject for non-existent path', async () => {
|
||||
const nonExistent = path.join(tmpDir, 'does-not-exist');
|
||||
|
||||
await expect(fileOps.stat(nonExistent)).rejects.toThrow();
|
||||
});
|
||||
|
||||
it('should return modification time', async () => {
|
||||
const filePath = await createTestFile(tmpDir, 'test.txt', 'content');
|
||||
|
||||
const stats = await fileOps.stat(filePath);
|
||||
|
||||
expect(stats.mtime).toBeInstanceOf(Date);
|
||||
expect(stats.mtime.getTime()).toBeLessThanOrEqual(Date.now());
|
||||
});
|
||||
});
|
||||
});
|
||||
|
|
@ -0,0 +1,335 @@
|
|||
import { describe, it, expect, beforeEach } from 'vitest';
|
||||
import { YamlXmlBuilder } from '../../../tools/cli/lib/yaml-xml-builder.js';
|
||||
|
||||
describe('YamlXmlBuilder - buildCommandsXml()', () => {
|
||||
let builder;
|
||||
|
||||
beforeEach(() => {
|
||||
builder = new YamlXmlBuilder();
|
||||
});
|
||||
|
||||
describe('menu injection', () => {
|
||||
it('should always inject *menu item first', () => {
|
||||
const xml = builder.buildCommandsXml([]);
|
||||
|
||||
expect(xml).toContain('<item cmd="*menu">[M] Redisplay Menu Options</item>');
|
||||
});
|
||||
|
||||
it('should always inject *dismiss item last', () => {
|
||||
const xml = builder.buildCommandsXml([]);
|
||||
|
||||
expect(xml).toContain('<item cmd="*dismiss">[D] Dismiss Agent</item>');
|
||||
// Should be at the end before </menu>
|
||||
expect(xml).toMatch(/\*dismiss.*<\/menu>/s);
|
||||
});
|
||||
|
||||
it('should place user items between *menu and *dismiss', () => {
|
||||
const menuItems = [{ trigger: 'help', description: 'Show help', action: 'show_help' }];
|
||||
|
||||
const xml = builder.buildCommandsXml(menuItems);
|
||||
|
||||
const menuIndex = xml.indexOf('*menu');
|
||||
const helpIndex = xml.indexOf('*help');
|
||||
const dismissIndex = xml.indexOf('*dismiss');
|
||||
|
||||
expect(menuIndex).toBeLessThan(helpIndex);
|
||||
expect(helpIndex).toBeLessThan(dismissIndex);
|
||||
});
|
||||
});
|
||||
|
||||
describe('legacy format items', () => {
|
||||
it('should add * prefix to triggers', () => {
|
||||
const menuItems = [{ trigger: 'help', description: 'Help', action: 'show_help' }];
|
||||
|
||||
const xml = builder.buildCommandsXml(menuItems);
|
||||
|
||||
expect(xml).toContain('cmd="*help"');
|
||||
expect(xml).not.toContain('cmd="help"'); // Should not have unprefixed version
|
||||
});
|
||||
|
||||
it('should preserve * prefix if already present', () => {
|
||||
const menuItems = [{ trigger: '*custom', description: 'Custom', action: 'custom_action' }];
|
||||
|
||||
const xml = builder.buildCommandsXml(menuItems);
|
||||
|
||||
expect(xml).toContain('cmd="*custom"');
|
||||
expect(xml).not.toContain('cmd="**custom"'); // Should not double-prefix
|
||||
});
|
||||
|
||||
it('should include description as item content', () => {
|
||||
const menuItems = [{ trigger: 'analyze', description: '[A] Analyze code', action: 'analyze' }];
|
||||
|
||||
const xml = builder.buildCommandsXml(menuItems);
|
||||
|
||||
expect(xml).toContain('>[A] Analyze code</item>');
|
||||
});
|
||||
|
||||
it('should escape XML special characters in description', () => {
|
||||
const menuItems = [
|
||||
{
|
||||
trigger: 'test',
|
||||
description: 'Test <brackets> & "quotes"',
|
||||
action: 'test',
|
||||
},
|
||||
];
|
||||
|
||||
const xml = builder.buildCommandsXml(menuItems);
|
||||
|
||||
expect(xml).toContain('<brackets> & "quotes"');
|
||||
});
|
||||
});
|
||||
|
||||
describe('handler attributes', () => {
|
||||
it('should include workflow attribute', () => {
|
||||
const menuItems = [{ trigger: 'start', description: 'Start workflow', workflow: 'main-workflow' }];
|
||||
|
||||
const xml = builder.buildCommandsXml(menuItems);
|
||||
|
||||
expect(xml).toContain('workflow="main-workflow"');
|
||||
});
|
||||
|
||||
it('should include exec attribute', () => {
|
||||
const menuItems = [{ trigger: 'run', description: 'Run task', exec: 'path/to/task.md' }];
|
||||
|
||||
const xml = builder.buildCommandsXml(menuItems);
|
||||
|
||||
expect(xml).toContain('exec="path/to/task.md"');
|
||||
});
|
||||
|
||||
it('should include action attribute', () => {
|
||||
const menuItems = [{ trigger: 'help', description: 'Help', action: 'show_help' }];
|
||||
|
||||
const xml = builder.buildCommandsXml(menuItems);
|
||||
|
||||
expect(xml).toContain('action="show_help"');
|
||||
});
|
||||
|
||||
it('should include tmpl attribute', () => {
|
||||
const menuItems = [{ trigger: 'form', description: 'Form', tmpl: 'templates/form.yaml' }];
|
||||
|
||||
const xml = builder.buildCommandsXml(menuItems);
|
||||
|
||||
expect(xml).toContain('tmpl="templates/form.yaml"');
|
||||
});
|
||||
|
||||
it('should include data attribute', () => {
|
||||
const menuItems = [{ trigger: 'load', description: 'Load', data: 'data/config.json' }];
|
||||
|
||||
const xml = builder.buildCommandsXml(menuItems);
|
||||
|
||||
expect(xml).toContain('data="data/config.json"');
|
||||
});
|
||||
|
||||
it('should include validate-workflow attribute', () => {
|
||||
const menuItems = [
|
||||
{
|
||||
trigger: 'validate',
|
||||
description: 'Validate',
|
||||
'validate-workflow': 'validation-flow',
|
||||
},
|
||||
];
|
||||
|
||||
const xml = builder.buildCommandsXml(menuItems);
|
||||
|
||||
expect(xml).toContain('validate-workflow="validation-flow"');
|
||||
});
|
||||
|
||||
it('should prioritize workflow-install over workflow', () => {
|
||||
const menuItems = [
|
||||
{
|
||||
trigger: 'start',
|
||||
description: 'Start',
|
||||
workflow: 'original',
|
||||
'workflow-install': 'installed-location',
|
||||
},
|
||||
];
|
||||
|
||||
const xml = builder.buildCommandsXml(menuItems);
|
||||
|
||||
expect(xml).toContain('workflow="installed-location"');
|
||||
expect(xml).not.toContain('workflow="original"');
|
||||
});
|
||||
|
||||
it('should handle multiple attributes on same item', () => {
|
||||
const menuItems = [
|
||||
{
|
||||
trigger: 'complex',
|
||||
description: 'Complex command',
|
||||
workflow: 'flow',
|
||||
data: 'data.json',
|
||||
action: 'custom',
|
||||
},
|
||||
];
|
||||
|
||||
const xml = builder.buildCommandsXml(menuItems);
|
||||
|
||||
expect(xml).toContain('workflow="flow"');
|
||||
expect(xml).toContain('data="data.json"');
|
||||
expect(xml).toContain('action="custom"');
|
||||
});
|
||||
});
|
||||
|
||||
describe('IDE and web filtering', () => {
|
||||
it('should include ide-only items for IDE installation', () => {
|
||||
const menuItems = [
|
||||
{ trigger: 'local', description: 'Local only', action: 'local', 'ide-only': true },
|
||||
{ trigger: 'normal', description: 'Normal', action: 'normal' },
|
||||
];
|
||||
|
||||
const xml = builder.buildCommandsXml(menuItems, false);
|
||||
|
||||
expect(xml).toContain('*local');
|
||||
expect(xml).toContain('*normal');
|
||||
});
|
||||
|
||||
it('should skip ide-only items for web bundle', () => {
|
||||
const menuItems = [
|
||||
{ trigger: 'local', description: 'Local only', action: 'local', 'ide-only': true },
|
||||
{ trigger: 'normal', description: 'Normal', action: 'normal' },
|
||||
];
|
||||
|
||||
const xml = builder.buildCommandsXml(menuItems, true);
|
||||
|
||||
expect(xml).not.toContain('*local');
|
||||
expect(xml).toContain('*normal');
|
||||
});
|
||||
|
||||
it('should include web-only items for web bundle', () => {
|
||||
const menuItems = [
|
||||
{ trigger: 'web', description: 'Web only', action: 'web', 'web-only': true },
|
||||
{ trigger: 'normal', description: 'Normal', action: 'normal' },
|
||||
];
|
||||
|
||||
const xml = builder.buildCommandsXml(menuItems, true);
|
||||
|
||||
expect(xml).toContain('*web');
|
||||
expect(xml).toContain('*normal');
|
||||
});
|
||||
|
||||
it('should skip web-only items for IDE installation', () => {
|
||||
const menuItems = [
|
||||
{ trigger: 'web', description: 'Web only', action: 'web', 'web-only': true },
|
||||
{ trigger: 'normal', description: 'Normal', action: 'normal' },
|
||||
];
|
||||
|
||||
const xml = builder.buildCommandsXml(menuItems, false);
|
||||
|
||||
expect(xml).not.toContain('*web');
|
||||
expect(xml).toContain('*normal');
|
||||
});
|
||||
});
|
||||
|
||||
describe('multi format with nested handlers', () => {
|
||||
it('should build multi format items with nested handlers', () => {
|
||||
const menuItems = [
|
||||
{
|
||||
multi: '[TS] Technical Specification',
|
||||
triggers: [
|
||||
{
|
||||
'tech-spec': [{ input: 'Create technical specification' }, { route: 'workflows/tech-spec.yaml' }],
|
||||
},
|
||||
{
|
||||
TS: [{ input: 'Create technical specification' }, { route: 'workflows/tech-spec.yaml' }],
|
||||
},
|
||||
],
|
||||
},
|
||||
];
|
||||
|
||||
const xml = builder.buildCommandsXml(menuItems);
|
||||
|
||||
expect(xml).toContain('<item type="multi">');
|
||||
expect(xml).toContain('[TS] Technical Specification');
|
||||
expect(xml).toContain('<handler');
|
||||
expect(xml).toContain('match="Create technical specification"');
|
||||
expect(xml).toContain('</item>');
|
||||
});
|
||||
|
||||
it('should escape XML in multi description', () => {
|
||||
const menuItems = [
|
||||
{
|
||||
multi: '[A] Analyze <code>',
|
||||
triggers: [
|
||||
{
|
||||
analyze: [{ input: 'Analyze', route: 'task.md' }],
|
||||
},
|
||||
],
|
||||
},
|
||||
];
|
||||
|
||||
const xml = builder.buildCommandsXml(menuItems);
|
||||
|
||||
expect(xml).toContain('<code>');
|
||||
});
|
||||
});
|
||||
|
||||
describe('edge cases', () => {
|
||||
it('should handle empty menu items array', () => {
|
||||
const xml = builder.buildCommandsXml([]);
|
||||
|
||||
expect(xml).toContain('<menu>');
|
||||
expect(xml).toContain('</menu>');
|
||||
expect(xml).toContain('*menu');
|
||||
expect(xml).toContain('*dismiss');
|
||||
});
|
||||
|
||||
it('should handle null menu items', () => {
|
||||
const xml = builder.buildCommandsXml(null);
|
||||
|
||||
expect(xml).toContain('<menu>');
|
||||
expect(xml).toContain('*menu');
|
||||
expect(xml).toContain('*dismiss');
|
||||
});
|
||||
|
||||
it('should handle undefined menu items', () => {
|
||||
const xml = builder.buildCommandsXml();
|
||||
|
||||
expect(xml).toContain('<menu>');
|
||||
});
|
||||
|
||||
it('should handle empty description', () => {
|
||||
const menuItems = [{ trigger: 'test', description: '', action: 'test' }];
|
||||
|
||||
const xml = builder.buildCommandsXml(menuItems);
|
||||
|
||||
expect(xml).toContain('cmd="*test"');
|
||||
expect(xml).toContain('></item>'); // Empty content between tags
|
||||
});
|
||||
|
||||
it('should handle missing trigger (edge case)', () => {
|
||||
const menuItems = [{ description: 'No trigger', action: 'test' }];
|
||||
|
||||
const xml = builder.buildCommandsXml(menuItems);
|
||||
|
||||
// Should handle gracefully - might skip or add * prefix to empty
|
||||
expect(xml).toContain('<menu>');
|
||||
});
|
||||
|
||||
it('should handle Unicode in descriptions', () => {
|
||||
const menuItems = [{ trigger: 'test', description: '[测试] Test 日本語', action: 'test' }];
|
||||
|
||||
const xml = builder.buildCommandsXml(menuItems);
|
||||
|
||||
expect(xml).toContain('测试');
|
||||
expect(xml).toContain('日本語');
|
||||
});
|
||||
});
|
||||
|
||||
describe('multiple menu items', () => {
|
||||
it('should process all menu items in order', () => {
|
||||
const menuItems = [
|
||||
{ trigger: 'first', description: 'First', action: 'first' },
|
||||
{ trigger: 'second', description: 'Second', action: 'second' },
|
||||
{ trigger: 'third', description: 'Third', action: 'third' },
|
||||
];
|
||||
|
||||
const xml = builder.buildCommandsXml(menuItems);
|
||||
|
||||
const firstIndex = xml.indexOf('*first');
|
||||
const secondIndex = xml.indexOf('*second');
|
||||
const thirdIndex = xml.indexOf('*third');
|
||||
|
||||
expect(firstIndex).toBeLessThan(secondIndex);
|
||||
expect(secondIndex).toBeLessThan(thirdIndex);
|
||||
});
|
||||
});
|
||||
});
|
||||
|
|
@ -0,0 +1,605 @@
|
|||
import { describe, it, expect, beforeEach } from 'vitest';
|
||||
import { YamlXmlBuilder } from '../../../tools/cli/lib/yaml-xml-builder.js';
|
||||
|
||||
describe('YamlXmlBuilder - convertToXml()', () => {
|
||||
let builder;
|
||||
|
||||
beforeEach(() => {
|
||||
builder = new YamlXmlBuilder();
|
||||
});
|
||||
|
||||
describe('basic XML generation', () => {
|
||||
it('should generate XML with agent tag and attributes', async () => {
|
||||
const agentYaml = {
|
||||
agent: {
|
||||
metadata: {
|
||||
id: 'test-agent',
|
||||
name: 'Test Agent',
|
||||
title: 'Test Agent Title',
|
||||
icon: '🔧',
|
||||
},
|
||||
persona: {
|
||||
role: 'Test Role',
|
||||
identity: 'Test Identity',
|
||||
communication_style: 'Professional',
|
||||
principles: ['Principle 1'],
|
||||
},
|
||||
menu: [{ trigger: 'help', description: 'Help', action: 'show_help' }],
|
||||
},
|
||||
};
|
||||
|
||||
const xml = await builder.convertToXml(agentYaml, { skipActivation: true });
|
||||
|
||||
expect(xml).toContain('<agent id="test-agent"');
|
||||
expect(xml).toContain('name="Test Agent"');
|
||||
expect(xml).toContain('title="Test Agent Title"');
|
||||
expect(xml).toContain('icon="🔧"');
|
||||
expect(xml).toContain('</agent>');
|
||||
});
|
||||
|
||||
it('should include persona section', async () => {
|
||||
const agentYaml = {
|
||||
agent: {
|
||||
metadata: { id: 'test', name: 'Test', title: 'Test', icon: '🔧' },
|
||||
persona: {
|
||||
role: 'Developer',
|
||||
identity: 'Helpful assistant',
|
||||
communication_style: 'Professional',
|
||||
principles: ['Clear', 'Concise'],
|
||||
},
|
||||
menu: [],
|
||||
},
|
||||
};
|
||||
|
||||
const xml = await builder.convertToXml(agentYaml, { skipActivation: true });
|
||||
|
||||
expect(xml).toContain('<persona>');
|
||||
expect(xml).toContain('<role>Developer</role>');
|
||||
expect(xml).toContain('<identity>Helpful assistant</identity>');
|
||||
expect(xml).toContain('<communication_style>Professional</communication_style>');
|
||||
expect(xml).toContain('<principles>Clear Concise</principles>');
|
||||
});
|
||||
|
||||
it('should include memories section if present', async () => {
|
||||
const agentYaml = {
|
||||
agent: {
|
||||
metadata: { id: 'test', name: 'Test', title: 'Test', icon: '🔧' },
|
||||
persona: {
|
||||
role: 'Role',
|
||||
identity: 'ID',
|
||||
communication_style: 'Style',
|
||||
principles: ['P'],
|
||||
},
|
||||
memories: ['Memory 1', 'Memory 2'],
|
||||
menu: [],
|
||||
},
|
||||
};
|
||||
|
||||
const xml = await builder.convertToXml(agentYaml, { skipActivation: true });
|
||||
|
||||
expect(xml).toContain('<memories>');
|
||||
expect(xml).toContain('<memory>Memory 1</memory>');
|
||||
expect(xml).toContain('<memory>Memory 2</memory>');
|
||||
});
|
||||
|
||||
it('should include prompts section if present', async () => {
|
||||
const agentYaml = {
|
||||
agent: {
|
||||
metadata: { id: 'test', name: 'Test', title: 'Test', icon: '🔧' },
|
||||
persona: {
|
||||
role: 'Role',
|
||||
identity: 'ID',
|
||||
communication_style: 'Style',
|
||||
principles: ['P'],
|
||||
},
|
||||
prompts: [{ id: 'p1', content: 'Prompt content' }],
|
||||
menu: [],
|
||||
},
|
||||
};
|
||||
|
||||
const xml = await builder.convertToXml(agentYaml, { skipActivation: true });
|
||||
|
||||
expect(xml).toContain('<prompts>');
|
||||
expect(xml).toContain('<prompt id="p1">');
|
||||
expect(xml).toContain('Prompt content');
|
||||
});
|
||||
|
||||
it('should include menu section', async () => {
|
||||
const agentYaml = {
|
||||
agent: {
|
||||
metadata: { id: 'test', name: 'Test', title: 'Test', icon: '🔧' },
|
||||
persona: {
|
||||
role: 'Role',
|
||||
identity: 'ID',
|
||||
communication_style: 'Style',
|
||||
principles: ['P'],
|
||||
},
|
||||
menu: [
|
||||
{ trigger: 'help', description: 'Show help', action: 'show_help' },
|
||||
{ trigger: 'start', description: 'Start workflow', workflow: 'main' },
|
||||
],
|
||||
},
|
||||
};
|
||||
|
||||
const xml = await builder.convertToXml(agentYaml, { skipActivation: true });
|
||||
|
||||
expect(xml).toContain('<menu>');
|
||||
expect(xml).toContain('</menu>');
|
||||
// Menu always includes injected *menu item
|
||||
expect(xml).toContain('*menu');
|
||||
});
|
||||
});
|
||||
|
||||
describe('XML escaping', () => {
|
||||
it('should escape special characters in all fields', async () => {
|
||||
const agentYaml = {
|
||||
agent: {
|
||||
metadata: {
|
||||
id: 'test',
|
||||
name: 'Test',
|
||||
title: 'Test Agent',
|
||||
icon: '🔧',
|
||||
},
|
||||
persona: {
|
||||
role: 'Role with <brackets>',
|
||||
identity: 'Identity with & ampersand',
|
||||
communication_style: 'Style with "quotes"',
|
||||
principles: ["Principle with ' apostrophe"],
|
||||
},
|
||||
menu: [],
|
||||
},
|
||||
};
|
||||
|
||||
const xml = await builder.convertToXml(agentYaml, { skipActivation: true });
|
||||
|
||||
// Metadata in attributes might not be escaped - focus on content
|
||||
expect(xml).toContain('<brackets>');
|
||||
expect(xml).toContain('& ampersand');
|
||||
expect(xml).toContain('"quotes"');
|
||||
expect(xml).toContain('' apostrophe');
|
||||
});
|
||||
|
||||
it('should preserve Unicode characters', async () => {
|
||||
const agentYaml = {
|
||||
agent: {
|
||||
metadata: {
|
||||
id: 'unicode',
|
||||
name: '测试代理',
|
||||
title: 'Тестовый агент',
|
||||
icon: '🔧',
|
||||
},
|
||||
persona: {
|
||||
role: '開発者',
|
||||
identity: 'مساعد مفيد',
|
||||
communication_style: 'Profesional',
|
||||
principles: ['原则'],
|
||||
},
|
||||
menu: [],
|
||||
},
|
||||
};
|
||||
|
||||
const xml = await builder.convertToXml(agentYaml, { skipActivation: true });
|
||||
|
||||
expect(xml).toContain('测试代理');
|
||||
expect(xml).toContain('Тестовый агент');
|
||||
expect(xml).toContain('開発者');
|
||||
expect(xml).toContain('مساعد مفيد');
|
||||
expect(xml).toContain('原则');
|
||||
});
|
||||
});
|
||||
|
||||
describe('module detection', () => {
|
||||
it('should handle module in buildMetadata', async () => {
|
||||
const agentYaml = {
|
||||
agent: {
|
||||
metadata: { id: 'test', name: 'Test', title: 'Test', icon: '🔧' },
|
||||
persona: {
|
||||
role: 'Role',
|
||||
identity: 'ID',
|
||||
communication_style: 'Style',
|
||||
principles: ['P'],
|
||||
},
|
||||
menu: [],
|
||||
},
|
||||
};
|
||||
|
||||
const xml = await builder.convertToXml(agentYaml, {
|
||||
module: 'bmm',
|
||||
skipActivation: true,
|
||||
});
|
||||
|
||||
// Module is stored in metadata but may not be rendered as attribute
|
||||
expect(xml).toContain('<agent');
|
||||
expect(xml).toBeDefined();
|
||||
});
|
||||
|
||||
it('should not include module attribute for core agents', async () => {
|
||||
const agentYaml = {
|
||||
agent: {
|
||||
metadata: { id: 'test', name: 'Test', title: 'Test', icon: '🔧' },
|
||||
persona: {
|
||||
role: 'Role',
|
||||
identity: 'ID',
|
||||
communication_style: 'Style',
|
||||
principles: ['P'],
|
||||
},
|
||||
menu: [],
|
||||
},
|
||||
};
|
||||
|
||||
const xml = await builder.convertToXml(agentYaml, { skipActivation: true });
|
||||
|
||||
// No module attribute for core
|
||||
expect(xml).not.toContain('module=');
|
||||
});
|
||||
});
|
||||
|
||||
describe('output format variations', () => {
|
||||
it('should generate installation format with YAML frontmatter', async () => {
|
||||
const agentYaml = {
|
||||
agent: {
|
||||
metadata: { id: 'test', name: 'Test', title: 'Test Agent', icon: '🔧' },
|
||||
persona: {
|
||||
role: 'Role',
|
||||
identity: 'ID',
|
||||
communication_style: 'Style',
|
||||
principles: ['P'],
|
||||
},
|
||||
menu: [],
|
||||
},
|
||||
};
|
||||
|
||||
const xml = await builder.convertToXml(agentYaml, {
|
||||
sourceFile: 'test-agent.yaml',
|
||||
skipActivation: true,
|
||||
});
|
||||
|
||||
// Installation format has YAML frontmatter
|
||||
expect(xml).toMatch(/^---\n/);
|
||||
expect(xml).toContain('name: "test agent"'); // Derived from filename
|
||||
expect(xml).toContain('description: "Test Agent"');
|
||||
expect(xml).toContain('---');
|
||||
});
|
||||
|
||||
it('should generate web bundle format without frontmatter', async () => {
|
||||
const agentYaml = {
|
||||
agent: {
|
||||
metadata: { id: 'test', name: 'Test', title: 'Test Agent', icon: '🔧' },
|
||||
persona: {
|
||||
role: 'Role',
|
||||
identity: 'ID',
|
||||
communication_style: 'Style',
|
||||
principles: ['P'],
|
||||
},
|
||||
menu: [],
|
||||
},
|
||||
};
|
||||
|
||||
const xml = await builder.convertToXml(agentYaml, {
|
||||
forWebBundle: true,
|
||||
skipActivation: true,
|
||||
});
|
||||
|
||||
// Web bundle format has comment header
|
||||
expect(xml).toContain('<!-- Powered by BMAD-CORE™ -->');
|
||||
expect(xml).toContain('# Test Agent');
|
||||
expect(xml).not.toMatch(/^---\n/);
|
||||
});
|
||||
|
||||
it('should derive name from filename (remove .agent suffix)', async () => {
|
||||
const agentYaml = {
|
||||
agent: {
|
||||
metadata: { id: 'pm', name: 'PM', title: 'Product Manager', icon: '📋' },
|
||||
persona: {
|
||||
role: 'Role',
|
||||
identity: 'ID',
|
||||
communication_style: 'Style',
|
||||
principles: ['P'],
|
||||
},
|
||||
menu: [],
|
||||
},
|
||||
};
|
||||
|
||||
const xml = await builder.convertToXml(agentYaml, {
|
||||
sourceFile: 'pm.agent.yaml',
|
||||
skipActivation: true,
|
||||
});
|
||||
|
||||
// Should convert pm.agent.yaml → "pm"
|
||||
expect(xml).toContain('name: "pm"');
|
||||
});
|
||||
|
||||
it('should convert hyphens to spaces in filename', async () => {
|
||||
const agentYaml = {
|
||||
agent: {
|
||||
metadata: { id: 'cli', name: 'CLI', title: 'CLI Chief', icon: '⚙️' },
|
||||
persona: {
|
||||
role: 'Role',
|
||||
identity: 'ID',
|
||||
communication_style: 'Style',
|
||||
principles: ['P'],
|
||||
},
|
||||
menu: [],
|
||||
},
|
||||
};
|
||||
|
||||
const xml = await builder.convertToXml(agentYaml, {
|
||||
sourceFile: 'cli-chief.yaml',
|
||||
skipActivation: true,
|
||||
});
|
||||
|
||||
// Should convert cli-chief.yaml → "cli chief"
|
||||
expect(xml).toContain('name: "cli chief"');
|
||||
});
|
||||
});
|
||||
|
||||
describe('localskip attribute', () => {
|
||||
it('should add localskip="true" when metadata has localskip', async () => {
|
||||
const agentYaml = {
|
||||
agent: {
|
||||
metadata: {
|
||||
id: 'web-only',
|
||||
name: 'Web Only',
|
||||
title: 'Web Only Agent',
|
||||
icon: '🌐',
|
||||
localskip: true,
|
||||
},
|
||||
persona: {
|
||||
role: 'Role',
|
||||
identity: 'ID',
|
||||
communication_style: 'Style',
|
||||
principles: ['P'],
|
||||
},
|
||||
menu: [],
|
||||
},
|
||||
};
|
||||
|
||||
const xml = await builder.convertToXml(agentYaml, { skipActivation: true });
|
||||
|
||||
expect(xml).toContain('localskip="true"');
|
||||
});
|
||||
|
||||
it('should not add localskip when false or missing', async () => {
|
||||
const agentYaml = {
|
||||
agent: {
|
||||
metadata: { id: 'test', name: 'Test', title: 'Test', icon: '🔧' },
|
||||
persona: {
|
||||
role: 'Role',
|
||||
identity: 'ID',
|
||||
communication_style: 'Style',
|
||||
principles: ['P'],
|
||||
},
|
||||
menu: [],
|
||||
},
|
||||
};
|
||||
|
||||
const xml = await builder.convertToXml(agentYaml, { skipActivation: true });
|
||||
|
||||
expect(xml).not.toContain('localskip=');
|
||||
});
|
||||
});
|
||||
|
||||
describe('edge cases', () => {
|
||||
it('should handle empty menu array', async () => {
|
||||
const agentYaml = {
|
||||
agent: {
|
||||
metadata: { id: 'test', name: 'Test', title: 'Test', icon: '🔧' },
|
||||
persona: {
|
||||
role: 'Role',
|
||||
identity: 'ID',
|
||||
communication_style: 'Style',
|
||||
principles: ['P'],
|
||||
},
|
||||
menu: [],
|
||||
},
|
||||
};
|
||||
|
||||
const xml = await builder.convertToXml(agentYaml, { skipActivation: true });
|
||||
|
||||
expect(xml).toContain('<menu>');
|
||||
expect(xml).toContain('</menu>');
|
||||
// Should still have injected *menu item
|
||||
expect(xml).toContain('*menu');
|
||||
});
|
||||
|
||||
it('should handle missing memories', async () => {
|
||||
const agentYaml = {
|
||||
agent: {
|
||||
metadata: { id: 'test', name: 'Test', title: 'Test', icon: '🔧' },
|
||||
persona: {
|
||||
role: 'Role',
|
||||
identity: 'ID',
|
||||
communication_style: 'Style',
|
||||
principles: ['P'],
|
||||
},
|
||||
menu: [],
|
||||
},
|
||||
};
|
||||
|
||||
const xml = await builder.convertToXml(agentYaml, { skipActivation: true });
|
||||
|
||||
expect(xml).not.toContain('<memories>');
|
||||
});
|
||||
|
||||
it('should handle missing prompts', async () => {
|
||||
const agentYaml = {
|
||||
agent: {
|
||||
metadata: { id: 'test', name: 'Test', title: 'Test', icon: '🔧' },
|
||||
persona: {
|
||||
role: 'Role',
|
||||
identity: 'ID',
|
||||
communication_style: 'Style',
|
||||
principles: ['P'],
|
||||
},
|
||||
menu: [],
|
||||
},
|
||||
};
|
||||
|
||||
const xml = await builder.convertToXml(agentYaml, { skipActivation: true });
|
||||
|
||||
expect(xml).not.toContain('<prompts>');
|
||||
});
|
||||
|
||||
it('should wrap XML in markdown code fence', async () => {
|
||||
const agentYaml = {
|
||||
agent: {
|
||||
metadata: { id: 'test', name: 'Test', title: 'Test', icon: '🔧' },
|
||||
persona: {
|
||||
role: 'Role',
|
||||
identity: 'ID',
|
||||
communication_style: 'Style',
|
||||
principles: ['P'],
|
||||
},
|
||||
menu: [],
|
||||
},
|
||||
};
|
||||
|
||||
const xml = await builder.convertToXml(agentYaml, { skipActivation: true });
|
||||
|
||||
expect(xml).toContain('```xml');
|
||||
expect(xml).toContain('```\n');
|
||||
});
|
||||
|
||||
it('should include activation instruction for installation format', async () => {
|
||||
const agentYaml = {
|
||||
agent: {
|
||||
metadata: { id: 'test', name: 'Test', title: 'Test', icon: '🔧' },
|
||||
persona: {
|
||||
role: 'Role',
|
||||
identity: 'ID',
|
||||
communication_style: 'Style',
|
||||
principles: ['P'],
|
||||
},
|
||||
menu: [],
|
||||
},
|
||||
};
|
||||
|
||||
const xml = await builder.convertToXml(agentYaml, {
|
||||
sourceFile: 'test.yaml',
|
||||
skipActivation: true,
|
||||
});
|
||||
|
||||
expect(xml).toContain('You must fully embody this agent');
|
||||
expect(xml).toContain('NEVER break character');
|
||||
});
|
||||
|
||||
it('should not include activation instruction for web bundle', async () => {
|
||||
const agentYaml = {
|
||||
agent: {
|
||||
metadata: { id: 'test', name: 'Test', title: 'Test', icon: '🔧' },
|
||||
persona: {
|
||||
role: 'Role',
|
||||
identity: 'ID',
|
||||
communication_style: 'Style',
|
||||
principles: ['P'],
|
||||
},
|
||||
menu: [],
|
||||
},
|
||||
};
|
||||
|
||||
const xml = await builder.convertToXml(agentYaml, {
|
||||
forWebBundle: true,
|
||||
skipActivation: true,
|
||||
});
|
||||
|
||||
expect(xml).not.toContain('You must fully embody');
|
||||
expect(xml).toContain('<!-- Powered by BMAD-CORE™ -->');
|
||||
});
|
||||
});
|
||||
|
||||
describe('legacy commands field support', () => {
|
||||
it('should handle legacy "commands" field (renamed to menu)', async () => {
|
||||
const agentYaml = {
|
||||
agent: {
|
||||
metadata: { id: 'test', name: 'Test', title: 'Test', icon: '🔧' },
|
||||
persona: {
|
||||
role: 'Role',
|
||||
identity: 'ID',
|
||||
communication_style: 'Style',
|
||||
principles: ['P'],
|
||||
},
|
||||
commands: [{ trigger: 'help', description: 'Help', action: 'show_help' }],
|
||||
},
|
||||
};
|
||||
|
||||
const xml = await builder.convertToXml(agentYaml, { skipActivation: true });
|
||||
|
||||
expect(xml).toContain('<menu>');
|
||||
// Should process commands as menu items
|
||||
});
|
||||
|
||||
it('should prioritize menu over commands when both exist', async () => {
|
||||
const agentYaml = {
|
||||
agent: {
|
||||
metadata: { id: 'test', name: 'Test', title: 'Test', icon: '🔧' },
|
||||
persona: {
|
||||
role: 'Role',
|
||||
identity: 'ID',
|
||||
communication_style: 'Style',
|
||||
principles: ['P'],
|
||||
},
|
||||
menu: [{ trigger: 'new', description: 'New', action: 'new_action' }],
|
||||
commands: [{ trigger: 'old', description: 'Old', action: 'old_action' }],
|
||||
},
|
||||
};
|
||||
|
||||
const xml = await builder.convertToXml(agentYaml, { skipActivation: true });
|
||||
|
||||
// Should use menu, not commands
|
||||
expect(xml).toContain('<menu>');
|
||||
});
|
||||
});
|
||||
|
||||
describe('complete agent transformation', () => {
|
||||
it('should transform a complete agent with all fields', async () => {
|
||||
const agentYaml = {
|
||||
agent: {
|
||||
metadata: {
|
||||
id: 'full-agent',
|
||||
name: 'Full Agent',
|
||||
title: 'Complete Test Agent',
|
||||
icon: '🤖',
|
||||
},
|
||||
persona: {
|
||||
role: 'Full Stack Developer',
|
||||
identity: 'Experienced software engineer',
|
||||
communication_style: 'Clear and professional',
|
||||
principles: ['Quality', 'Performance', 'Maintainability'],
|
||||
},
|
||||
memories: ['Remember project context', 'Track user preferences'],
|
||||
prompts: [
|
||||
{ id: 'init', content: 'Initialize the agent' },
|
||||
{ id: 'task', content: 'Process the task' },
|
||||
],
|
||||
critical_actions: ['Never delete data', 'Always backup'],
|
||||
menu: [
|
||||
{ trigger: 'help', description: '[H] Show help', action: 'show_help' },
|
||||
{ trigger: 'start', description: '[S] Start workflow', workflow: 'main' },
|
||||
],
|
||||
},
|
||||
};
|
||||
|
||||
const xml = await builder.convertToXml(agentYaml, {
|
||||
sourceFile: 'full-agent.yaml',
|
||||
module: 'bmm',
|
||||
skipActivation: true,
|
||||
});
|
||||
|
||||
// Verify all sections are present
|
||||
expect(xml).toContain('```xml');
|
||||
expect(xml).toContain('<agent id="full-agent"');
|
||||
expect(xml).toContain('<persona>');
|
||||
expect(xml).toContain('<memories>');
|
||||
expect(xml).toContain('<prompts>');
|
||||
expect(xml).toContain('<menu>');
|
||||
expect(xml).toContain('</agent>');
|
||||
expect(xml).toContain('```');
|
||||
// Verify persona content
|
||||
expect(xml).toContain('Full Stack Developer');
|
||||
// Verify memories
|
||||
expect(xml).toContain('Remember project context');
|
||||
// Verify prompts
|
||||
expect(xml).toContain('Initialize the agent');
|
||||
});
|
||||
});
|
||||
});
|
||||
|
|
@ -0,0 +1,636 @@
|
|||
import { describe, it, expect, beforeEach, afterEach } from 'vitest';
|
||||
import { YamlXmlBuilder } from '../../../tools/cli/lib/yaml-xml-builder.js';
|
||||
import { createTempDir, cleanupTempDir, createTestFile } from '../../helpers/temp-dir.js';
|
||||
import fs from 'fs-extra';
|
||||
import path from 'node:path';
|
||||
import yaml from 'yaml';
|
||||
|
||||
describe('YamlXmlBuilder', () => {
|
||||
let tmpDir;
|
||||
let builder;
|
||||
|
||||
beforeEach(async () => {
|
||||
tmpDir = await createTempDir();
|
||||
builder = new YamlXmlBuilder();
|
||||
});
|
||||
|
||||
afterEach(async () => {
|
||||
await cleanupTempDir(tmpDir);
|
||||
});
|
||||
|
||||
describe('deepMerge()', () => {
|
||||
it('should merge shallow objects', () => {
|
||||
const target = { a: 1, b: 2 };
|
||||
const source = { b: 3, c: 4 };
|
||||
|
||||
const result = builder.deepMerge(target, source);
|
||||
|
||||
expect(result).toEqual({ a: 1, b: 3, c: 4 });
|
||||
});
|
||||
|
||||
it('should merge nested objects', () => {
|
||||
const target = { level1: { a: 1, b: 2 } };
|
||||
const source = { level1: { b: 3, c: 4 } };
|
||||
|
||||
const result = builder.deepMerge(target, source);
|
||||
|
||||
expect(result).toEqual({ level1: { a: 1, b: 3, c: 4 } });
|
||||
});
|
||||
|
||||
it('should merge deeply nested objects', () => {
|
||||
const target = { l1: { l2: { l3: { value: 'old' } } } };
|
||||
const source = { l1: { l2: { l3: { value: 'new', extra: 'data' } } } };
|
||||
|
||||
const result = builder.deepMerge(target, source);
|
||||
|
||||
expect(result).toEqual({ l1: { l2: { l3: { value: 'new', extra: 'data' } } } });
|
||||
});
|
||||
|
||||
it('should append arrays instead of replacing', () => {
|
||||
const target = { items: [1, 2, 3] };
|
||||
const source = { items: [4, 5, 6] };
|
||||
|
||||
const result = builder.deepMerge(target, source);
|
||||
|
||||
expect(result.items).toEqual([1, 2, 3, 4, 5, 6]);
|
||||
});
|
||||
|
||||
it('should handle arrays in nested objects', () => {
|
||||
const target = { config: { values: ['a', 'b'] } };
|
||||
const source = { config: { values: ['c', 'd'] } };
|
||||
|
||||
const result = builder.deepMerge(target, source);
|
||||
|
||||
expect(result.config.values).toEqual(['a', 'b', 'c', 'd']);
|
||||
});
|
||||
|
||||
it('should replace arrays if target is not an array', () => {
|
||||
const target = { items: 'string' };
|
||||
const source = { items: ['a', 'b'] };
|
||||
|
||||
const result = builder.deepMerge(target, source);
|
||||
|
||||
expect(result.items).toEqual(['a', 'b']);
|
||||
});
|
||||
|
||||
it('should handle null values', () => {
|
||||
const target = { a: null, b: 2 };
|
||||
const source = { a: 1, c: null };
|
||||
|
||||
const result = builder.deepMerge(target, source);
|
||||
|
||||
expect(result).toEqual({ a: 1, b: 2, c: null });
|
||||
});
|
||||
|
||||
it('should preserve target values when source has no override', () => {
|
||||
const target = { a: 1, b: 2, c: 3 };
|
||||
const source = { d: 4 };
|
||||
|
||||
const result = builder.deepMerge(target, source);
|
||||
|
||||
expect(result).toEqual({ a: 1, b: 2, c: 3, d: 4 });
|
||||
});
|
||||
|
||||
it('should not mutate original objects', () => {
|
||||
const target = { a: 1 };
|
||||
const source = { b: 2 };
|
||||
|
||||
builder.deepMerge(target, source);
|
||||
|
||||
expect(target).toEqual({ a: 1 }); // Unchanged
|
||||
expect(source).toEqual({ b: 2 }); // Unchanged
|
||||
});
|
||||
});
|
||||
|
||||
describe('isObject()', () => {
|
||||
it('should return true for plain objects', () => {
|
||||
expect(builder.isObject({})).toBe(true);
|
||||
expect(builder.isObject({ key: 'value' })).toBe(true);
|
||||
});
|
||||
|
||||
it('should return false for arrays', () => {
|
||||
expect(builder.isObject([])).toBe(false);
|
||||
expect(builder.isObject([1, 2, 3])).toBe(false);
|
||||
});
|
||||
|
||||
it('should return falsy for null', () => {
|
||||
expect(builder.isObject(null)).toBeFalsy();
|
||||
});
|
||||
|
||||
it('should return falsy for primitives', () => {
|
||||
expect(builder.isObject('string')).toBeFalsy();
|
||||
expect(builder.isObject(42)).toBeFalsy();
|
||||
expect(builder.isObject(true)).toBeFalsy();
|
||||
expect(builder.isObject()).toBeFalsy();
|
||||
});
|
||||
});
|
||||
|
||||
describe('loadAndMergeAgent()', () => {
|
||||
it('should load agent YAML without customization', async () => {
|
||||
const agentYaml = {
|
||||
agent: {
|
||||
metadata: { id: 'test', name: 'Test', title: 'Test Agent', icon: '🔧' },
|
||||
persona: {
|
||||
role: 'Test Role',
|
||||
identity: 'Test Identity',
|
||||
communication_style: 'Professional',
|
||||
principles: ['Principle 1'],
|
||||
},
|
||||
menu: [],
|
||||
},
|
||||
};
|
||||
|
||||
const agentPath = path.join(tmpDir, 'agent.yaml');
|
||||
await fs.writeFile(agentPath, yaml.stringify(agentYaml));
|
||||
|
||||
const result = await builder.loadAndMergeAgent(agentPath);
|
||||
|
||||
expect(result.agent.metadata.id).toBe('test');
|
||||
expect(result.agent.persona.role).toBe('Test Role');
|
||||
});
|
||||
|
||||
it('should preserve base persona when customize has empty strings', async () => {
|
||||
const baseYaml = {
|
||||
agent: {
|
||||
metadata: { id: 'base', name: 'Base', title: 'Base', icon: '🔧' },
|
||||
persona: {
|
||||
role: 'Base Role',
|
||||
identity: 'Base Identity',
|
||||
communication_style: 'Base Style',
|
||||
principles: ['Base Principle'],
|
||||
},
|
||||
menu: [],
|
||||
},
|
||||
};
|
||||
|
||||
const customizeYaml = {
|
||||
persona: {
|
||||
role: 'Custom Role',
|
||||
identity: '', // Empty - should NOT override
|
||||
communication_style: 'Custom Style',
|
||||
// principles omitted
|
||||
},
|
||||
};
|
||||
|
||||
const basePath = path.join(tmpDir, 'base.yaml');
|
||||
const customizePath = path.join(tmpDir, 'customize.yaml');
|
||||
await fs.writeFile(basePath, yaml.stringify(baseYaml));
|
||||
await fs.writeFile(customizePath, yaml.stringify(customizeYaml));
|
||||
|
||||
const result = await builder.loadAndMergeAgent(basePath, customizePath);
|
||||
|
||||
expect(result.agent.persona.role).toBe('Custom Role'); // Overridden
|
||||
expect(result.agent.persona.identity).toBe('Base Identity'); // Preserved
|
||||
expect(result.agent.persona.communication_style).toBe('Custom Style'); // Overridden
|
||||
expect(result.agent.persona.principles).toEqual(['Base Principle']); // Preserved
|
||||
});
|
||||
|
||||
it('should preserve base persona when customize has null values', async () => {
|
||||
const baseYaml = {
|
||||
agent: {
|
||||
metadata: { id: 'base', name: 'Base', title: 'Base', icon: '🔧' },
|
||||
persona: {
|
||||
role: 'Base Role',
|
||||
identity: 'Base Identity',
|
||||
communication_style: 'Base Style',
|
||||
principles: ['Base'],
|
||||
},
|
||||
menu: [],
|
||||
},
|
||||
};
|
||||
|
||||
const customizeYaml = {
|
||||
persona: {
|
||||
role: null,
|
||||
identity: 'Custom Identity',
|
||||
},
|
||||
};
|
||||
|
||||
const basePath = path.join(tmpDir, 'base.yaml');
|
||||
const customizePath = path.join(tmpDir, 'customize.yaml');
|
||||
await fs.writeFile(basePath, yaml.stringify(baseYaml));
|
||||
await fs.writeFile(customizePath, yaml.stringify(customizeYaml));
|
||||
|
||||
const result = await builder.loadAndMergeAgent(basePath, customizePath);
|
||||
|
||||
expect(result.agent.persona.role).toBe('Base Role'); // Preserved (null skipped)
|
||||
expect(result.agent.persona.identity).toBe('Custom Identity'); // Overridden
|
||||
});
|
||||
|
||||
it('should preserve base persona when customize has empty arrays', async () => {
|
||||
const baseYaml = {
|
||||
agent: {
|
||||
metadata: { id: 'base', name: 'Base', title: 'Base', icon: '🔧' },
|
||||
persona: {
|
||||
role: 'Base Role',
|
||||
identity: 'Base Identity',
|
||||
communication_style: 'Base Style',
|
||||
principles: ['Principle 1', 'Principle 2'],
|
||||
},
|
||||
menu: [],
|
||||
},
|
||||
};
|
||||
|
||||
const customizeYaml = {
|
||||
persona: {
|
||||
principles: [], // Empty array - should NOT override
|
||||
},
|
||||
};
|
||||
|
||||
const basePath = path.join(tmpDir, 'base.yaml');
|
||||
const customizePath = path.join(tmpDir, 'customize.yaml');
|
||||
await fs.writeFile(basePath, yaml.stringify(baseYaml));
|
||||
await fs.writeFile(customizePath, yaml.stringify(customizeYaml));
|
||||
|
||||
const result = await builder.loadAndMergeAgent(basePath, customizePath);
|
||||
|
||||
expect(result.agent.persona.principles).toEqual(['Principle 1', 'Principle 2']);
|
||||
});
|
||||
|
||||
it('should append menu items from customize', async () => {
|
||||
const baseYaml = {
|
||||
agent: {
|
||||
metadata: { id: 'base', name: 'Base', title: 'Base', icon: '🔧' },
|
||||
persona: { role: 'Role', identity: 'ID', communication_style: 'Style', principles: ['P'] },
|
||||
menu: [{ trigger: 'help', description: 'Help', action: 'show_help' }],
|
||||
},
|
||||
};
|
||||
|
||||
const customizeYaml = {
|
||||
menu: [{ trigger: 'custom', description: 'Custom', action: 'custom_action' }],
|
||||
};
|
||||
|
||||
const basePath = path.join(tmpDir, 'base.yaml');
|
||||
const customizePath = path.join(tmpDir, 'customize.yaml');
|
||||
await fs.writeFile(basePath, yaml.stringify(baseYaml));
|
||||
await fs.writeFile(customizePath, yaml.stringify(customizeYaml));
|
||||
|
||||
const result = await builder.loadAndMergeAgent(basePath, customizePath);
|
||||
|
||||
expect(result.agent.menu).toHaveLength(2);
|
||||
expect(result.agent.menu[0].trigger).toBe('help');
|
||||
expect(result.agent.menu[1].trigger).toBe('custom');
|
||||
});
|
||||
|
||||
it('should append critical_actions from customize', async () => {
|
||||
const baseYaml = {
|
||||
agent: {
|
||||
metadata: { id: 'base', name: 'Base', title: 'Base', icon: '🔧' },
|
||||
persona: { role: 'Role', identity: 'ID', communication_style: 'Style', principles: ['P'] },
|
||||
critical_actions: ['Action 1'],
|
||||
menu: [],
|
||||
},
|
||||
};
|
||||
|
||||
const customizeYaml = {
|
||||
critical_actions: ['Action 2', 'Action 3'],
|
||||
};
|
||||
|
||||
const basePath = path.join(tmpDir, 'base.yaml');
|
||||
const customizePath = path.join(tmpDir, 'customize.yaml');
|
||||
await fs.writeFile(basePath, yaml.stringify(baseYaml));
|
||||
await fs.writeFile(customizePath, yaml.stringify(customizeYaml));
|
||||
|
||||
const result = await builder.loadAndMergeAgent(basePath, customizePath);
|
||||
|
||||
expect(result.agent.critical_actions).toHaveLength(3);
|
||||
expect(result.agent.critical_actions).toEqual(['Action 1', 'Action 2', 'Action 3']);
|
||||
});
|
||||
|
||||
it('should append prompts from customize', async () => {
|
||||
const baseYaml = {
|
||||
agent: {
|
||||
metadata: { id: 'base', name: 'Base', title: 'Base', icon: '🔧' },
|
||||
persona: { role: 'Role', identity: 'ID', communication_style: 'Style', principles: ['P'] },
|
||||
prompts: [{ id: 'p1', content: 'Prompt 1' }],
|
||||
menu: [],
|
||||
},
|
||||
};
|
||||
|
||||
const customizeYaml = {
|
||||
prompts: [{ id: 'p2', content: 'Prompt 2' }],
|
||||
};
|
||||
|
||||
const basePath = path.join(tmpDir, 'base.yaml');
|
||||
const customizePath = path.join(tmpDir, 'customize.yaml');
|
||||
await fs.writeFile(basePath, yaml.stringify(baseYaml));
|
||||
await fs.writeFile(customizePath, yaml.stringify(customizeYaml));
|
||||
|
||||
const result = await builder.loadAndMergeAgent(basePath, customizePath);
|
||||
|
||||
expect(result.agent.prompts).toHaveLength(2);
|
||||
});
|
||||
|
||||
it('should handle missing customization file', async () => {
|
||||
const agentYaml = {
|
||||
agent: {
|
||||
metadata: { id: 'test', name: 'Test', title: 'Test', icon: '🔧' },
|
||||
persona: { role: 'Role', identity: 'ID', communication_style: 'Style', principles: ['P'] },
|
||||
menu: [],
|
||||
},
|
||||
};
|
||||
|
||||
const agentPath = path.join(tmpDir, 'agent.yaml');
|
||||
await fs.writeFile(agentPath, yaml.stringify(agentYaml));
|
||||
|
||||
const nonExistent = path.join(tmpDir, 'nonexistent.yaml');
|
||||
const result = await builder.loadAndMergeAgent(agentPath, nonExistent);
|
||||
|
||||
expect(result.agent.metadata.id).toBe('test');
|
||||
});
|
||||
|
||||
it('should handle legacy commands field (renamed to menu)', async () => {
|
||||
const baseYaml = {
|
||||
agent: {
|
||||
metadata: { id: 'base', name: 'Base', title: 'Base', icon: '🔧' },
|
||||
persona: { role: 'Role', identity: 'ID', communication_style: 'Style', principles: ['P'] },
|
||||
commands: [{ trigger: 'old', description: 'Old', action: 'old_action' }],
|
||||
},
|
||||
};
|
||||
|
||||
const customizeYaml = {
|
||||
commands: [{ trigger: 'new', description: 'New', action: 'new_action' }],
|
||||
};
|
||||
|
||||
const basePath = path.join(tmpDir, 'base.yaml');
|
||||
const customizePath = path.join(tmpDir, 'customize.yaml');
|
||||
await fs.writeFile(basePath, yaml.stringify(baseYaml));
|
||||
await fs.writeFile(customizePath, yaml.stringify(customizeYaml));
|
||||
|
||||
const result = await builder.loadAndMergeAgent(basePath, customizePath);
|
||||
|
||||
expect(result.agent.commands).toHaveLength(2);
|
||||
});
|
||||
|
||||
it('should override metadata with non-empty values', async () => {
|
||||
const baseYaml = {
|
||||
agent: {
|
||||
metadata: { id: 'base', name: 'Base Name', title: 'Base Title', icon: '🔧' },
|
||||
persona: { role: 'Role', identity: 'ID', communication_style: 'Style', principles: ['P'] },
|
||||
menu: [],
|
||||
},
|
||||
};
|
||||
|
||||
const customizeYaml = {
|
||||
agent: {
|
||||
metadata: {
|
||||
name: 'Custom Name',
|
||||
title: '', // Empty - should be skipped
|
||||
icon: '🎯',
|
||||
},
|
||||
},
|
||||
};
|
||||
|
||||
const basePath = path.join(tmpDir, 'base.yaml');
|
||||
const customizePath = path.join(tmpDir, 'customize.yaml');
|
||||
await fs.writeFile(basePath, yaml.stringify(baseYaml));
|
||||
await fs.writeFile(customizePath, yaml.stringify(customizeYaml));
|
||||
|
||||
const result = await builder.loadAndMergeAgent(basePath, customizePath);
|
||||
|
||||
expect(result.agent.metadata.name).toBe('Custom Name');
|
||||
expect(result.agent.metadata.title).toBe('Base Title'); // Preserved
|
||||
expect(result.agent.metadata.icon).toBe('🎯');
|
||||
});
|
||||
});
|
||||
|
||||
describe('buildPersonaXml()', () => {
|
||||
it('should build complete persona XML', () => {
|
||||
const persona = {
|
||||
role: 'Test Role',
|
||||
identity: 'Test Identity',
|
||||
communication_style: 'Professional',
|
||||
principles: ['Principle 1', 'Principle 2', 'Principle 3'],
|
||||
};
|
||||
|
||||
const xml = builder.buildPersonaXml(persona);
|
||||
|
||||
expect(xml).toContain('<persona>');
|
||||
expect(xml).toContain('</persona>');
|
||||
expect(xml).toContain('<role>Test Role</role>');
|
||||
expect(xml).toContain('<identity>Test Identity</identity>');
|
||||
expect(xml).toContain('<communication_style>Professional</communication_style>');
|
||||
expect(xml).toContain('<principles>Principle 1 Principle 2 Principle 3</principles>');
|
||||
});
|
||||
|
||||
it('should escape XML special characters in persona', () => {
|
||||
const persona = {
|
||||
role: 'Role with <tags> & "quotes"',
|
||||
identity: "O'Reilly's Identity",
|
||||
communication_style: 'Use <code> tags',
|
||||
principles: ['Principle with & ampersand'],
|
||||
};
|
||||
|
||||
const xml = builder.buildPersonaXml(persona);
|
||||
|
||||
expect(xml).toContain('<tags> & "quotes"');
|
||||
expect(xml).toContain('O'Reilly's Identity');
|
||||
expect(xml).toContain('<code> tags');
|
||||
expect(xml).toContain('& ampersand');
|
||||
});
|
||||
|
||||
it('should handle principles as array', () => {
|
||||
const persona = {
|
||||
role: 'Role',
|
||||
identity: 'ID',
|
||||
communication_style: 'Style',
|
||||
principles: ['P1', 'P2', 'P3'],
|
||||
};
|
||||
|
||||
const xml = builder.buildPersonaXml(persona);
|
||||
|
||||
expect(xml).toContain('<principles>P1 P2 P3</principles>');
|
||||
});
|
||||
|
||||
it('should handle principles as string', () => {
|
||||
const persona = {
|
||||
role: 'Role',
|
||||
identity: 'ID',
|
||||
communication_style: 'Style',
|
||||
principles: 'Single principle string',
|
||||
};
|
||||
|
||||
const xml = builder.buildPersonaXml(persona);
|
||||
|
||||
expect(xml).toContain('<principles>Single principle string</principles>');
|
||||
});
|
||||
|
||||
it('should preserve Unicode in persona fields', () => {
|
||||
const persona = {
|
||||
role: 'Тестовая роль',
|
||||
identity: '日本語のアイデンティティ',
|
||||
communication_style: 'Estilo profesional',
|
||||
principles: ['原则一', 'Принцип два'],
|
||||
};
|
||||
|
||||
const xml = builder.buildPersonaXml(persona);
|
||||
|
||||
expect(xml).toContain('Тестовая роль');
|
||||
expect(xml).toContain('日本語のアイデンティティ');
|
||||
expect(xml).toContain('Estilo profesional');
|
||||
expect(xml).toContain('原则一 Принцип два');
|
||||
});
|
||||
|
||||
it('should handle missing persona gracefully', () => {
|
||||
const xml = builder.buildPersonaXml(null);
|
||||
|
||||
expect(xml).toBe('');
|
||||
});
|
||||
|
||||
it('should handle partial persona (missing optional fields)', () => {
|
||||
const persona = {
|
||||
role: 'Role',
|
||||
identity: 'ID',
|
||||
communication_style: 'Style',
|
||||
// principles missing
|
||||
};
|
||||
|
||||
const xml = builder.buildPersonaXml(persona);
|
||||
|
||||
expect(xml).toContain('<role>Role</role>');
|
||||
expect(xml).toContain('<identity>ID</identity>');
|
||||
expect(xml).toContain('<communication_style>Style</communication_style>');
|
||||
expect(xml).not.toContain('<principles>');
|
||||
});
|
||||
});
|
||||
|
||||
describe('buildMemoriesXml()', () => {
|
||||
it('should build memories XML from array', () => {
|
||||
const memories = ['Memory 1', 'Memory 2', 'Memory 3'];
|
||||
|
||||
const xml = builder.buildMemoriesXml(memories);
|
||||
|
||||
expect(xml).toContain('<memories>');
|
||||
expect(xml).toContain('</memories>');
|
||||
expect(xml).toContain('<memory>Memory 1</memory>');
|
||||
expect(xml).toContain('<memory>Memory 2</memory>');
|
||||
expect(xml).toContain('<memory>Memory 3</memory>');
|
||||
});
|
||||
|
||||
it('should escape XML special characters in memories', () => {
|
||||
const memories = ['Memory with <tags>', 'Memory with & ampersand', 'Memory with "quotes"'];
|
||||
|
||||
const xml = builder.buildMemoriesXml(memories);
|
||||
|
||||
expect(xml).toContain('<tags>');
|
||||
expect(xml).toContain('& ampersand');
|
||||
expect(xml).toContain('"quotes"');
|
||||
});
|
||||
|
||||
it('should return empty string for null memories', () => {
|
||||
expect(builder.buildMemoriesXml(null)).toBe('');
|
||||
});
|
||||
|
||||
it('should return empty string for empty array', () => {
|
||||
expect(builder.buildMemoriesXml([])).toBe('');
|
||||
});
|
||||
|
||||
it('should handle Unicode in memories', () => {
|
||||
const memories = ['记忆 1', 'Память 2', '記憶 3'];
|
||||
|
||||
const xml = builder.buildMemoriesXml(memories);
|
||||
|
||||
expect(xml).toContain('记忆 1');
|
||||
expect(xml).toContain('Память 2');
|
||||
expect(xml).toContain('記憶 3');
|
||||
});
|
||||
});
|
||||
|
||||
describe('buildPromptsXml()', () => {
|
||||
it('should build prompts XML from array format', () => {
|
||||
const prompts = [
|
||||
{ id: 'p1', content: 'Prompt 1 content' },
|
||||
{ id: 'p2', content: 'Prompt 2 content' },
|
||||
];
|
||||
|
||||
const xml = builder.buildPromptsXml(prompts);
|
||||
|
||||
expect(xml).toContain('<prompts>');
|
||||
expect(xml).toContain('</prompts>');
|
||||
expect(xml).toContain('<prompt id="p1">');
|
||||
expect(xml).toContain('<content>');
|
||||
expect(xml).toContain('Prompt 1 content');
|
||||
expect(xml).toContain('<prompt id="p2">');
|
||||
expect(xml).toContain('Prompt 2 content');
|
||||
});
|
||||
|
||||
it('should escape XML special characters in prompts', () => {
|
||||
const prompts = [{ id: 'test', content: 'Content with <tags> & "quotes"' }];
|
||||
|
||||
const xml = builder.buildPromptsXml(prompts);
|
||||
|
||||
expect(xml).toContain('<content>');
|
||||
expect(xml).toContain('<tags> & "quotes"');
|
||||
});
|
||||
|
||||
it('should return empty string for null prompts', () => {
|
||||
expect(builder.buildPromptsXml(null)).toBe('');
|
||||
});
|
||||
|
||||
it('should handle Unicode in prompts', () => {
|
||||
const prompts = [{ id: 'unicode', content: 'Test 测试 тест テスト' }];
|
||||
|
||||
const xml = builder.buildPromptsXml(prompts);
|
||||
|
||||
expect(xml).toContain('<content>');
|
||||
expect(xml).toContain('测试 тест テスト');
|
||||
});
|
||||
|
||||
it('should handle object/dictionary format prompts', () => {
|
||||
const prompts = {
|
||||
p1: 'Prompt 1 content',
|
||||
p2: 'Prompt 2 content',
|
||||
};
|
||||
|
||||
const xml = builder.buildPromptsXml(prompts);
|
||||
|
||||
expect(xml).toContain('<prompts>');
|
||||
expect(xml).toContain('<prompt id="p1">');
|
||||
expect(xml).toContain('Prompt 1 content');
|
||||
expect(xml).toContain('<prompt id="p2">');
|
||||
expect(xml).toContain('Prompt 2 content');
|
||||
});
|
||||
|
||||
it('should return empty string for empty array', () => {
|
||||
expect(builder.buildPromptsXml([])).toBe('');
|
||||
});
|
||||
});
|
||||
|
||||
describe('calculateFileHash()', () => {
|
||||
it('should calculate MD5 hash of file content', async () => {
|
||||
const content = 'test content for hashing';
|
||||
const filePath = await createTestFile(tmpDir, 'test.txt', content);
|
||||
|
||||
const hash = await builder.calculateFileHash(filePath);
|
||||
|
||||
expect(hash).toHaveLength(8); // MD5 truncated to 8 chars
|
||||
expect(hash).toMatch(/^[a-f0-9]{8}$/);
|
||||
});
|
||||
|
||||
it('should return consistent hash for same content', async () => {
|
||||
const file1 = await createTestFile(tmpDir, 'file1.txt', 'content');
|
||||
const file2 = await createTestFile(tmpDir, 'file2.txt', 'content');
|
||||
|
||||
const hash1 = await builder.calculateFileHash(file1);
|
||||
const hash2 = await builder.calculateFileHash(file2);
|
||||
|
||||
expect(hash1).toBe(hash2);
|
||||
});
|
||||
|
||||
it('should return null for non-existent file', async () => {
|
||||
const nonExistent = path.join(tmpDir, 'missing.txt');
|
||||
|
||||
const hash = await builder.calculateFileHash(nonExistent);
|
||||
|
||||
expect(hash).toBeNull();
|
||||
});
|
||||
|
||||
it('should handle empty file', async () => {
|
||||
const file = await createTestFile(tmpDir, 'empty.txt', '');
|
||||
|
||||
const hash = await builder.calculateFileHash(file);
|
||||
|
||||
expect(hash).toHaveLength(8);
|
||||
});
|
||||
});
|
||||
});
|
||||
|
|
@ -0,0 +1,84 @@
|
|||
import { describe, it, expect } from 'vitest';
|
||||
import { escapeXml } from '../../../tools/lib/xml-utils.js';
|
||||
|
||||
describe('xml-utils', () => {
|
||||
describe('escapeXml()', () => {
|
||||
it('should escape ampersand (&) to &', () => {
|
||||
expect(escapeXml('Tom & Jerry')).toBe('Tom & Jerry');
|
||||
});
|
||||
|
||||
it('should escape less than (<) to <', () => {
|
||||
expect(escapeXml('5 < 10')).toBe('5 < 10');
|
||||
});
|
||||
|
||||
it('should escape greater than (>) to >', () => {
|
||||
expect(escapeXml('10 > 5')).toBe('10 > 5');
|
||||
});
|
||||
|
||||
it('should escape double quote (") to "', () => {
|
||||
expect(escapeXml('He said "hello"')).toBe('He said "hello"');
|
||||
});
|
||||
|
||||
it("should escape single quote (') to '", () => {
|
||||
expect(escapeXml("It's working")).toBe('It's working');
|
||||
});
|
||||
|
||||
it('should preserve Unicode characters', () => {
|
||||
expect(escapeXml('Hello 世界 🌍')).toBe('Hello 世界 🌍');
|
||||
});
|
||||
|
||||
it('should escape multiple special characters in sequence', () => {
|
||||
expect(escapeXml('<tag attr="value">')).toBe('<tag attr="value">');
|
||||
});
|
||||
|
||||
it('should escape all five special characters together', () => {
|
||||
expect(escapeXml(`&<>"'`)).toBe('&<>"'');
|
||||
});
|
||||
|
||||
it('should handle empty string', () => {
|
||||
expect(escapeXml('')).toBe('');
|
||||
});
|
||||
|
||||
it('should handle null', () => {
|
||||
expect(escapeXml(null)).toBe('');
|
||||
});
|
||||
|
||||
it('should handle undefined', () => {
|
||||
expect(escapeXml()).toBe('');
|
||||
});
|
||||
|
||||
it('should handle text with no special characters', () => {
|
||||
expect(escapeXml('Hello World')).toBe('Hello World');
|
||||
});
|
||||
|
||||
it('should handle text that is only special characters', () => {
|
||||
expect(escapeXml('&&&')).toBe('&&&');
|
||||
});
|
||||
|
||||
it('should not double-escape already escaped entities', () => {
|
||||
// Note: This is expected behavior - the function WILL double-escape
|
||||
// This test documents the actual behavior
|
||||
expect(escapeXml('&')).toBe('&amp;');
|
||||
});
|
||||
|
||||
it('should escape special characters in XML content', () => {
|
||||
const xmlContent = '<persona role="Developer & Architect">Use <code> tags</persona>';
|
||||
const expected = '<persona role="Developer & Architect">Use <code> tags</persona>';
|
||||
expect(escapeXml(xmlContent)).toBe(expected);
|
||||
});
|
||||
|
||||
it('should handle mixed Unicode and special characters', () => {
|
||||
expect(escapeXml('测试 <tag> & "quotes"')).toBe('测试 <tag> & "quotes"');
|
||||
});
|
||||
|
||||
it('should handle newlines and special characters', () => {
|
||||
const multiline = 'Line 1 & text\n<Line 2>\n"Line 3"';
|
||||
const expected = 'Line 1 & text\n<Line 2>\n"Line 3"';
|
||||
expect(escapeXml(multiline)).toBe(expected);
|
||||
});
|
||||
|
||||
it('should handle string with only whitespace', () => {
|
||||
expect(escapeXml(' ')).toBe(' ');
|
||||
});
|
||||
});
|
||||
});
|
||||
|
|
@ -0,0 +1,65 @@
|
|||
const chalk = require('chalk');
|
||||
const path = require('node:path');
|
||||
const { Installer } = require('../installers/lib/core/installer');
|
||||
const { Manifest } = require('../installers/lib/core/manifest');
|
||||
const { UI } = require('../lib/ui');
|
||||
|
||||
const installer = new Installer();
|
||||
const manifest = new Manifest();
|
||||
const ui = new UI();
|
||||
|
||||
module.exports = {
|
||||
command: 'status',
|
||||
description: 'Display BMAD installation status and module versions',
|
||||
options: [],
|
||||
action: async (options) => {
|
||||
try {
|
||||
// Find the bmad directory
|
||||
const projectDir = process.cwd();
|
||||
const { bmadDir } = await installer.findBmadDir(projectDir);
|
||||
|
||||
// Check if bmad directory exists
|
||||
const fs = require('fs-extra');
|
||||
if (!(await fs.pathExists(bmadDir))) {
|
||||
console.log(chalk.yellow('No BMAD installation found in the current directory.'));
|
||||
console.log(chalk.dim(`Expected location: ${bmadDir}`));
|
||||
console.log(chalk.dim('\nRun "bmad install" to set up a new installation.'));
|
||||
process.exit(0);
|
||||
return;
|
||||
}
|
||||
|
||||
// Read manifest
|
||||
const manifestData = await manifest._readRaw(bmadDir);
|
||||
|
||||
if (!manifestData) {
|
||||
console.log(chalk.yellow('No BMAD installation manifest found.'));
|
||||
console.log(chalk.dim('\nRun "bmad install" to set up a new installation.'));
|
||||
process.exit(0);
|
||||
return;
|
||||
}
|
||||
|
||||
// Get installation info
|
||||
const installation = manifestData.installation || {};
|
||||
const modules = manifestData.modules || [];
|
||||
|
||||
// Check for available updates (only for external modules)
|
||||
const availableUpdates = await manifest.checkForUpdates(bmadDir);
|
||||
|
||||
// Display status
|
||||
ui.displayStatus({
|
||||
installation,
|
||||
modules,
|
||||
availableUpdates,
|
||||
bmadDir,
|
||||
});
|
||||
|
||||
process.exit(0);
|
||||
} catch (error) {
|
||||
console.error(chalk.red('Status check failed:'), error.message);
|
||||
if (process.env.BMAD_DEBUG) {
|
||||
console.error(chalk.dim(error.stack));
|
||||
}
|
||||
process.exit(1);
|
||||
}
|
||||
},
|
||||
};
|
||||
|
|
@ -10,6 +10,7 @@ modules:
|
|||
description: "Agent, Workflow and Module Builder"
|
||||
defaultSelected: false
|
||||
type: bmad-org
|
||||
npmPackage: bmad-builder
|
||||
|
||||
bmad-creative-intelligence-suite:
|
||||
url: https://github.com/bmad-code-org/bmad-module-creative-intelligence-suite
|
||||
|
|
@ -19,6 +20,7 @@ modules:
|
|||
description: "Creative tools for writing, brainstorming, and more"
|
||||
defaultSelected: false
|
||||
type: bmad-org
|
||||
npmPackage: bmad-creative-intelligence-suite
|
||||
|
||||
bmad-game-dev-studio:
|
||||
url: https://github.com/bmad-code-org/bmad-module-game-dev-studio.git
|
||||
|
|
@ -28,6 +30,7 @@ modules:
|
|||
description: "Game development agents and workflows"
|
||||
defaultSelected: false
|
||||
type: bmad-org
|
||||
npmPackage: bmad-game-dev-studio
|
||||
|
||||
# TODO: Enable once fixes applied:
|
||||
|
||||
|
|
|
|||
|
|
@ -534,18 +534,71 @@ class ManifestGenerator {
|
|||
|
||||
/**
|
||||
* Write main manifest as YAML with installation info only
|
||||
* Fetches fresh version info for all modules
|
||||
* @returns {string} Path to the manifest file
|
||||
*/
|
||||
async writeMainManifest(cfgDir) {
|
||||
const manifestPath = path.join(cfgDir, 'manifest.yaml');
|
||||
|
||||
// Read existing manifest to preserve install date
|
||||
let existingInstallDate = null;
|
||||
const existingModulesMap = new Map();
|
||||
|
||||
if (await fs.pathExists(manifestPath)) {
|
||||
try {
|
||||
const existingContent = await fs.readFile(manifestPath, 'utf8');
|
||||
const existingManifest = yaml.parse(existingContent);
|
||||
|
||||
// Preserve original install date
|
||||
if (existingManifest.installation?.installDate) {
|
||||
existingInstallDate = existingManifest.installation.installDate;
|
||||
}
|
||||
|
||||
// Build map of existing modules for quick lookup
|
||||
if (existingManifest.modules && Array.isArray(existingManifest.modules)) {
|
||||
for (const m of existingManifest.modules) {
|
||||
if (typeof m === 'object' && m.name) {
|
||||
existingModulesMap.set(m.name, m);
|
||||
} else if (typeof m === 'string') {
|
||||
existingModulesMap.set(m, { installDate: existingInstallDate });
|
||||
}
|
||||
}
|
||||
}
|
||||
} catch {
|
||||
// If we can't read existing manifest, continue with defaults
|
||||
}
|
||||
}
|
||||
|
||||
// Fetch fresh version info for all modules
|
||||
const { Manifest } = require('./manifest');
|
||||
const manifestObj = new Manifest();
|
||||
const updatedModules = [];
|
||||
|
||||
for (const moduleName of this.modules) {
|
||||
// Get fresh version info from source
|
||||
const versionInfo = await manifestObj.getModuleVersionInfo(moduleName, this.bmadDir);
|
||||
|
||||
// Get existing install date if available
|
||||
const existing = existingModulesMap.get(moduleName);
|
||||
|
||||
updatedModules.push({
|
||||
name: moduleName,
|
||||
version: versionInfo.version,
|
||||
installDate: existing?.installDate || new Date().toISOString(),
|
||||
lastUpdated: new Date().toISOString(),
|
||||
source: versionInfo.source,
|
||||
npmPackage: versionInfo.npmPackage,
|
||||
repoUrl: versionInfo.repoUrl,
|
||||
});
|
||||
}
|
||||
|
||||
const manifest = {
|
||||
installation: {
|
||||
version: packageJson.version,
|
||||
installDate: new Date().toISOString(),
|
||||
installDate: existingInstallDate || new Date().toISOString(),
|
||||
lastUpdated: new Date().toISOString(),
|
||||
},
|
||||
modules: this.modules, // Include ALL modules (standard and custom)
|
||||
modules: updatedModules,
|
||||
ides: this.selectedIdes,
|
||||
};
|
||||
|
||||
|
|
|
|||
|
|
@ -1,6 +1,7 @@
|
|||
const path = require('node:path');
|
||||
const fs = require('fs-extra');
|
||||
const crypto = require('node:crypto');
|
||||
const { getProjectRoot } = require('../../../lib/project-root');
|
||||
|
||||
class Manifest {
|
||||
/**
|
||||
|
|
@ -16,14 +17,35 @@ class Manifest {
|
|||
// Ensure _config directory exists
|
||||
await fs.ensureDir(path.dirname(manifestPath));
|
||||
|
||||
// Get the BMad version from package.json
|
||||
const bmadVersion = data.version || require(path.join(process.cwd(), 'package.json')).version;
|
||||
|
||||
// Convert module list to new detailed format
|
||||
const moduleDetails = [];
|
||||
if (data.modules && Array.isArray(data.modules)) {
|
||||
for (const moduleName of data.modules) {
|
||||
// Core and BMM modules use the BMad version
|
||||
const moduleVersion = moduleName === 'core' || moduleName === 'bmm' ? bmadVersion : null;
|
||||
const now = data.installDate || new Date().toISOString();
|
||||
|
||||
moduleDetails.push({
|
||||
name: moduleName,
|
||||
version: moduleVersion,
|
||||
installDate: now,
|
||||
lastUpdated: now,
|
||||
source: moduleName === 'core' || moduleName === 'bmm' ? 'built-in' : 'unknown',
|
||||
});
|
||||
}
|
||||
}
|
||||
|
||||
// Structure the manifest data
|
||||
const manifestData = {
|
||||
installation: {
|
||||
version: data.version || require(path.join(process.cwd(), 'package.json')).version,
|
||||
version: bmadVersion,
|
||||
installDate: data.installDate || new Date().toISOString(),
|
||||
lastUpdated: data.lastUpdated || new Date().toISOString(),
|
||||
},
|
||||
modules: data.modules || [],
|
||||
modules: moduleDetails,
|
||||
ides: data.ides || [],
|
||||
};
|
||||
|
||||
|
|
@ -57,12 +79,23 @@ class Manifest {
|
|||
const content = await fs.readFile(yamlPath, 'utf8');
|
||||
const manifestData = yaml.parse(content);
|
||||
|
||||
// Handle new detailed module format
|
||||
const modules = manifestData.modules || [];
|
||||
|
||||
// For backward compatibility: if modules is an array of strings (old format),
|
||||
// the calling code may need the array of names
|
||||
const moduleNames = modules.map((m) => (typeof m === 'string' ? m : m.name));
|
||||
|
||||
// Check if we have the new detailed format
|
||||
const hasDetailedModules = modules.length > 0 && typeof modules[0] === 'object';
|
||||
|
||||
// Flatten the structure for compatibility with existing code
|
||||
return {
|
||||
version: manifestData.installation?.version,
|
||||
installDate: manifestData.installation?.installDate,
|
||||
lastUpdated: manifestData.installation?.lastUpdated,
|
||||
modules: manifestData.modules || [], // All modules (standard and custom)
|
||||
modules: moduleNames, // Simple array of module names for backward compatibility
|
||||
modulesDetailed: hasDetailedModules ? modules : null, // New detailed format
|
||||
customModules: manifestData.customModules || [], // Keep for backward compatibility
|
||||
ides: manifestData.ides || [],
|
||||
};
|
||||
|
|
@ -82,28 +115,92 @@ class Manifest {
|
|||
*/
|
||||
async update(bmadDir, updates, installedFiles = null) {
|
||||
const yaml = require('yaml');
|
||||
const manifest = (await this.read(bmadDir)) || {};
|
||||
|
||||
// Merge updates
|
||||
Object.assign(manifest, updates);
|
||||
manifest.lastUpdated = new Date().toISOString();
|
||||
|
||||
// Convert back to structured format for YAML
|
||||
const manifestData = {
|
||||
installation: {
|
||||
version: manifest.version,
|
||||
installDate: manifest.installDate,
|
||||
lastUpdated: manifest.lastUpdated,
|
||||
},
|
||||
modules: manifest.modules || [], // All modules (standard and custom)
|
||||
ides: manifest.ides || [],
|
||||
const manifest = (await this._readRaw(bmadDir)) || {
|
||||
installation: {},
|
||||
modules: [],
|
||||
ides: [],
|
||||
};
|
||||
|
||||
// Handle module updates
|
||||
if (updates.modules) {
|
||||
// If modules is being updated, we need to preserve detailed module info
|
||||
const existingDetailed = manifest.modules || [];
|
||||
const incomingNames = updates.modules;
|
||||
|
||||
// Build updated modules array
|
||||
const updatedModules = [];
|
||||
for (const name of incomingNames) {
|
||||
const existing = existingDetailed.find((m) => m.name === name);
|
||||
if (existing) {
|
||||
// Preserve existing details, update lastUpdated if this module is being updated
|
||||
updatedModules.push({
|
||||
...existing,
|
||||
lastUpdated: new Date().toISOString(),
|
||||
});
|
||||
} else {
|
||||
// New module - add with minimal details
|
||||
updatedModules.push({
|
||||
name,
|
||||
version: null,
|
||||
installDate: new Date().toISOString(),
|
||||
lastUpdated: new Date().toISOString(),
|
||||
source: 'unknown',
|
||||
});
|
||||
}
|
||||
}
|
||||
|
||||
manifest.modules = updatedModules;
|
||||
}
|
||||
|
||||
// Merge other updates
|
||||
if (updates.version) {
|
||||
manifest.installation.version = updates.version;
|
||||
}
|
||||
if (updates.installDate) {
|
||||
manifest.installation.installDate = updates.installDate;
|
||||
}
|
||||
manifest.installation.lastUpdated = new Date().toISOString();
|
||||
|
||||
if (updates.ides) {
|
||||
manifest.ides = updates.ides;
|
||||
}
|
||||
|
||||
// Handle per-module version updates
|
||||
if (updates.moduleVersions) {
|
||||
for (const [moduleName, versionInfo] of Object.entries(updates.moduleVersions)) {
|
||||
const moduleIndex = manifest.modules.findIndex((m) => m.name === moduleName);
|
||||
if (moduleIndex !== -1) {
|
||||
manifest.modules[moduleIndex] = {
|
||||
...manifest.modules[moduleIndex],
|
||||
...versionInfo,
|
||||
lastUpdated: new Date().toISOString(),
|
||||
};
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
// Handle adding a new module with version info
|
||||
if (updates.addModule) {
|
||||
const { name, version, source, npmPackage, repoUrl } = updates.addModule;
|
||||
const existing = manifest.modules.find((m) => m.name === name);
|
||||
if (!existing) {
|
||||
manifest.modules.push({
|
||||
name,
|
||||
version: version || null,
|
||||
installDate: new Date().toISOString(),
|
||||
lastUpdated: new Date().toISOString(),
|
||||
source: source || 'external',
|
||||
npmPackage: npmPackage || null,
|
||||
repoUrl: repoUrl || null,
|
||||
});
|
||||
}
|
||||
}
|
||||
|
||||
const manifestPath = path.join(bmadDir, '_config', 'manifest.yaml');
|
||||
await fs.ensureDir(path.dirname(manifestPath));
|
||||
|
||||
// Clean the manifest data to remove any non-serializable values
|
||||
const cleanManifestData = structuredClone(manifestData);
|
||||
const cleanManifestData = structuredClone(manifest);
|
||||
|
||||
const yamlContent = yaml.stringify(cleanManifestData, {
|
||||
indent: 2,
|
||||
|
|
@ -115,16 +212,61 @@ class Manifest {
|
|||
const content = yamlContent.endsWith('\n') ? yamlContent : yamlContent + '\n';
|
||||
await fs.writeFile(manifestPath, content, 'utf8');
|
||||
|
||||
return manifest;
|
||||
// Return the flattened format for compatibility
|
||||
return this._flattenManifest(manifest);
|
||||
}
|
||||
|
||||
/**
|
||||
* Add a module to the manifest
|
||||
* Read raw manifest data without flattening
|
||||
* @param {string} bmadDir - Path to bmad directory
|
||||
* @returns {Object|null} Raw manifest data or null if not found
|
||||
*/
|
||||
async _readRaw(bmadDir) {
|
||||
const yamlPath = path.join(bmadDir, '_config', 'manifest.yaml');
|
||||
const yaml = require('yaml');
|
||||
|
||||
if (await fs.pathExists(yamlPath)) {
|
||||
try {
|
||||
const content = await fs.readFile(yamlPath, 'utf8');
|
||||
return yaml.parse(content);
|
||||
} catch (error) {
|
||||
console.error('Failed to read YAML manifest:', error.message);
|
||||
}
|
||||
}
|
||||
|
||||
return null;
|
||||
}
|
||||
|
||||
/**
|
||||
* Flatten manifest for backward compatibility
|
||||
* @param {Object} manifest - Raw manifest data
|
||||
* @returns {Object} Flattened manifest
|
||||
*/
|
||||
_flattenManifest(manifest) {
|
||||
const modules = manifest.modules || [];
|
||||
const moduleNames = modules.map((m) => (typeof m === 'string' ? m : m.name));
|
||||
const hasDetailedModules = modules.length > 0 && typeof modules[0] === 'object';
|
||||
|
||||
return {
|
||||
version: manifest.installation?.version,
|
||||
installDate: manifest.installation?.installDate,
|
||||
lastUpdated: manifest.installation?.lastUpdated,
|
||||
modules: moduleNames,
|
||||
modulesDetailed: hasDetailedModules ? modules : null,
|
||||
customModules: manifest.customModules || [],
|
||||
ides: manifest.ides || [],
|
||||
};
|
||||
}
|
||||
|
||||
/**
|
||||
* Add a module to the manifest with optional version info
|
||||
* If module already exists, update its version info
|
||||
* @param {string} bmadDir - Path to bmad directory
|
||||
* @param {string} moduleName - Module name to add
|
||||
* @param {Object} options - Optional version info
|
||||
*/
|
||||
async addModule(bmadDir, moduleName) {
|
||||
const manifest = await this.read(bmadDir);
|
||||
async addModule(bmadDir, moduleName, options = {}) {
|
||||
const manifest = await this._readRaw(bmadDir);
|
||||
if (!manifest) {
|
||||
throw new Error('No manifest found');
|
||||
}
|
||||
|
|
@ -133,10 +275,33 @@ class Manifest {
|
|||
manifest.modules = [];
|
||||
}
|
||||
|
||||
if (!manifest.modules.includes(moduleName)) {
|
||||
manifest.modules.push(moduleName);
|
||||
await this.update(bmadDir, { modules: manifest.modules });
|
||||
const existingIndex = manifest.modules.findIndex((m) => m.name === moduleName);
|
||||
|
||||
if (existingIndex === -1) {
|
||||
// Module doesn't exist, add it
|
||||
manifest.modules.push({
|
||||
name: moduleName,
|
||||
version: options.version || null,
|
||||
installDate: new Date().toISOString(),
|
||||
lastUpdated: new Date().toISOString(),
|
||||
source: options.source || 'unknown',
|
||||
npmPackage: options.npmPackage || null,
|
||||
repoUrl: options.repoUrl || null,
|
||||
});
|
||||
} else {
|
||||
// Module exists, update its version info
|
||||
const existing = manifest.modules[existingIndex];
|
||||
manifest.modules[existingIndex] = {
|
||||
...existing,
|
||||
version: options.version === undefined ? existing.version : options.version,
|
||||
source: options.source || existing.source,
|
||||
npmPackage: options.npmPackage === undefined ? existing.npmPackage : options.npmPackage,
|
||||
repoUrl: options.repoUrl === undefined ? existing.repoUrl : options.repoUrl,
|
||||
lastUpdated: new Date().toISOString(),
|
||||
};
|
||||
}
|
||||
|
||||
await this._writeRaw(bmadDir, manifest);
|
||||
}
|
||||
|
||||
/**
|
||||
|
|
@ -145,18 +310,93 @@ class Manifest {
|
|||
* @param {string} moduleName - Module name to remove
|
||||
*/
|
||||
async removeModule(bmadDir, moduleName) {
|
||||
const manifest = await this.read(bmadDir);
|
||||
const manifest = await this._readRaw(bmadDir);
|
||||
if (!manifest || !manifest.modules) {
|
||||
return;
|
||||
}
|
||||
|
||||
const index = manifest.modules.indexOf(moduleName);
|
||||
const index = manifest.modules.findIndex((m) => m.name === moduleName);
|
||||
if (index !== -1) {
|
||||
manifest.modules.splice(index, 1);
|
||||
await this.update(bmadDir, { modules: manifest.modules });
|
||||
await this._writeRaw(bmadDir, manifest);
|
||||
}
|
||||
}
|
||||
|
||||
/**
|
||||
* Update a single module's version info
|
||||
* @param {string} bmadDir - Path to bmad directory
|
||||
* @param {string} moduleName - Module name
|
||||
* @param {Object} versionInfo - Version info to update
|
||||
*/
|
||||
async updateModuleVersion(bmadDir, moduleName, versionInfo) {
|
||||
const manifest = await this._readRaw(bmadDir);
|
||||
if (!manifest || !manifest.modules) {
|
||||
return;
|
||||
}
|
||||
|
||||
const index = manifest.modules.findIndex((m) => m.name === moduleName);
|
||||
if (index !== -1) {
|
||||
manifest.modules[index] = {
|
||||
...manifest.modules[index],
|
||||
...versionInfo,
|
||||
lastUpdated: new Date().toISOString(),
|
||||
};
|
||||
await this._writeRaw(bmadDir, manifest);
|
||||
}
|
||||
}
|
||||
|
||||
/**
|
||||
* Get version info for a specific module
|
||||
* @param {string} bmadDir - Path to bmad directory
|
||||
* @param {string} moduleName - Module name
|
||||
* @returns {Object|null} Module version info or null
|
||||
*/
|
||||
async getModuleVersion(bmadDir, moduleName) {
|
||||
const manifest = await this._readRaw(bmadDir);
|
||||
if (!manifest || !manifest.modules) {
|
||||
return null;
|
||||
}
|
||||
|
||||
return manifest.modules.find((m) => m.name === moduleName) || null;
|
||||
}
|
||||
|
||||
/**
|
||||
* Get all modules with their version info
|
||||
* @param {string} bmadDir - Path to bmad directory
|
||||
* @returns {Array} Array of module info objects
|
||||
*/
|
||||
async getAllModuleVersions(bmadDir) {
|
||||
const manifest = await this._readRaw(bmadDir);
|
||||
if (!manifest || !manifest.modules) {
|
||||
return [];
|
||||
}
|
||||
|
||||
return manifest.modules;
|
||||
}
|
||||
|
||||
/**
|
||||
* Write raw manifest data to file
|
||||
* @param {string} bmadDir - Path to bmad directory
|
||||
* @param {Object} manifestData - Raw manifest data to write
|
||||
*/
|
||||
async _writeRaw(bmadDir, manifestData) {
|
||||
const yaml = require('yaml');
|
||||
const manifestPath = path.join(bmadDir, '_config', 'manifest.yaml');
|
||||
|
||||
await fs.ensureDir(path.dirname(manifestPath));
|
||||
|
||||
const cleanManifestData = structuredClone(manifestData);
|
||||
|
||||
const yamlContent = yaml.stringify(cleanManifestData, {
|
||||
indent: 2,
|
||||
lineWidth: 0,
|
||||
sortKeys: false,
|
||||
});
|
||||
|
||||
const content = yamlContent.endsWith('\n') ? yamlContent : yamlContent + '\n';
|
||||
await fs.writeFile(manifestPath, content, 'utf8');
|
||||
}
|
||||
|
||||
/**
|
||||
* Add an IDE configuration to the manifest
|
||||
* @param {string} bmadDir - Path to bmad directory
|
||||
|
|
@ -585,6 +825,212 @@ class Manifest {
|
|||
await this.update(bmadDir, { customModules: manifest.customModules });
|
||||
}
|
||||
}
|
||||
|
||||
/**
|
||||
* Get module version info from source
|
||||
* @param {string} moduleName - Module name/code
|
||||
* @param {string} bmadDir - Path to bmad directory
|
||||
* @param {string} moduleSourcePath - Optional source path for custom modules
|
||||
* @returns {Object} Version info object with version, source, npmPackage, repoUrl
|
||||
*/
|
||||
async getModuleVersionInfo(moduleName, bmadDir, moduleSourcePath = null) {
|
||||
const os = require('node:os');
|
||||
|
||||
// Built-in modules use BMad version (only core and bmm are in BMAD-METHOD repo)
|
||||
if (['core', 'bmm'].includes(moduleName)) {
|
||||
const bmadVersion = require(path.join(getProjectRoot(), 'package.json')).version;
|
||||
return {
|
||||
version: bmadVersion,
|
||||
source: 'built-in',
|
||||
npmPackage: null,
|
||||
repoUrl: null,
|
||||
};
|
||||
}
|
||||
|
||||
// Check if this is an external official module
|
||||
const { ExternalModuleManager } = require('../modules/external-manager');
|
||||
const extMgr = new ExternalModuleManager();
|
||||
const moduleInfo = await extMgr.getModuleByCode(moduleName);
|
||||
|
||||
if (moduleInfo) {
|
||||
// External module - try to get version from npm registry first, then fall back to cache
|
||||
let version = null;
|
||||
|
||||
if (moduleInfo.npmPackage) {
|
||||
// Fetch version from npm registry
|
||||
try {
|
||||
version = await this.fetchNpmVersion(moduleInfo.npmPackage);
|
||||
} catch {
|
||||
// npm fetch failed, try cache as fallback
|
||||
}
|
||||
}
|
||||
|
||||
// If npm didn't work, try reading from cached repo's package.json
|
||||
if (!version) {
|
||||
const cacheDir = path.join(os.homedir(), '.bmad', 'cache', 'external-modules', moduleName);
|
||||
const packageJsonPath = path.join(cacheDir, 'package.json');
|
||||
|
||||
if (await fs.pathExists(packageJsonPath)) {
|
||||
try {
|
||||
const pkg = require(packageJsonPath);
|
||||
version = pkg.version;
|
||||
} catch (error) {
|
||||
console.warn(`Failed to read package.json for ${moduleName}: ${error.message}`);
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
return {
|
||||
version: version,
|
||||
source: 'external',
|
||||
npmPackage: moduleInfo.npmPackage || null,
|
||||
repoUrl: moduleInfo.url || null,
|
||||
};
|
||||
}
|
||||
|
||||
// Custom module - check cache directory
|
||||
const cacheDir = path.join(bmadDir, '_config', 'custom', moduleName);
|
||||
const moduleYamlPath = path.join(cacheDir, 'module.yaml');
|
||||
|
||||
if (await fs.pathExists(moduleYamlPath)) {
|
||||
try {
|
||||
const yamlContent = await fs.readFile(moduleYamlPath, 'utf8');
|
||||
const moduleConfig = yaml.parse(yamlContent);
|
||||
return {
|
||||
version: moduleConfig.version || null,
|
||||
source: 'custom',
|
||||
npmPackage: moduleConfig.npmPackage || null,
|
||||
repoUrl: moduleConfig.repoUrl || null,
|
||||
};
|
||||
} catch (error) {
|
||||
console.warn(`Failed to read module.yaml for ${moduleName}: ${error.message}`);
|
||||
}
|
||||
}
|
||||
|
||||
// Unknown module
|
||||
return {
|
||||
version: null,
|
||||
source: 'unknown',
|
||||
npmPackage: null,
|
||||
repoUrl: null,
|
||||
};
|
||||
}
|
||||
|
||||
/**
|
||||
* Fetch latest version from npm for a package
|
||||
* @param {string} packageName - npm package name
|
||||
* @returns {string|null} Latest version or null
|
||||
*/
|
||||
async fetchNpmVersion(packageName) {
|
||||
try {
|
||||
const https = require('node:https');
|
||||
const { execSync } = require('node:child_process');
|
||||
|
||||
// Try using npm view first (more reliable)
|
||||
try {
|
||||
const result = execSync(`npm view ${packageName} version`, {
|
||||
encoding: 'utf8',
|
||||
stdio: 'pipe',
|
||||
timeout: 10_000,
|
||||
});
|
||||
return result.trim();
|
||||
} catch {
|
||||
// Fallback to npm registry API
|
||||
return new Promise((resolve, reject) => {
|
||||
https
|
||||
.get(`https://registry.npmjs.org/${packageName}`, (res) => {
|
||||
let data = '';
|
||||
res.on('data', (chunk) => (data += chunk));
|
||||
res.on('end', () => {
|
||||
try {
|
||||
const pkg = JSON.parse(data);
|
||||
resolve(pkg['dist-tags']?.latest || pkg.version || null);
|
||||
} catch {
|
||||
resolve(null);
|
||||
}
|
||||
});
|
||||
})
|
||||
.on('error', () => resolve(null));
|
||||
});
|
||||
}
|
||||
} catch {
|
||||
return null;
|
||||
}
|
||||
}
|
||||
|
||||
/**
|
||||
* Check for available updates for installed modules
|
||||
* @param {string} bmadDir - Path to bmad directory
|
||||
* @returns {Array} Array of update info objects
|
||||
*/
|
||||
async checkForUpdates(bmadDir) {
|
||||
const modules = await this.getAllModuleVersions(bmadDir);
|
||||
const updates = [];
|
||||
|
||||
for (const module of modules) {
|
||||
if (!module.npmPackage) {
|
||||
continue; // Skip modules without npm package (built-in)
|
||||
}
|
||||
|
||||
const latestVersion = await this.fetchNpmVersion(module.npmPackage);
|
||||
if (!latestVersion) {
|
||||
continue;
|
||||
}
|
||||
|
||||
if (module.version !== latestVersion) {
|
||||
updates.push({
|
||||
name: module.name,
|
||||
installedVersion: module.version,
|
||||
latestVersion: latestVersion,
|
||||
npmPackage: module.npmPackage,
|
||||
updateAvailable: true,
|
||||
});
|
||||
}
|
||||
}
|
||||
|
||||
return updates;
|
||||
}
|
||||
|
||||
/**
|
||||
* Compare two semantic versions
|
||||
* @param {string} v1 - First version
|
||||
* @param {string} v2 - Second version
|
||||
* @returns {number} -1 if v1 < v2, 0 if v1 == v2, 1 if v1 > v2
|
||||
*/
|
||||
compareVersions(v1, v2) {
|
||||
if (!v1 || !v2) return 0;
|
||||
|
||||
const normalize = (v) => {
|
||||
// Remove leading 'v' if present
|
||||
v = v.replace(/^v/, '');
|
||||
// Handle prerelease tags
|
||||
const parts = v.split('-');
|
||||
const main = parts[0].split('.');
|
||||
const prerelease = parts[1];
|
||||
return { main, prerelease };
|
||||
};
|
||||
|
||||
const n1 = normalize(v1);
|
||||
const n2 = normalize(v2);
|
||||
|
||||
// Compare main version parts
|
||||
for (let i = 0; i < 3; i++) {
|
||||
const num1 = parseInt(n1.main[i] || '0', 10);
|
||||
const num2 = parseInt(n2.main[i] || '0', 10);
|
||||
if (num1 !== num2) {
|
||||
return num1 < num2 ? -1 : 1;
|
||||
}
|
||||
}
|
||||
|
||||
// If main versions are equal, compare prerelease
|
||||
if (n1.prerelease && n2.prerelease) {
|
||||
return n1.prerelease < n2.prerelease ? -1 : n1.prerelease > n2.prerelease ? 1 : 0;
|
||||
}
|
||||
if (n1.prerelease) return -1; // Prerelease is older than stable
|
||||
if (n2.prerelease) return 1; // Stable is newer than prerelease
|
||||
|
||||
return 0;
|
||||
}
|
||||
}
|
||||
|
||||
module.exports = { Manifest };
|
||||
|
|
|
|||
|
|
@ -2,9 +2,9 @@
|
|||
|
||||
## Overview
|
||||
|
||||
Standardize IDE installers to use **flat file naming** and centralize duplicated code in shared utilities.
|
||||
Standardize IDE installers to use **flat file naming** with **underscores** (Windows-compatible) and centralize duplicated code in shared utilities.
|
||||
|
||||
**Key Rule: Only folder-based IDEs convert to colon format. IDEs already using dashes keep using dashes.**
|
||||
**Key Rule: All IDEs use underscore format for Windows compatibility (colons don't work on Windows).**
|
||||
|
||||
## Current State Analysis
|
||||
|
||||
|
|
@ -15,10 +15,10 @@ Standardize IDE installers to use **flat file naming** and centralize duplicated
|
|||
| **claude-code** | Hierarchical | `.claude/commands/bmad/{module}/agents/{name}.md` |
|
||||
| **cursor** | Hierarchical | `.cursor/commands/bmad/{module}/agents/{name}.md` |
|
||||
| **crush** | Hierarchical | `.crush/commands/bmad/{module}/agents/{name}.md` |
|
||||
| **antigravity** | Flattened (dashes) | `.agent/workflows/bmad-module-agents-name.md` |
|
||||
| **codex** | Flattened (dashes) | `~/.codex/prompts/bmad-module-agents-name.md` |
|
||||
| **cline** | Flattened (dashes) | `.clinerules/workflows/bmad-module-type-name.md` |
|
||||
| **roo** | Flattened (dashes) | `.roo/commands/bmad-{module}-agent-{name}.md` |
|
||||
| **antigravity** | Flattened (underscores) | `.agent/workflows/bmad_module_agents_name.md` |
|
||||
| **codex** | Flattened (underscores) | `~/.codex/prompts/bmad_module_agents_name.md` |
|
||||
| **cline** | Flattened (underscores) | `.clinerules/workflows/bmad_module_type_name.md` |
|
||||
| **roo** | Flattened (underscores) | `.roo/commands/bmad_module_agent_name.md` |
|
||||
| **auggie** | Hybrid | `.augment/commands/bmad/agents/{module}-{name}.md` |
|
||||
| **iflow** | Hybrid | `.iflow/commands/bmad/agents/{module}-{name}.md` |
|
||||
| **trae** | Different (rules) | `.trae/rules/bmad-agent-{module}-{name}.md` |
|
||||
|
|
@ -40,35 +40,24 @@ All currently create artifacts with **nested relative paths** like `{module}/age
|
|||
|
||||
## Target Standardization
|
||||
|
||||
### For Folder-Based IDEs (convert to colon format)
|
||||
### For All IDEs (underscore format - Windows-compatible)
|
||||
|
||||
**IDEs affected:** claude-code, cursor, crush
|
||||
**IDEs affected:** claude-code, cursor, crush, antigravity, codex, cline, roo
|
||||
|
||||
```
|
||||
Format: bmad:{module}:{type}:{name}.md
|
||||
Format: bmad_{module}_{type}_{name}.md
|
||||
|
||||
Examples:
|
||||
- Agent: bmad:bmm:agents:pm.md
|
||||
- Agent: bmad:core:agents:dev.md
|
||||
- Workflow: bmad:bmm:workflows:correct-course.md
|
||||
- Task: bmad:bmm:tasks:bmad-help.md
|
||||
- Tool: bmad:core:tools:code-review.md
|
||||
- Custom: bmad:custom:agents:fred-commit-poet.md
|
||||
- Agent: bmad_bmm_agents_pm.md
|
||||
- Agent: bmad_core_agents_dev.md
|
||||
- Workflow: bmad_bmm_workflows_correct-course.md
|
||||
- Task: bmad_bmm_tasks_bmad-help.md
|
||||
- Tool: bmad_core_tools_code-review.md
|
||||
- Custom: bmad_custom_agents_fred-commit-poet.md
|
||||
```
|
||||
|
||||
### For Already-Flat IDEs (keep using dashes)
|
||||
|
||||
**IDEs affected:** antigravity, codex, cline, roo
|
||||
|
||||
```
|
||||
Format: bmad-{module}-{type}-{name}.md
|
||||
|
||||
Examples:
|
||||
- Agent: bmad-bmm-agents-pm.md
|
||||
- Workflow: bmad-bmm-workflows-correct-course.md
|
||||
- Task: bmad-bmm-tasks-bmad-help.md
|
||||
- Custom: bmad-custom-agents-fred-commit-poet.md
|
||||
```
|
||||
**Note:** Type segments (agents, workflows, tasks, tools) are filtered out from names:
|
||||
- `bmm/agents/pm.md` → `bmad_bmm_pm.md` (not `bmad_bmm_agents_pm.md`)
|
||||
|
||||
### For Hybrid IDEs (keep as-is)
|
||||
|
||||
|
|
@ -88,57 +77,50 @@ These use `{module}-{name}.md` format within subdirectories - keep as-is.
|
|||
|
||||
```javascript
|
||||
/**
|
||||
* Convert hierarchical path to flat colon-separated name (for folder-based IDEs)
|
||||
* Convert hierarchical path to flat underscore-separated name (Windows-compatible)
|
||||
* @param {string} module - Module name (e.g., 'bmm', 'core')
|
||||
* @param {string} type - Artifact type ('agents', 'workflows', 'tasks', 'tools')
|
||||
* @param {string} type - Artifact type ('agents', 'workflows', 'tasks', 'tools') - filtered out
|
||||
* @param {string} name - Artifact name (e.g., 'pm', 'correct-course')
|
||||
* @returns {string} Flat filename like 'bmad:bmm:agents:pm.md'
|
||||
* @returns {string} Flat filename like 'bmad_bmm_pm.md'
|
||||
*/
|
||||
function toColonName(module, type, name) {
|
||||
return `bmad:${module}:${type}:${name}.md`;
|
||||
function toUnderscoreName(module, type, name) {
|
||||
return `bmad_${module}_${name}.md`;
|
||||
}
|
||||
|
||||
/**
|
||||
* Convert relative path to flat colon-separated name (for folder-based IDEs)
|
||||
* Convert relative path to flat underscore-separated name (Windows-compatible)
|
||||
* @param {string} relativePath - Path like 'bmm/agents/pm.md'
|
||||
* @returns {string} Flat filename like 'bmad:bmm:agents:pm.md'
|
||||
* @returns {string} Flat filename like 'bmad_bmm_pm.md'
|
||||
*/
|
||||
function toColonPath(relativePath) {
|
||||
function toUnderscorePath(relativePath) {
|
||||
const withoutExt = relativePath.replace('.md', '');
|
||||
const parts = withoutExt.split(/[\/\\]/);
|
||||
return `bmad:${parts.join(':')}.md`;
|
||||
// Filter out type segments (agents, workflows, tasks, tools)
|
||||
const filtered = parts.filter((p) => !TYPE_SEGMENTS.includes(p));
|
||||
return `bmad_${filtered.join('_')}.md`;
|
||||
}
|
||||
|
||||
/**
|
||||
* Convert hierarchical path to flat dash-separated name (for flat IDEs)
|
||||
* @param {string} relativePath - Path like 'bmm/agents/pm.md'
|
||||
* @returns {string} Flat filename like 'bmad-bmm-agents-pm.md'
|
||||
*/
|
||||
function toDashPath(relativePath) {
|
||||
const withoutExt = relativePath.replace('.md', '');
|
||||
const parts = withoutExt.split(/[\/\\]/);
|
||||
return `bmad-${parts.join('-')}.md`;
|
||||
}
|
||||
|
||||
/**
|
||||
* Create custom agent colon name
|
||||
* Create custom agent underscore name
|
||||
* @param {string} agentName - Custom agent name
|
||||
* @returns {string} Flat filename like 'bmad:custom:agents:fred-commit-poet.md'
|
||||
* @returns {string} Flat filename like 'bmad_custom_fred-commit-poet.md'
|
||||
*/
|
||||
function customAgentColonName(agentName) {
|
||||
return `bmad:custom:agents:${agentName}.md`;
|
||||
function customAgentUnderscoreName(agentName) {
|
||||
return `bmad_custom_${agentName}.md`;
|
||||
}
|
||||
|
||||
/**
|
||||
* Create custom agent dash name
|
||||
* @param {string} agentName - Custom agent name
|
||||
* @returns {string} Flat filename like 'bmad-custom-agents-fred-commit-poet.md'
|
||||
*/
|
||||
function customAgentDashName(agentName) {
|
||||
return `bmad-custom-agents-${agentName}.md`;
|
||||
}
|
||||
// Backward compatibility aliases
|
||||
const toColonName = toUnderscoreName;
|
||||
const toColonPath = toUnderscorePath;
|
||||
const toDashPath = toUnderscorePath;
|
||||
const customAgentColonName = customAgentUnderscoreName;
|
||||
const customAgentDashName = customAgentUnderscoreName;
|
||||
|
||||
module.exports = {
|
||||
toUnderscoreName,
|
||||
toUnderscorePath,
|
||||
customAgentUnderscoreName,
|
||||
// Backward compatibility
|
||||
toColonName,
|
||||
toColonPath,
|
||||
toDashPath,
|
||||
|
|
@ -157,34 +139,26 @@ module.exports = {
|
|||
**Changes:**
|
||||
1. Import path utilities
|
||||
2. Change `relativePath` to use flat format
|
||||
3. Add method `writeColonArtifacts()` for folder-based IDEs
|
||||
4. Add method `writeDashArtifacts()` for flat IDEs
|
||||
3. Add method `writeColonArtifacts()` for folder-based IDEs (uses underscore)
|
||||
4. Add method `writeDashArtifacts()` for flat IDEs (uses underscore)
|
||||
|
||||
### Phase 3: Update Folder-Based IDEs
|
||||
### Phase 3: Update All IDEs
|
||||
|
||||
**Files to modify:**
|
||||
- `claude-code.js`
|
||||
- `cursor.js`
|
||||
- `crush.js`
|
||||
|
||||
**Changes:**
|
||||
1. Import `toColonPath`, `customAgentColonName` from path-utils
|
||||
2. Change from hierarchical to flat colon naming
|
||||
3. Update cleanup to handle flat structure
|
||||
|
||||
### Phase 4: Update Flat IDEs
|
||||
|
||||
**Files to modify:**
|
||||
- `antigravity.js`
|
||||
- `codex.js`
|
||||
- `cline.js`
|
||||
- `roo.js`
|
||||
|
||||
**Changes:**
|
||||
1. Import `toDashPath`, `customAgentDashName` from path-utils
|
||||
2. Replace local `flattenFilename()` with shared `toDashPath()`
|
||||
1. Import utilities from path-utils
|
||||
2. Change from hierarchical to flat underscore naming
|
||||
3. Update cleanup to handle flat structure (`startsWith('bmad')`)
|
||||
|
||||
### Phase 5: Update Base Class
|
||||
### Phase 4: Update Base Class
|
||||
|
||||
**File:** `_base-ide.js`
|
||||
|
||||
|
|
@ -195,24 +169,23 @@ module.exports = {
|
|||
## Migration Checklist
|
||||
|
||||
### New Files
|
||||
- [ ] Create `shared/path-utils.js`
|
||||
- [x] Create `shared/path-utils.js`
|
||||
|
||||
### Folder-Based IDEs (convert to colon format)
|
||||
- [ ] Update `shared/agent-command-generator.js` - add `writeColonArtifacts()`
|
||||
- [ ] Update `shared/task-tool-command-generator.js` - add `writeColonArtifacts()`
|
||||
- [ ] Update `shared/workflow-command-generator.js` - add `writeColonArtifacts()`
|
||||
- [ ] Update `claude-code.js` - convert to colon format
|
||||
- [ ] Update `cursor.js` - convert to colon format
|
||||
- [ ] Update `crush.js` - convert to colon format
|
||||
### All IDEs (convert to underscore format)
|
||||
- [x] Update `shared/agent-command-generator.js` - update for underscore
|
||||
- [x] Update `shared/task-tool-command-generator.js` - update for underscore
|
||||
- [x] Update `shared/workflow-command-generator.js` - update for underscore
|
||||
- [x] Update `claude-code.js` - convert to underscore format
|
||||
- [x] Update `cursor.js` - convert to underscore format
|
||||
- [x] Update `crush.js` - convert to underscore format
|
||||
- [ ] Update `antigravity.js` - use underscore format
|
||||
- [ ] Update `codex.js` - use underscore format
|
||||
- [ ] Update `cline.js` - use underscore format
|
||||
- [ ] Update `roo.js` - use underscore format
|
||||
|
||||
### Flat IDEs (standardize dash format)
|
||||
- [ ] Update `shared/agent-command-generator.js` - add `writeDashArtifacts()`
|
||||
- [ ] Update `shared/task-tool-command-generator.js` - add `writeDashArtifacts()`
|
||||
- [ ] Update `shared/workflow-command-generator.js` - add `writeDashArtifacts()`
|
||||
- [ ] Update `antigravity.js` - use shared `toDashPath()`
|
||||
- [ ] Update `codex.js` - use shared `toDashPath()`
|
||||
- [ ] Update `cline.js` - use shared `toDashPath()`
|
||||
- [ ] Update `roo.js` - use shared `toDashPath()`
|
||||
### CSV Command Files
|
||||
- [x] Update `src/core/module-help.csv` - change colons to underscores
|
||||
- [x] Update `src/bmm/module-help.csv` - change colons to underscores
|
||||
|
||||
### Base Class
|
||||
- [ ] Update `_base-ide.js` - add deprecation notice
|
||||
|
|
@ -228,7 +201,8 @@ module.exports = {
|
|||
|
||||
## Notes
|
||||
|
||||
1. **Keep segments**: agents, workflows, tasks, tools all become part of the flat name
|
||||
2. **Colon vs Dash**: Colons for folder-based IDEs converting to flat, dashes for already-flat IDEs
|
||||
1. **Filter type segments**: agents, workflows, tasks, tools are filtered out from flat names
|
||||
2. **Underscore format**: Universal underscore format for Windows compatibility
|
||||
3. **Custom agents**: Follow the same pattern as regular agents
|
||||
4. **Backward compatibility**: Cleanup will remove old folder structure
|
||||
4. **Backward compatibility**: Old function names kept as aliases
|
||||
5. **Cleanup**: Will remove old `bmad:` format files on next install
|
||||
|
|
|
|||
|
|
@ -127,8 +127,8 @@ class AntigravitySetup extends BaseIdeSetup {
|
|||
const { artifacts: agentArtifacts, counts: agentCounts } = await agentGen.collectAgentArtifacts(bmadDir, options.selectedModules || []);
|
||||
|
||||
// Write agent launcher files with FLATTENED naming using shared utility
|
||||
// Antigravity ignores directory structure, so we flatten to: bmad-module-name.md
|
||||
// This creates slash commands like /bmad-bmm-dev instead of /dev
|
||||
// Antigravity ignores directory structure, so we flatten to: bmad_module_name.md
|
||||
// This creates slash commands like /bmad_bmm_dev instead of /dev
|
||||
const agentCount = await agentGen.writeDashArtifacts(bmadWorkflowsDir, agentArtifacts);
|
||||
|
||||
// Process Antigravity specific injections for installed modules
|
||||
|
|
@ -167,7 +167,7 @@ class AntigravitySetup extends BaseIdeSetup {
|
|||
);
|
||||
}
|
||||
console.log(chalk.dim(` - Workflows directory: ${path.relative(projectDir, bmadWorkflowsDir)}`));
|
||||
console.log(chalk.yellow(`\n Note: Antigravity uses flattened slash commands (e.g., /bmad-module-agents-name)`));
|
||||
console.log(chalk.yellow(`\n Note: Antigravity uses flattened slash commands (e.g., /bmad_module_agents_name)`));
|
||||
|
||||
return {
|
||||
success: true,
|
||||
|
|
@ -455,7 +455,7 @@ usage: |
|
|||
|
||||
⚠️ **IMPORTANT**: Run @${agentPath} to load the complete agent before using this launcher!`;
|
||||
|
||||
// Use dash format: bmad-custom-agents-fred-commit-poet.md
|
||||
// Use underscore format: bmad_custom_fred-commit-poet.md
|
||||
const fileName = customAgentDashName(agentName);
|
||||
const launcherPath = path.join(bmadWorkflowsDir, fileName);
|
||||
|
||||
|
|
|
|||
|
|
@ -92,12 +92,12 @@ class ClaudeCodeSetup extends BaseIdeSetup {
|
|||
async cleanup(projectDir) {
|
||||
const commandsDir = path.join(projectDir, this.configDir, this.commandsDir);
|
||||
|
||||
// Remove any bmad:* files from the commands directory
|
||||
// Remove any bmad* files from the commands directory (cleans up old bmad: and bmad- formats)
|
||||
if (await fs.pathExists(commandsDir)) {
|
||||
const entries = await fs.readdir(commandsDir);
|
||||
let removedCount = 0;
|
||||
for (const entry of entries) {
|
||||
if (entry.startsWith('bmad:')) {
|
||||
if (entry.startsWith('bmad')) {
|
||||
await fs.remove(path.join(commandsDir, entry));
|
||||
removedCount++;
|
||||
}
|
||||
|
|
@ -151,16 +151,16 @@ class ClaudeCodeSetup extends BaseIdeSetup {
|
|||
const commandsDir = path.join(claudeDir, this.commandsDir);
|
||||
await this.ensureDir(commandsDir);
|
||||
|
||||
// Use colon format: files written directly to commands dir (no bmad subfolder)
|
||||
// Creates: .claude/commands/bmad:bmm:pm.md
|
||||
// Use underscore format: files written directly to commands dir (no bmad subfolder)
|
||||
// Creates: .claude/commands/bmad_bmm_pm.md
|
||||
|
||||
// Generate agent launchers using AgentCommandGenerator
|
||||
// This creates small launcher files that reference the actual agents in _bmad/
|
||||
const agentGen = new AgentCommandGenerator(this.bmadFolderName);
|
||||
const { artifacts: agentArtifacts, counts: agentCounts } = await agentGen.collectAgentArtifacts(bmadDir, options.selectedModules || []);
|
||||
|
||||
// Write agent launcher files using flat colon naming
|
||||
// Creates files like: bmad:bmm:pm.md
|
||||
// Write agent launcher files using flat underscore naming
|
||||
// Creates files like: bmad_bmm_pm.md
|
||||
const agentCount = await agentGen.writeColonArtifacts(commandsDir, agentArtifacts);
|
||||
|
||||
// Process Claude Code specific injections for installed modules
|
||||
|
|
@ -182,8 +182,8 @@ class ClaudeCodeSetup extends BaseIdeSetup {
|
|||
const workflowGen = new WorkflowCommandGenerator(this.bmadFolderName);
|
||||
const { artifacts: workflowArtifacts } = await workflowGen.collectWorkflowArtifacts(bmadDir);
|
||||
|
||||
// Write workflow-command artifacts using flat colon naming
|
||||
// Creates files like: bmad:bmm:correct-course.md
|
||||
// Write workflow-command artifacts using flat underscore naming
|
||||
// Creates files like: bmad_bmm_correct-course.md
|
||||
const workflowCommandCount = await workflowGen.writeColonArtifacts(commandsDir, workflowArtifacts);
|
||||
|
||||
// Generate task and tool commands from manifests (if they exist)
|
||||
|
|
@ -490,7 +490,7 @@ You must fully embody this agent's persona and follow all activation instruction
|
|||
</agent-activation>
|
||||
`;
|
||||
|
||||
// Use colon format: bmad:custom:agents:fred-commit-poet.md
|
||||
// Use underscore format: bmad_custom_fred-commit-poet.md
|
||||
// Written directly to commands dir (no bmad subfolder)
|
||||
const launcherName = customAgentColonName(agentName);
|
||||
const launcherPath = path.join(commandsDir, launcherName);
|
||||
|
|
|
|||
|
|
@ -57,8 +57,8 @@ class ClineSetup extends BaseIdeSetup {
|
|||
console.log(chalk.cyan(' BMAD workflows are available as slash commands in Cline'));
|
||||
console.log(chalk.dim(' Usage:'));
|
||||
console.log(chalk.dim(' - Type / to see available commands'));
|
||||
console.log(chalk.dim(' - All BMAD items start with "bmad-"'));
|
||||
console.log(chalk.dim(' - Example: /bmad-bmm-pm'));
|
||||
console.log(chalk.dim(' - All BMAD items start with "bmad_"'));
|
||||
console.log(chalk.dim(' - Example: /bmad_bmm_pm'));
|
||||
|
||||
return {
|
||||
success: true,
|
||||
|
|
@ -81,7 +81,7 @@ class ClineSetup extends BaseIdeSetup {
|
|||
}
|
||||
|
||||
const entries = await fs.readdir(workflowsDir);
|
||||
return entries.some((entry) => entry.startsWith('bmad-'));
|
||||
return entries.some((entry) => entry.startsWith('bmad'));
|
||||
}
|
||||
|
||||
/**
|
||||
|
|
@ -146,7 +146,7 @@ class ClineSetup extends BaseIdeSetup {
|
|||
}
|
||||
|
||||
/**
|
||||
* Flatten file path to bmad-module-type-name.md format
|
||||
* Flatten file path to bmad_module_type_name.md format
|
||||
* Uses shared toDashPath utility
|
||||
*/
|
||||
flattenFilename(relativePath) {
|
||||
|
|
@ -180,7 +180,7 @@ class ClineSetup extends BaseIdeSetup {
|
|||
const entries = await fs.readdir(destDir);
|
||||
|
||||
for (const entry of entries) {
|
||||
if (!entry.startsWith('bmad-')) {
|
||||
if (!entry.startsWith('bmad')) {
|
||||
continue;
|
||||
}
|
||||
|
||||
|
|
@ -246,7 +246,7 @@ The agent will follow the persona and instructions from the main agent file.
|
|||
|
||||
*Generated by BMAD Method*`;
|
||||
|
||||
// Use dash format: bmad-custom-agents-fred-commit-poet.md
|
||||
// Use underscore format: bmad_custom_fred-commit-poet.md
|
||||
const fileName = customAgentDashName(agentName);
|
||||
const launcherPath = path.join(workflowsDir, fileName);
|
||||
|
||||
|
|
|
|||
|
|
@ -86,7 +86,7 @@ class CodexSetup extends BaseIdeSetup {
|
|||
await fs.ensureDir(destDir);
|
||||
await this.clearOldBmadFiles(destDir);
|
||||
|
||||
// Collect artifacts and write using DASH format
|
||||
// Collect artifacts and write using underscore format
|
||||
const agentGen = new AgentCommandGenerator(this.bmadFolderName);
|
||||
const { artifacts: agentArtifacts } = await agentGen.collectAgentArtifacts(bmadDir, options.selectedModules || []);
|
||||
const agentCount = await agentGen.writeDashArtifacts(destDir, agentArtifacts);
|
||||
|
|
@ -115,7 +115,7 @@ class CodexSetup extends BaseIdeSetup {
|
|||
const { artifacts: workflowArtifacts } = await workflowGenerator.collectWorkflowArtifacts(bmadDir);
|
||||
const workflowCount = await workflowGenerator.writeDashArtifacts(destDir, workflowArtifacts);
|
||||
|
||||
// Also write tasks using dash format
|
||||
// Also write tasks using underscore format
|
||||
const ttGen = new TaskToolCommandGenerator();
|
||||
const tasksWritten = await ttGen.writeDashArtifacts(destDir, taskArtifacts);
|
||||
|
||||
|
|
@ -155,7 +155,7 @@ class CodexSetup extends BaseIdeSetup {
|
|||
// Check global location
|
||||
if (await fs.pathExists(globalDir)) {
|
||||
const entries = await fs.readdir(globalDir);
|
||||
if (entries.some((entry) => entry.startsWith('bmad-'))) {
|
||||
if (entries.some((entry) => entry.startsWith('bmad'))) {
|
||||
return true;
|
||||
}
|
||||
}
|
||||
|
|
@ -163,7 +163,7 @@ class CodexSetup extends BaseIdeSetup {
|
|||
// Check project-specific location
|
||||
if (await fs.pathExists(projectSpecificDir)) {
|
||||
const entries = await fs.readdir(projectSpecificDir);
|
||||
if (entries.some((entry) => entry.startsWith('bmad-'))) {
|
||||
if (entries.some((entry) => entry.startsWith('bmad'))) {
|
||||
return true;
|
||||
}
|
||||
}
|
||||
|
|
@ -256,7 +256,7 @@ class CodexSetup extends BaseIdeSetup {
|
|||
const entries = await fs.readdir(destDir);
|
||||
|
||||
for (const entry of entries) {
|
||||
if (!entry.startsWith('bmad-')) {
|
||||
if (!entry.startsWith('bmad')) {
|
||||
continue;
|
||||
}
|
||||
|
||||
|
|
@ -292,7 +292,7 @@ class CodexSetup extends BaseIdeSetup {
|
|||
chalk.dim(" To use with other projects, you'd need to copy the _bmad dir"),
|
||||
'',
|
||||
chalk.green(' ✓ You can now use /commands in Codex CLI'),
|
||||
chalk.dim(' Example: /bmad-bmm-pm'),
|
||||
chalk.dim(' Example: /bmad_bmm_pm'),
|
||||
chalk.dim(' Type / to see all available commands'),
|
||||
'',
|
||||
chalk.bold.cyan('═'.repeat(70)),
|
||||
|
|
@ -397,7 +397,7 @@ You must fully embody this agent's persona and follow all activation instruction
|
|||
</agent-activation>
|
||||
`;
|
||||
|
||||
// Use dash format: bmad-custom-agents-fred-commit-poet.md
|
||||
// Use underscore format: bmad_custom_fred-commit-poet.md
|
||||
const fileName = customAgentDashName(agentName);
|
||||
const launcherPath = path.join(destDir, fileName);
|
||||
await fs.writeFile(launcherPath, launcherContent, 'utf8');
|
||||
|
|
|
|||
|
|
@ -35,26 +35,26 @@ class CrushSetup extends BaseIdeSetup {
|
|||
const commandsDir = path.join(crushDir, this.commandsDir);
|
||||
await this.ensureDir(commandsDir);
|
||||
|
||||
// Use colon format: files written directly to commands dir (no bmad subfolder)
|
||||
// Creates: .crush/commands/bmad:bmm:pm.md
|
||||
// Use underscore format: files written directly to commands dir (no bmad subfolder)
|
||||
// Creates: .crush/commands/bmad_bmm_pm.md
|
||||
|
||||
// Generate agent launchers
|
||||
const agentGen = new AgentCommandGenerator(this.bmadFolderName);
|
||||
const { artifacts: agentArtifacts } = await agentGen.collectAgentArtifacts(bmadDir, options.selectedModules || []);
|
||||
|
||||
// Write agent launcher files using flat colon naming
|
||||
// Creates files like: bmad:bmm:pm.md
|
||||
// Write agent launcher files using flat underscore naming
|
||||
// Creates files like: bmad_bmm_pm.md
|
||||
const agentCount = await agentGen.writeColonArtifacts(commandsDir, agentArtifacts);
|
||||
|
||||
// Get ALL workflows using the new workflow command generator
|
||||
const workflowGenerator = new WorkflowCommandGenerator(this.bmadFolderName);
|
||||
const { artifacts: workflowArtifacts } = await workflowGenerator.collectWorkflowArtifacts(bmadDir);
|
||||
|
||||
// Write workflow-command artifacts using flat colon naming
|
||||
// Creates files like: bmad:bmm:correct-course.md
|
||||
// Write workflow-command artifacts using flat underscore naming
|
||||
// Creates files like: bmad_bmm_correct-course.md
|
||||
const workflowCount = await workflowGenerator.writeColonArtifacts(commandsDir, workflowArtifacts);
|
||||
|
||||
// Generate task and tool commands using flat colon naming
|
||||
// Generate task and tool commands using flat underscore naming
|
||||
const taskToolGen = new TaskToolCommandGenerator();
|
||||
const taskToolResult = await taskToolGen.generateColonTaskToolCommands(projectDir, bmadDir, commandsDir);
|
||||
|
||||
|
|
@ -81,11 +81,11 @@ class CrushSetup extends BaseIdeSetup {
|
|||
async cleanup(projectDir) {
|
||||
const commandsDir = path.join(projectDir, this.configDir, this.commandsDir);
|
||||
|
||||
// Remove any bmad:* files from the commands directory
|
||||
// Remove any bmad* files from the commands directory (cleans up old bmad: and bmad- formats)
|
||||
if (await fs.pathExists(commandsDir)) {
|
||||
const entries = await fs.readdir(commandsDir);
|
||||
for (const entry of entries) {
|
||||
if (entry.startsWith('bmad:')) {
|
||||
if (entry.startsWith('bmad')) {
|
||||
await fs.remove(path.join(commandsDir, entry));
|
||||
}
|
||||
}
|
||||
|
|
@ -129,7 +129,7 @@ The agent will follow the persona and instructions from the main agent file.
|
|||
|
||||
*Generated by BMAD Method*`;
|
||||
|
||||
// Use colon format: bmad:custom:agents:fred-commit-poet.md
|
||||
// Use underscore format: bmad_custom_fred-commit-poet.md
|
||||
// Written directly to commands dir (no bmad subfolder)
|
||||
const launcherName = customAgentColonName(agentName);
|
||||
const launcherPath = path.join(commandsDir, launcherName);
|
||||
|
|
|
|||
|
|
@ -25,11 +25,11 @@ class CursorSetup extends BaseIdeSetup {
|
|||
const fs = require('fs-extra');
|
||||
const commandsDir = path.join(projectDir, this.configDir, this.commandsDir);
|
||||
|
||||
// Remove any bmad:* files from the commands directory
|
||||
// Remove any bmad* files from the commands directory (cleans up old bmad: and bmad- formats)
|
||||
if (await fs.pathExists(commandsDir)) {
|
||||
const entries = await fs.readdir(commandsDir);
|
||||
for (const entry of entries) {
|
||||
if (entry.startsWith('bmad:')) {
|
||||
if (entry.startsWith('bmad')) {
|
||||
await fs.remove(path.join(commandsDir, entry));
|
||||
}
|
||||
}
|
||||
|
|
@ -59,24 +59,24 @@ class CursorSetup extends BaseIdeSetup {
|
|||
const commandsDir = path.join(cursorDir, this.commandsDir);
|
||||
await this.ensureDir(commandsDir);
|
||||
|
||||
// Use colon format: files written directly to commands dir (no bmad subfolder)
|
||||
// Creates: .cursor/commands/bmad:bmm:pm.md
|
||||
// Use underscore format: files written directly to commands dir (no bmad subfolder)
|
||||
// Creates: .cursor/commands/bmad_bmm_pm.md
|
||||
|
||||
// Generate agent launchers using AgentCommandGenerator
|
||||
// This creates small launcher files that reference the actual agents in _bmad/
|
||||
const agentGen = new AgentCommandGenerator(this.bmadFolderName);
|
||||
const { artifacts: agentArtifacts, counts: agentCounts } = await agentGen.collectAgentArtifacts(bmadDir, options.selectedModules || []);
|
||||
|
||||
// Write agent launcher files using flat colon naming
|
||||
// Creates files like: bmad:bmm:pm.md
|
||||
// Write agent launcher files using flat underscore naming
|
||||
// Creates files like: bmad_bmm_pm.md
|
||||
const agentCount = await agentGen.writeColonArtifacts(commandsDir, agentArtifacts);
|
||||
|
||||
// Generate workflow commands from manifest (if it exists)
|
||||
const workflowGen = new WorkflowCommandGenerator(this.bmadFolderName);
|
||||
const { artifacts: workflowArtifacts } = await workflowGen.collectWorkflowArtifacts(bmadDir);
|
||||
|
||||
// Write workflow-command artifacts using flat colon naming
|
||||
// Creates files like: bmad:bmm:correct-course.md
|
||||
// Write workflow-command artifacts using flat underscore naming
|
||||
// Creates files like: bmad_bmm_correct-course.md
|
||||
const workflowCommandCount = await workflowGen.writeColonArtifacts(commandsDir, workflowArtifacts);
|
||||
|
||||
// Generate task and tool commands from manifests (if they exist)
|
||||
|
|
@ -144,7 +144,7 @@ description: '${agentName} agent'
|
|||
${launcherContent}
|
||||
`;
|
||||
|
||||
// Use colon format: bmad:custom:agents:fred-commit-poet.md
|
||||
// Use underscore format: bmad_custom_fred-commit-poet.md
|
||||
// Written directly to commands dir (no bmad subfolder)
|
||||
const launcherName = customAgentColonName(agentName);
|
||||
const launcherPath = path.join(commandsDir, launcherName);
|
||||
|
|
|
|||
|
|
@ -86,7 +86,7 @@ class GeminiSetup extends BaseIdeSetup {
|
|||
await this.writeFile(tomlPath, tomlContent);
|
||||
agentCount++;
|
||||
|
||||
console.log(chalk.green(` ✓ Added agent: /bmad:agents:${artifact.module}:${artifact.name}`));
|
||||
console.log(chalk.green(` ✓ Added agent: /bmad_agents_${artifact.module}_${artifact.name}`));
|
||||
}
|
||||
|
||||
// Install tasks as TOML files with bmad- prefix (flat structure)
|
||||
|
|
@ -100,7 +100,7 @@ class GeminiSetup extends BaseIdeSetup {
|
|||
await this.writeFile(tomlPath, tomlContent);
|
||||
taskCount++;
|
||||
|
||||
console.log(chalk.green(` ✓ Added task: /bmad:tasks:${task.module}:${task.name}`));
|
||||
console.log(chalk.green(` ✓ Added task: /bmad_tasks_${task.module}_${task.name}`));
|
||||
}
|
||||
|
||||
// Install workflows as TOML files with bmad- prefix (flat structure)
|
||||
|
|
@ -116,7 +116,7 @@ class GeminiSetup extends BaseIdeSetup {
|
|||
await this.writeFile(tomlPath, tomlContent);
|
||||
workflowCount++;
|
||||
|
||||
console.log(chalk.green(` ✓ Added workflow: /bmad:workflows:${artifact.module}:${workflowName}`));
|
||||
console.log(chalk.green(` ✓ Added workflow: /bmad_workflows_${artifact.module}_${workflowName}`));
|
||||
}
|
||||
}
|
||||
|
||||
|
|
@ -125,9 +125,9 @@ class GeminiSetup extends BaseIdeSetup {
|
|||
console.log(chalk.dim(` - ${taskCount} tasks configured`));
|
||||
console.log(chalk.dim(` - ${workflowCount} workflows configured`));
|
||||
console.log(chalk.dim(` - Commands directory: ${path.relative(projectDir, commandsDir)}`));
|
||||
console.log(chalk.dim(` - Agent activation: /bmad:agents:{agent-name}`));
|
||||
console.log(chalk.dim(` - Task activation: /bmad:tasks:{task-name}`));
|
||||
console.log(chalk.dim(` - Workflow activation: /bmad:workflows:{workflow-name}`));
|
||||
console.log(chalk.dim(` - Agent activation: /bmad_agents_{agent-name}`));
|
||||
console.log(chalk.dim(` - Task activation: /bmad_tasks_{task-name}`));
|
||||
console.log(chalk.dim(` - Workflow activation: /bmad_workflows_{workflow-name}`));
|
||||
|
||||
return {
|
||||
success: true,
|
||||
|
|
@ -233,12 +233,12 @@ ${contentWithoutFrontmatter}
|
|||
const commandsDir = path.join(projectDir, this.configDir, this.commandsDir);
|
||||
|
||||
if (await fs.pathExists(commandsDir)) {
|
||||
// Only remove files that start with bmad- prefix
|
||||
// Remove any bmad* files (cleans up old bmad- and bmad: formats)
|
||||
const files = await fs.readdir(commandsDir);
|
||||
let removed = 0;
|
||||
|
||||
for (const file of files) {
|
||||
if (file.startsWith('bmad-') && file.endsWith('.toml')) {
|
||||
if (file.startsWith('bmad') && file.endsWith('.toml')) {
|
||||
await fs.remove(path.join(commandsDir, file));
|
||||
removed++;
|
||||
}
|
||||
|
|
|
|||
|
|
@ -275,7 +275,7 @@ ${cleanContent}
|
|||
let removed = 0;
|
||||
|
||||
for (const file of files) {
|
||||
if (file.startsWith('bmad-') && file.endsWith('.chatmode.md')) {
|
||||
if (file.startsWith('bmad') && file.endsWith('.chatmode.md')) {
|
||||
await fs.remove(path.join(chatmodesDir, file));
|
||||
removed++;
|
||||
}
|
||||
|
|
|
|||
|
|
@ -25,7 +25,7 @@ class KiroCliSetup extends BaseIdeSetup {
|
|||
// Remove existing BMad agents
|
||||
const files = await fs.readdir(bmadAgentsDir);
|
||||
for (const file of files) {
|
||||
if (file.startsWith('bmad-') || file.includes('bmad')) {
|
||||
if (file.startsWith('bmad')) {
|
||||
await fs.remove(path.join(bmadAgentsDir, file));
|
||||
}
|
||||
}
|
||||
|
|
|
|||
|
|
@ -185,7 +185,7 @@ class OpenCodeSetup extends BaseIdeSetup {
|
|||
if (await fs.pathExists(agentsDir)) {
|
||||
const files = await fs.readdir(agentsDir);
|
||||
for (const file of files) {
|
||||
if (file.startsWith('bmad-') && file.endsWith('.md')) {
|
||||
if (file.startsWith('bmad') && file.endsWith('.md')) {
|
||||
await fs.remove(path.join(agentsDir, file));
|
||||
removed++;
|
||||
}
|
||||
|
|
@ -196,7 +196,7 @@ class OpenCodeSetup extends BaseIdeSetup {
|
|||
if (await fs.pathExists(commandsDir)) {
|
||||
const files = await fs.readdir(commandsDir);
|
||||
for (const file of files) {
|
||||
if (file.startsWith('bmad-') && file.endsWith('.md')) {
|
||||
if (file.startsWith('bmad') && file.endsWith('.md')) {
|
||||
await fs.remove(path.join(commandsDir, file));
|
||||
removed++;
|
||||
}
|
||||
|
|
|
|||
|
|
@ -74,7 +74,7 @@ class QwenSetup extends BaseIdeSetup {
|
|||
await this.writeFile(targetPath, tomlContent);
|
||||
|
||||
agentCount++;
|
||||
console.log(chalk.green(` ✓ Added agent: /bmad:${artifact.module}:agents:${artifact.name}`));
|
||||
console.log(chalk.green(` ✓ Added agent: /bmad_${artifact.module}_agents_${artifact.name}`));
|
||||
}
|
||||
|
||||
// Create TOML files for each task
|
||||
|
|
@ -90,7 +90,7 @@ class QwenSetup extends BaseIdeSetup {
|
|||
await this.writeFile(targetPath, content);
|
||||
|
||||
taskCount++;
|
||||
console.log(chalk.green(` ✓ Added task: /bmad:${task.module}:tasks:${task.name}`));
|
||||
console.log(chalk.green(` ✓ Added task: /bmad_${task.module}_tasks_${task.name}`));
|
||||
}
|
||||
|
||||
// Create TOML files for each tool
|
||||
|
|
@ -106,7 +106,7 @@ class QwenSetup extends BaseIdeSetup {
|
|||
await this.writeFile(targetPath, content);
|
||||
|
||||
toolCount++;
|
||||
console.log(chalk.green(` ✓ Added tool: /bmad:${tool.module}:tools:${tool.name}`));
|
||||
console.log(chalk.green(` ✓ Added tool: /bmad_${tool.module}_tools_${tool.name}`));
|
||||
}
|
||||
|
||||
// Create TOML files for each workflow
|
||||
|
|
@ -122,7 +122,7 @@ class QwenSetup extends BaseIdeSetup {
|
|||
await this.writeFile(targetPath, content);
|
||||
|
||||
workflowCount++;
|
||||
console.log(chalk.green(` ✓ Added workflow: /bmad:${workflow.module}:workflows:${workflow.name}`));
|
||||
console.log(chalk.green(` ✓ Added workflow: /bmad_${workflow.module}_workflows_${workflow.name}`));
|
||||
}
|
||||
|
||||
console.log(chalk.green(`✓ ${this.name} configured:`));
|
||||
|
|
|
|||
|
|
@ -36,7 +36,7 @@ class RooSetup extends BaseIdeSetup {
|
|||
let skippedCount = 0;
|
||||
|
||||
for (const artifact of agentArtifacts) {
|
||||
// Use shared toDashPath to get consistent naming: bmad-bmm-name.md
|
||||
// Use shared toDashPath to get consistent naming: bmad_bmm_name.md
|
||||
const commandName = toDashPath(artifact.relativePath).replace('.md', '');
|
||||
const commandPath = path.join(rooCommandsDir, `${commandName}.md`);
|
||||
|
||||
|
|
@ -169,7 +169,7 @@ class RooSetup extends BaseIdeSetup {
|
|||
let removedCount = 0;
|
||||
|
||||
for (const file of files) {
|
||||
if (file.startsWith('bmad-') && file.endsWith('.md')) {
|
||||
if (file.startsWith('bmad') && file.endsWith('.md')) {
|
||||
await fs.remove(path.join(rooCommandsDir, file));
|
||||
removedCount++;
|
||||
}
|
||||
|
|
@ -192,7 +192,7 @@ class RooSetup extends BaseIdeSetup {
|
|||
let removedCount = 0;
|
||||
|
||||
for (const line of lines) {
|
||||
if (/^\s*- slug: bmad-/.test(line)) {
|
||||
if (/^\s*- slug: bmad/.test(line)) {
|
||||
skipMode = true;
|
||||
removedCount++;
|
||||
} else if (skipMode && /^\s*- slug: /.test(line)) {
|
||||
|
|
@ -224,7 +224,7 @@ class RooSetup extends BaseIdeSetup {
|
|||
const rooCommandsDir = path.join(projectDir, this.configDir, this.commandsDir);
|
||||
await this.ensureDir(rooCommandsDir);
|
||||
|
||||
// Use dash format: bmad-custom-agents-fred-commit-poet.md
|
||||
// Use underscore format: bmad_custom_fred-commit-poet.md
|
||||
const commandName = customAgentDashName(agentName).replace('.md', '');
|
||||
const commandPath = path.join(rooCommandsDir, `${commandName}.md`);
|
||||
|
||||
|
|
|
|||
|
|
@ -37,7 +37,7 @@ class RovoDevSetup extends BaseIdeSetup {
|
|||
const subagentsDir = path.join(rovoDevDir, this.subagentsDir);
|
||||
if (await fs.pathExists(subagentsDir)) {
|
||||
const entries = await fs.readdir(subagentsDir);
|
||||
const bmadFiles = entries.filter((file) => file.startsWith('bmad-') && file.endsWith('.md'));
|
||||
const bmadFiles = entries.filter((file) => file.startsWith('bmad') && file.endsWith('.md'));
|
||||
|
||||
for (const file of bmadFiles) {
|
||||
await fs.remove(path.join(subagentsDir, file));
|
||||
|
|
@ -48,7 +48,7 @@ class RovoDevSetup extends BaseIdeSetup {
|
|||
const workflowsDir = path.join(rovoDevDir, this.workflowsDir);
|
||||
if (await fs.pathExists(workflowsDir)) {
|
||||
const entries = await fs.readdir(workflowsDir);
|
||||
const bmadFiles = entries.filter((file) => file.startsWith('bmad-') && file.endsWith('.md'));
|
||||
const bmadFiles = entries.filter((file) => file.startsWith('bmad') && file.endsWith('.md'));
|
||||
|
||||
for (const file of bmadFiles) {
|
||||
await fs.remove(path.join(workflowsDir, file));
|
||||
|
|
@ -59,7 +59,7 @@ class RovoDevSetup extends BaseIdeSetup {
|
|||
const referencesDir = path.join(rovoDevDir, this.referencesDir);
|
||||
if (await fs.pathExists(referencesDir)) {
|
||||
const entries = await fs.readdir(referencesDir);
|
||||
const bmadFiles = entries.filter((file) => file.startsWith('bmad-') && file.endsWith('.md'));
|
||||
const bmadFiles = entries.filter((file) => file.startsWith('bmad') && file.endsWith('.md'));
|
||||
|
||||
for (const file of bmadFiles) {
|
||||
await fs.remove(path.join(referencesDir, file));
|
||||
|
|
@ -249,7 +249,7 @@ class RovoDevSetup extends BaseIdeSetup {
|
|||
if (await fs.pathExists(subagentsDir)) {
|
||||
try {
|
||||
const entries = await fs.readdir(subagentsDir);
|
||||
if (entries.some((entry) => entry.startsWith('bmad-') && entry.endsWith('.md'))) {
|
||||
if (entries.some((entry) => entry.startsWith('bmad') && entry.endsWith('.md'))) {
|
||||
return true;
|
||||
}
|
||||
} catch {
|
||||
|
|
@ -262,7 +262,7 @@ class RovoDevSetup extends BaseIdeSetup {
|
|||
if (await fs.pathExists(workflowsDir)) {
|
||||
try {
|
||||
const entries = await fs.readdir(workflowsDir);
|
||||
if (entries.some((entry) => entry.startsWith('bmad-') && entry.endsWith('.md'))) {
|
||||
if (entries.some((entry) => entry.startsWith('bmad') && entry.endsWith('.md'))) {
|
||||
return true;
|
||||
}
|
||||
} catch {
|
||||
|
|
@ -275,7 +275,7 @@ class RovoDevSetup extends BaseIdeSetup {
|
|||
if (await fs.pathExists(referencesDir)) {
|
||||
try {
|
||||
const entries = await fs.readdir(referencesDir);
|
||||
if (entries.some((entry) => entry.startsWith('bmad-') && entry.endsWith('.md'))) {
|
||||
if (entries.some((entry) => entry.startsWith('bmad') && entry.endsWith('.md'))) {
|
||||
return true;
|
||||
}
|
||||
} catch {
|
||||
|
|
|
|||
|
|
@ -94,8 +94,8 @@ class AgentCommandGenerator {
|
|||
}
|
||||
|
||||
/**
|
||||
* Write agent launcher artifacts using COLON format (for folder-based IDEs)
|
||||
* Creates flat files like: bmad:bmm:pm.md
|
||||
* Write agent launcher artifacts using underscore format (Windows-compatible)
|
||||
* Creates flat files like: bmad_bmm_pm.md
|
||||
*
|
||||
* @param {string} baseCommandsDir - Base commands directory for the IDE
|
||||
* @param {Array} artifacts - Agent launcher artifacts
|
||||
|
|
@ -106,7 +106,7 @@ class AgentCommandGenerator {
|
|||
|
||||
for (const artifact of artifacts) {
|
||||
if (artifact.type === 'agent-launcher') {
|
||||
// Convert relativePath to colon format: bmm/agents/pm.md → bmad:bmm:pm.md
|
||||
// Convert relativePath to underscore format: bmm/agents/pm.md → bmad_bmm_pm.md
|
||||
const flatName = toColonPath(artifact.relativePath);
|
||||
const launcherPath = path.join(baseCommandsDir, flatName);
|
||||
await fs.ensureDir(path.dirname(launcherPath));
|
||||
|
|
@ -119,8 +119,8 @@ class AgentCommandGenerator {
|
|||
}
|
||||
|
||||
/**
|
||||
* Write agent launcher artifacts using DASH format (for flat IDEs)
|
||||
* Creates flat files like: bmad-bmm-pm.md
|
||||
* Write agent launcher artifacts using underscore format (Windows-compatible)
|
||||
* Creates flat files like: bmad_bmm_pm.md
|
||||
*
|
||||
* @param {string} baseCommandsDir - Base commands directory for the IDE
|
||||
* @param {Array} artifacts - Agent launcher artifacts
|
||||
|
|
@ -131,7 +131,7 @@ class AgentCommandGenerator {
|
|||
|
||||
for (const artifact of artifacts) {
|
||||
if (artifact.type === 'agent-launcher') {
|
||||
// Convert relativePath to dash format: bmm/agents/pm.md → bmad-bmm-pm.md
|
||||
// Convert relativePath to underscore format: bmm/agents/pm.md → bmad_bmm_pm.md
|
||||
const flatName = toDashPath(artifact.relativePath);
|
||||
const launcherPath = path.join(baseCommandsDir, flatName);
|
||||
await fs.ensureDir(path.dirname(launcherPath));
|
||||
|
|
@ -144,18 +144,18 @@ class AgentCommandGenerator {
|
|||
}
|
||||
|
||||
/**
|
||||
* Get the custom agent name in colon format
|
||||
* Get the custom agent name in underscore format (Windows-compatible)
|
||||
* @param {string} agentName - Custom agent name
|
||||
* @returns {string} Colon-formatted filename
|
||||
* @returns {string} Underscore-formatted filename
|
||||
*/
|
||||
getCustomAgentColonName(agentName) {
|
||||
return customAgentColonName(agentName);
|
||||
}
|
||||
|
||||
/**
|
||||
* Get the custom agent name in dash format
|
||||
* Get the custom agent name in underscore format (Windows-compatible)
|
||||
* @param {string} agentName - Custom agent name
|
||||
* @returns {string} Dash-formatted filename
|
||||
* @returns {string} Underscore-formatted filename
|
||||
*/
|
||||
getCustomAgentDashName(agentName) {
|
||||
return customAgentDashName(agentName);
|
||||
|
|
|
|||
|
|
@ -2,109 +2,72 @@
|
|||
* Path transformation utilities for IDE installer standardization
|
||||
*
|
||||
* Provides utilities to convert hierarchical paths to flat naming conventions.
|
||||
* - Colon format (bmad:module:name.md) for folder-based IDEs converting to flat
|
||||
* - Dash format (bmad-module-name.md) for already-flat IDEs
|
||||
* - Underscore format (bmad_module_name.md) - Windows-compatible universal format
|
||||
*/
|
||||
|
||||
// Type segments to filter out from paths
|
||||
const TYPE_SEGMENTS = ['agents', 'workflows', 'tasks', 'tools'];
|
||||
|
||||
/**
|
||||
* Convert hierarchical path to flat colon-separated name (for folder-based IDEs)
|
||||
* Converts: 'bmm/agents/pm.md' → 'bmad:bmm:pm.md'
|
||||
* Converts: 'bmm/workflows/correct-course.md' → 'bmad:bmm:correct-course.md'
|
||||
* Convert hierarchical path to flat underscore-separated name
|
||||
* Converts: 'bmm/agents/pm.md' → 'bmad_bmm_pm.md'
|
||||
* Converts: 'bmm/workflows/correct-course.md' → 'bmad_bmm_correct-course.md'
|
||||
*
|
||||
* @param {string} module - Module name (e.g., 'bmm', 'core')
|
||||
* @param {string} type - Artifact type ('agents', 'workflows', 'tasks', 'tools') - filtered out
|
||||
* @param {string} name - Artifact name (e.g., 'pm', 'correct-course')
|
||||
* @returns {string} Flat filename like 'bmad:bmm:pm.md'
|
||||
* @returns {string} Flat filename like 'bmad_bmm_pm.md'
|
||||
*/
|
||||
function toColonName(module, type, name) {
|
||||
return `bmad:${module}:${name}.md`;
|
||||
function toUnderscoreName(module, type, name) {
|
||||
return `bmad_${module}_${name}.md`;
|
||||
}
|
||||
|
||||
/**
|
||||
* Convert relative path to flat colon-separated name (for folder-based IDEs)
|
||||
* Converts: 'bmm/agents/pm.md' → 'bmad:bmm:pm.md'
|
||||
* Converts: 'bmm/workflows/correct-course.md' → 'bmad:bmm:correct-course.md'
|
||||
* Convert relative path to flat underscore-separated name
|
||||
* Converts: 'bmm/agents/pm.md' → 'bmad_bmm_pm.md'
|
||||
* Converts: 'bmm/workflows/correct-course.md' → 'bmad_bmm_correct-course.md'
|
||||
*
|
||||
* @param {string} relativePath - Path like 'bmm/agents/pm.md'
|
||||
* @returns {string} Flat filename like 'bmad:bmm:pm.md'
|
||||
* @returns {string} Flat filename like 'bmad_bmm_pm.md'
|
||||
*/
|
||||
function toColonPath(relativePath) {
|
||||
function toUnderscorePath(relativePath) {
|
||||
const withoutExt = relativePath.replace('.md', '');
|
||||
const parts = withoutExt.split(/[/\\]/);
|
||||
// Filter out type segments (agents, workflows, tasks, tools)
|
||||
const filtered = parts.filter((p) => !TYPE_SEGMENTS.includes(p));
|
||||
return `bmad:${filtered.join(':')}.md`;
|
||||
return `bmad_${filtered.join('_')}.md`;
|
||||
}
|
||||
|
||||
/**
|
||||
* Convert hierarchical path to flat dash-separated name (for flat IDEs)
|
||||
* Converts: 'bmm/agents/pm.md' → 'bmad-bmm-pm.md'
|
||||
* Converts: 'bmm/workflows/correct-course.md' → 'bmad-bmm-correct-course.md'
|
||||
*
|
||||
* @param {string} relativePath - Path like 'bmm/agents/pm.md'
|
||||
* @returns {string} Flat filename like 'bmad-bmm-pm.md'
|
||||
*/
|
||||
function toDashPath(relativePath) {
|
||||
const withoutExt = relativePath.replace('.md', '');
|
||||
const parts = withoutExt.split(/[/\\]/);
|
||||
// Filter out type segments (agents, workflows, tasks, tools)
|
||||
const filtered = parts.filter((p) => !TYPE_SEGMENTS.includes(p));
|
||||
return `bmad-${filtered.join('-')}.md`;
|
||||
}
|
||||
|
||||
/**
|
||||
* Create custom agent colon name (for folder-based IDEs)
|
||||
* Creates: 'bmad:custom:fred-commit-poet.md'
|
||||
* Create custom agent underscore name
|
||||
* Creates: 'bmad_custom_fred-commit-poet.md'
|
||||
*
|
||||
* @param {string} agentName - Custom agent name
|
||||
* @returns {string} Flat filename like 'bmad:custom:fred-commit-poet.md'
|
||||
* @returns {string} Flat filename like 'bmad_custom_fred-commit-poet.md'
|
||||
*/
|
||||
function customAgentColonName(agentName) {
|
||||
return `bmad:custom:${agentName}.md`;
|
||||
function customAgentUnderscoreName(agentName) {
|
||||
return `bmad_custom_${agentName}.md`;
|
||||
}
|
||||
|
||||
/**
|
||||
* Create custom agent dash name (for flat IDEs)
|
||||
* Creates: 'bmad-custom-fred-commit-poet.md'
|
||||
*
|
||||
* @param {string} agentName - Custom agent name
|
||||
* @returns {string} Flat filename like 'bmad-custom-fred-commit-poet.md'
|
||||
*/
|
||||
function customAgentDashName(agentName) {
|
||||
return `bmad-custom-${agentName}.md`;
|
||||
}
|
||||
|
||||
/**
|
||||
* Check if a filename uses colon format
|
||||
* Check if a filename uses underscore format
|
||||
* @param {string} filename - Filename to check
|
||||
* @returns {boolean} True if filename uses colon format
|
||||
* @returns {boolean} True if filename uses underscore format
|
||||
*/
|
||||
function isColonFormat(filename) {
|
||||
return filename.includes('bmad:') && filename.includes(':');
|
||||
function isUnderscoreFormat(filename) {
|
||||
return filename.startsWith('bmad_') && filename.includes('_');
|
||||
}
|
||||
|
||||
/**
|
||||
* Check if a filename uses dash format
|
||||
* @param {string} filename - Filename to check
|
||||
* @returns {boolean} True if filename uses dash format
|
||||
*/
|
||||
function isDashFormat(filename) {
|
||||
return filename.startsWith('bmad-') && !filename.includes(':');
|
||||
}
|
||||
|
||||
/**
|
||||
* Extract parts from a colon-formatted filename
|
||||
* Parses: 'bmad:bmm:pm.md' → { prefix: 'bmad', module: 'bmm', name: 'pm' }
|
||||
* Extract parts from an underscore-formatted filename
|
||||
* Parses: 'bmad_bmm_pm.md' → { prefix: 'bmad', module: 'bmm', name: 'pm' }
|
||||
*
|
||||
* @param {string} filename - Colon-formatted filename
|
||||
* @param {string} filename - Underscore-formatted filename
|
||||
* @returns {Object|null} Parsed parts or null if invalid format
|
||||
*/
|
||||
function parseColonName(filename) {
|
||||
function parseUnderscoreName(filename) {
|
||||
const withoutExt = filename.replace('.md', '');
|
||||
const parts = withoutExt.split(':');
|
||||
const parts = withoutExt.split('_');
|
||||
|
||||
if (parts.length < 3 || parts[0] !== 'bmad') {
|
||||
return null;
|
||||
|
|
@ -113,33 +76,28 @@ function parseColonName(filename) {
|
|||
return {
|
||||
prefix: parts[0],
|
||||
module: parts[1],
|
||||
name: parts.slice(2).join(':'), // Handle names that might contain colons
|
||||
name: parts.slice(2).join('_'), // Handle names that might contain underscores
|
||||
};
|
||||
}
|
||||
|
||||
/**
|
||||
* Extract parts from a dash-formatted filename
|
||||
* Parses: 'bmad-bmm-pm.md' → { prefix: 'bmad', module: 'bmm', name: 'pm' }
|
||||
*
|
||||
* @param {string} filename - Dash-formatted filename
|
||||
* @returns {Object|null} Parsed parts or null if invalid format
|
||||
*/
|
||||
function parseDashName(filename) {
|
||||
const withoutExt = filename.replace('.md', '');
|
||||
const parts = withoutExt.split('-');
|
||||
|
||||
if (parts.length < 3 || parts[0] !== 'bmad') {
|
||||
return null;
|
||||
}
|
||||
|
||||
return {
|
||||
prefix: parts[0],
|
||||
module: parts[1],
|
||||
name: parts.slice(2).join('-'), // Handle names that might contain dashes
|
||||
};
|
||||
}
|
||||
// Backward compatibility aliases (deprecated)
|
||||
const toColonName = toUnderscoreName;
|
||||
const toColonPath = toUnderscorePath;
|
||||
const toDashPath = toUnderscorePath;
|
||||
const customAgentColonName = customAgentUnderscoreName;
|
||||
const customAgentDashName = customAgentUnderscoreName;
|
||||
const isColonFormat = isUnderscoreFormat;
|
||||
const isDashFormat = isUnderscoreFormat;
|
||||
const parseColonName = parseUnderscoreName;
|
||||
const parseDashName = parseUnderscoreName;
|
||||
|
||||
module.exports = {
|
||||
toUnderscoreName,
|
||||
toUnderscorePath,
|
||||
customAgentUnderscoreName,
|
||||
isUnderscoreFormat,
|
||||
parseUnderscoreName,
|
||||
// Backward compatibility aliases
|
||||
toColonName,
|
||||
toColonPath,
|
||||
toDashPath,
|
||||
|
|
|
|||
|
|
@ -117,8 +117,8 @@ Follow all instructions in the ${type} file exactly as written.
|
|||
}
|
||||
|
||||
/**
|
||||
* Generate task and tool commands using COLON format (for folder-based IDEs)
|
||||
* Creates flat files like: bmad:bmm:bmad-help.md
|
||||
* Generate task and tool commands using underscore format (Windows-compatible)
|
||||
* Creates flat files like: bmad_bmm_bmad-help.md
|
||||
*
|
||||
* @param {string} projectDir - Project directory
|
||||
* @param {string} bmadDir - BMAD installation directory
|
||||
|
|
@ -138,7 +138,7 @@ Follow all instructions in the ${type} file exactly as written.
|
|||
// Generate command files for tasks
|
||||
for (const task of standaloneTasks) {
|
||||
const commandContent = this.generateCommandContent(task, 'task');
|
||||
// Use colon format: bmad:bmm:name.md
|
||||
// Use underscore format: bmad_bmm_name.md
|
||||
const flatName = toColonName(task.module, 'tasks', task.name);
|
||||
const commandPath = path.join(baseCommandsDir, flatName);
|
||||
await fs.ensureDir(path.dirname(commandPath));
|
||||
|
|
@ -149,7 +149,7 @@ Follow all instructions in the ${type} file exactly as written.
|
|||
// Generate command files for tools
|
||||
for (const tool of standaloneTools) {
|
||||
const commandContent = this.generateCommandContent(tool, 'tool');
|
||||
// Use colon format: bmad:bmm:name.md
|
||||
// Use underscore format: bmad_bmm_name.md
|
||||
const flatName = toColonName(tool.module, 'tools', tool.name);
|
||||
const commandPath = path.join(baseCommandsDir, flatName);
|
||||
await fs.ensureDir(path.dirname(commandPath));
|
||||
|
|
@ -165,8 +165,8 @@ Follow all instructions in the ${type} file exactly as written.
|
|||
}
|
||||
|
||||
/**
|
||||
* Generate task and tool commands using DASH format (for flat IDEs)
|
||||
* Creates flat files like: bmad-bmm-bmad-help.md
|
||||
* Generate task and tool commands using underscore format (Windows-compatible)
|
||||
* Creates flat files like: bmad_bmm_bmad-help.md
|
||||
*
|
||||
* @param {string} projectDir - Project directory
|
||||
* @param {string} bmadDir - BMAD installation directory
|
||||
|
|
@ -186,7 +186,7 @@ Follow all instructions in the ${type} file exactly as written.
|
|||
// Generate command files for tasks
|
||||
for (const task of standaloneTasks) {
|
||||
const commandContent = this.generateCommandContent(task, 'task');
|
||||
// Use dash format: bmad-bmm-name.md
|
||||
// Use underscore format: bmad_bmm_name.md
|
||||
const flatName = toDashPath(`${task.module}/tasks/${task.name}.md`);
|
||||
const commandPath = path.join(baseCommandsDir, flatName);
|
||||
await fs.ensureDir(path.dirname(commandPath));
|
||||
|
|
@ -197,7 +197,7 @@ Follow all instructions in the ${type} file exactly as written.
|
|||
// Generate command files for tools
|
||||
for (const tool of standaloneTools) {
|
||||
const commandContent = this.generateCommandContent(tool, 'tool');
|
||||
// Use dash format: bmad-bmm-name.md
|
||||
// Use underscore format: bmad_bmm_name.md
|
||||
const flatName = toDashPath(`${tool.module}/tools/${tool.name}.md`);
|
||||
const commandPath = path.join(baseCommandsDir, flatName);
|
||||
await fs.ensureDir(path.dirname(commandPath));
|
||||
|
|
@ -213,8 +213,8 @@ Follow all instructions in the ${type} file exactly as written.
|
|||
}
|
||||
|
||||
/**
|
||||
* Write task/tool artifacts using COLON format (for folder-based IDEs)
|
||||
* Creates flat files like: bmad:bmm:bmad-help.md
|
||||
* Write task/tool artifacts using underscore format (Windows-compatible)
|
||||
* Creates flat files like: bmad_bmm_bmad-help.md
|
||||
*
|
||||
* @param {string} baseCommandsDir - Base commands directory for the IDE
|
||||
* @param {Array} artifacts - Task/tool artifacts with relativePath
|
||||
|
|
@ -226,7 +226,7 @@ Follow all instructions in the ${type} file exactly as written.
|
|||
for (const artifact of artifacts) {
|
||||
if (artifact.type === 'task' || artifact.type === 'tool') {
|
||||
const commandContent = this.generateCommandContent(artifact, artifact.type);
|
||||
// Use colon format: bmad:module:name.md
|
||||
// Use underscore format: bmad_module_name.md
|
||||
const flatName = toColonPath(artifact.relativePath);
|
||||
const commandPath = path.join(baseCommandsDir, flatName);
|
||||
await fs.ensureDir(path.dirname(commandPath));
|
||||
|
|
@ -239,8 +239,8 @@ Follow all instructions in the ${type} file exactly as written.
|
|||
}
|
||||
|
||||
/**
|
||||
* Write task/tool artifacts using DASH format (for flat IDEs)
|
||||
* Creates flat files like: bmad-bmm-bmad-help.md
|
||||
* Write task/tool artifacts using underscore format (Windows-compatible)
|
||||
* Creates flat files like: bmad_bmm_bmad-help.md
|
||||
*
|
||||
* @param {string} baseCommandsDir - Base commands directory for the IDE
|
||||
* @param {Array} artifacts - Task/tool artifacts with relativePath
|
||||
|
|
@ -252,7 +252,7 @@ Follow all instructions in the ${type} file exactly as written.
|
|||
for (const artifact of artifacts) {
|
||||
if (artifact.type === 'task' || artifact.type === 'tool') {
|
||||
const commandContent = this.generateCommandContent(artifact, artifact.type);
|
||||
// Use dash format: bmad-module-name.md
|
||||
// Use underscore format: bmad_module_name.md
|
||||
const flatName = toDashPath(artifact.relativePath);
|
||||
const commandPath = path.join(baseCommandsDir, flatName);
|
||||
await fs.ensureDir(path.dirname(commandPath));
|
||||
|
|
|
|||
|
|
@ -240,8 +240,8 @@ When running any workflow:
|
|||
}
|
||||
|
||||
/**
|
||||
* Write workflow command artifacts using COLON format (for folder-based IDEs)
|
||||
* Creates flat files like: bmad:bmm:correct-course.md
|
||||
* Write workflow command artifacts using underscore format (Windows-compatible)
|
||||
* Creates flat files like: bmad_bmm_correct-course.md
|
||||
*
|
||||
* @param {string} baseCommandsDir - Base commands directory for the IDE
|
||||
* @param {Array} artifacts - Workflow artifacts
|
||||
|
|
@ -252,7 +252,7 @@ When running any workflow:
|
|||
|
||||
for (const artifact of artifacts) {
|
||||
if (artifact.type === 'workflow-command') {
|
||||
// Convert relativePath to colon format: bmm/workflows/correct-course.md → bmad:bmm:correct-course.md
|
||||
// Convert relativePath to underscore format: bmm/workflows/correct-course.md → bmad_bmm_correct-course.md
|
||||
const flatName = toColonPath(artifact.relativePath);
|
||||
const commandPath = path.join(baseCommandsDir, flatName);
|
||||
await fs.ensureDir(path.dirname(commandPath));
|
||||
|
|
@ -265,8 +265,8 @@ When running any workflow:
|
|||
}
|
||||
|
||||
/**
|
||||
* Write workflow command artifacts using DASH format (for flat IDEs)
|
||||
* Creates flat files like: bmad-bmm-correct-course.md
|
||||
* Write workflow command artifacts using underscore format (Windows-compatible)
|
||||
* Creates flat files like: bmad_bmm_correct-course.md
|
||||
*
|
||||
* @param {string} baseCommandsDir - Base commands directory for the IDE
|
||||
* @param {Array} artifacts - Workflow artifacts
|
||||
|
|
@ -277,7 +277,7 @@ When running any workflow:
|
|||
|
||||
for (const artifact of artifacts) {
|
||||
if (artifact.type === 'workflow-command') {
|
||||
// Convert relativePath to dash format: bmm/workflows/correct-course.md → bmad-bmm-correct-course.md
|
||||
// Convert relativePath to underscore format: bmm/workflows/correct-course.md → bmad_bmm_correct-course.md
|
||||
const flatName = toDashPath(artifact.relativePath);
|
||||
const commandPath = path.join(baseCommandsDir, flatName);
|
||||
await fs.ensureDir(path.dirname(commandPath));
|
||||
|
|
|
|||
|
|
@ -246,12 +246,12 @@ Part of the BMAD ${workflow.module.toUpperCase()} module.
|
|||
const rulesPath = path.join(projectDir, this.configDir, this.rulesDir);
|
||||
|
||||
if (await fs.pathExists(rulesPath)) {
|
||||
// Only remove files that start with bmad- prefix
|
||||
// Remove any bmad* files (cleans up old bmad- and bmad: formats)
|
||||
const files = await fs.readdir(rulesPath);
|
||||
let removed = 0;
|
||||
|
||||
for (const file of files) {
|
||||
if (file.startsWith('bmad-') && file.endsWith('.md')) {
|
||||
if (file.startsWith('bmad') && file.endsWith('.md')) {
|
||||
await fs.remove(path.join(rulesPath, file));
|
||||
removed++;
|
||||
}
|
||||
|
|
|
|||
|
|
@ -54,6 +54,7 @@ class ExternalModuleManager {
|
|||
description: moduleConfig.description || '',
|
||||
defaultSelected: moduleConfig.defaultSelected === true,
|
||||
type: moduleConfig.type || 'community', // bmad-org or community
|
||||
npmPackage: moduleConfig.npmPackage || null, // Include npm package name
|
||||
isExternal: true,
|
||||
});
|
||||
}
|
||||
|
|
@ -95,6 +96,7 @@ class ExternalModuleManager {
|
|||
description: moduleConfig.description || '',
|
||||
defaultSelected: moduleConfig.defaultSelected === true,
|
||||
type: moduleConfig.type || 'community', // bmad-org or community
|
||||
npmPackage: moduleConfig.npmPackage || null, // Include npm package name
|
||||
isExternal: true,
|
||||
};
|
||||
}
|
||||
|
|
|
|||
|
|
@ -371,9 +371,9 @@ class ModuleManager {
|
|||
const fetchSpinner = ora(`Fetching ${moduleInfo.name}...`).start();
|
||||
try {
|
||||
const currentRef = execSync('git rev-parse HEAD', { cwd: moduleCacheDir, stdio: 'pipe' }).toString().trim();
|
||||
execSync('git fetch --depth 1', { cwd: moduleCacheDir, stdio: 'pipe' });
|
||||
execSync('git checkout -f', { cwd: moduleCacheDir, stdio: 'pipe' });
|
||||
execSync('git pull --ff-only', { cwd: moduleCacheDir, stdio: 'pipe' });
|
||||
// Fetch and reset to remote - works better with shallow clones than pull
|
||||
execSync('git fetch origin --depth 1', { cwd: moduleCacheDir, stdio: 'pipe' });
|
||||
execSync('git reset --hard origin/HEAD', { cwd: moduleCacheDir, stdio: 'pipe' });
|
||||
const newRef = execSync('git rev-parse HEAD', { cwd: moduleCacheDir, stdio: 'pipe' }).toString().trim();
|
||||
|
||||
fetchSpinner.succeed(`Fetched ${moduleInfo.name}`);
|
||||
|
|
@ -555,10 +555,23 @@ class ModuleManager {
|
|||
await this.runModuleInstaller(moduleName, bmadDir, options);
|
||||
}
|
||||
|
||||
// Capture version info for manifest
|
||||
const { Manifest } = require('../core/manifest');
|
||||
const manifestObj = new Manifest();
|
||||
const versionInfo = await manifestObj.getModuleVersionInfo(moduleName, bmadDir, sourcePath);
|
||||
|
||||
await manifestObj.addModule(bmadDir, moduleName, {
|
||||
version: versionInfo.version,
|
||||
source: versionInfo.source,
|
||||
npmPackage: versionInfo.npmPackage,
|
||||
repoUrl: versionInfo.repoUrl,
|
||||
});
|
||||
|
||||
return {
|
||||
success: true,
|
||||
module: moduleName,
|
||||
path: targetPath,
|
||||
versionInfo,
|
||||
};
|
||||
}
|
||||
|
||||
|
|
|
|||
|
|
@ -1586,6 +1586,131 @@ class UI {
|
|||
|
||||
return proceed === 'proceed';
|
||||
}
|
||||
|
||||
/**
|
||||
* Display module versions with update availability
|
||||
* @param {Array} modules - Array of module info objects with version info
|
||||
* @param {Array} availableUpdates - Array of available updates
|
||||
*/
|
||||
displayModuleVersions(modules, availableUpdates = []) {
|
||||
console.log('');
|
||||
console.log(chalk.cyan.bold('📦 Module Versions'));
|
||||
console.log(chalk.gray('─'.repeat(80)));
|
||||
|
||||
// Group modules by source
|
||||
const builtIn = modules.filter((m) => m.source === 'built-in');
|
||||
const external = modules.filter((m) => m.source === 'external');
|
||||
const custom = modules.filter((m) => m.source === 'custom');
|
||||
const unknown = modules.filter((m) => m.source === 'unknown');
|
||||
|
||||
const displayGroup = (group, title) => {
|
||||
if (group.length === 0) return;
|
||||
|
||||
console.log(chalk.yellow(`\n${title}`));
|
||||
for (const module of group) {
|
||||
const updateInfo = availableUpdates.find((u) => u.name === module.name);
|
||||
const versionDisplay = module.version || chalk.gray('unknown');
|
||||
|
||||
if (updateInfo) {
|
||||
console.log(
|
||||
` ${chalk.cyan(module.name.padEnd(20))} ${versionDisplay} → ${chalk.green(updateInfo.latestVersion)} ${chalk.green('↑')}`,
|
||||
);
|
||||
} else {
|
||||
console.log(` ${chalk.cyan(module.name.padEnd(20))} ${versionDisplay} ${chalk.gray('✓')}`);
|
||||
}
|
||||
}
|
||||
};
|
||||
|
||||
displayGroup(builtIn, 'Built-in Modules');
|
||||
displayGroup(external, 'External Modules (Official)');
|
||||
displayGroup(custom, 'Custom Modules');
|
||||
displayGroup(unknown, 'Other Modules');
|
||||
|
||||
console.log('');
|
||||
}
|
||||
|
||||
/**
|
||||
* Prompt user to select which modules to update
|
||||
* @param {Array} availableUpdates - Array of available updates
|
||||
* @returns {Array} Selected module names to update
|
||||
*/
|
||||
async promptUpdateSelection(availableUpdates) {
|
||||
if (availableUpdates.length === 0) {
|
||||
return [];
|
||||
}
|
||||
|
||||
console.log('');
|
||||
console.log(chalk.cyan.bold('🔄 Available Updates'));
|
||||
console.log(chalk.gray('─'.repeat(80)));
|
||||
|
||||
const choices = availableUpdates.map((update) => ({
|
||||
name: `${update.name} ${chalk.dim(`(v${update.installedVersion} → v${update.latestVersion})`)}`,
|
||||
value: update.name,
|
||||
checked: true, // Default to selecting all updates
|
||||
}));
|
||||
|
||||
// Add "Update All" and "Cancel" options
|
||||
const action = await prompts.select({
|
||||
message: 'How would you like to proceed?',
|
||||
choices: [
|
||||
{ name: 'Update all available modules', value: 'all' },
|
||||
{ name: 'Select specific modules to update', value: 'select' },
|
||||
{ name: 'Skip updates for now', value: 'skip' },
|
||||
],
|
||||
default: 'all',
|
||||
});
|
||||
|
||||
if (action === 'all') {
|
||||
return availableUpdates.map((u) => u.name);
|
||||
}
|
||||
|
||||
if (action === 'skip') {
|
||||
return [];
|
||||
}
|
||||
|
||||
// Allow specific selection
|
||||
const selected = await prompts.multiselect({
|
||||
message: `Select modules to update ${chalk.dim('(↑/↓ navigates, SPACE toggles, ENTER to confirm)')}:`,
|
||||
choices: choices,
|
||||
required: true,
|
||||
});
|
||||
|
||||
return selected || [];
|
||||
}
|
||||
|
||||
/**
|
||||
* Display status of all installed modules
|
||||
* @param {Object} statusData - Status data with modules, installation info, and available updates
|
||||
*/
|
||||
displayStatus(statusData) {
|
||||
const { installation, modules, availableUpdates, bmadDir } = statusData;
|
||||
|
||||
console.log('');
|
||||
console.log(chalk.cyan.bold('📋 BMAD Status'));
|
||||
console.log(chalk.gray('─'.repeat(80)));
|
||||
|
||||
// Installation info
|
||||
console.log(chalk.yellow('\nInstallation'));
|
||||
console.log(` ${chalk.gray('Version:'.padEnd(20))} ${installation.version || chalk.gray('unknown')}`);
|
||||
console.log(` ${chalk.gray('Location:'.padEnd(20))} ${bmadDir}`);
|
||||
console.log(` ${chalk.gray('Installed:'.padEnd(20))} ${new Date(installation.installDate).toLocaleDateString()}`);
|
||||
console.log(
|
||||
` ${chalk.gray('Last Updated:'.padEnd(20))} ${installation.lastUpdated ? new Date(installation.lastUpdated).toLocaleDateString() : chalk.gray('unknown')}`,
|
||||
);
|
||||
|
||||
// Module versions
|
||||
this.displayModuleVersions(modules, availableUpdates);
|
||||
|
||||
// Update summary
|
||||
if (availableUpdates.length > 0) {
|
||||
console.log(chalk.yellow.bold(`\n⚠️ ${availableUpdates.length} update(s) available`));
|
||||
console.log(chalk.dim(` Run 'bmad install' and select "Quick Update" to update`));
|
||||
} else {
|
||||
console.log(chalk.green.bold('\n✓ All modules are up to date'));
|
||||
}
|
||||
|
||||
console.log('');
|
||||
}
|
||||
}
|
||||
|
||||
module.exports = { UI };
|
||||
|
|
|
|||
|
|
@ -0,0 +1,51 @@
|
|||
import { defineConfig } from 'vitest/config';
|
||||
|
||||
export default defineConfig({
|
||||
test: {
|
||||
// Test file patterns
|
||||
include: ['test/unit/**/*.test.js', 'test/integration/**/*.test.js'],
|
||||
exclude: ['test/test-*.js', 'node_modules/**'],
|
||||
|
||||
// Timeouts
|
||||
testTimeout: 10_000, // 10s for unit tests
|
||||
hookTimeout: 30_000, // 30s for setup/teardown
|
||||
|
||||
// Parallel execution for speed
|
||||
threads: true,
|
||||
maxThreads: 4,
|
||||
|
||||
// Coverage configuration (using V8)
|
||||
coverage: {
|
||||
provider: 'v8',
|
||||
reporter: ['text', 'html', 'lcov', 'json-summary'],
|
||||
|
||||
// Files to include in coverage
|
||||
include: ['tools/**/*.js', 'src/**/*.js'],
|
||||
|
||||
// Files to exclude from coverage
|
||||
exclude: [
|
||||
'test/**',
|
||||
'tools/flattener/**', // Separate concern
|
||||
'tools/bmad-npx-wrapper.js', // Entry point
|
||||
'tools/build-docs.js', // Documentation tools
|
||||
'tools/check-doc-links.js', // Documentation tools
|
||||
'**/*.config.js', // Configuration files
|
||||
],
|
||||
|
||||
// Include all files for accurate coverage
|
||||
all: true,
|
||||
|
||||
// Coverage thresholds (fail if below these)
|
||||
statements: 85,
|
||||
branches: 80,
|
||||
functions: 85,
|
||||
lines: 85,
|
||||
},
|
||||
|
||||
// Global setup file
|
||||
setupFiles: ['./test/setup.js'],
|
||||
|
||||
// Environment
|
||||
environment: 'node',
|
||||
},
|
||||
});
|
||||
Loading…
Reference in New Issue