-
Notifications
You must be signed in to change notification settings - Fork 2
feat: add VS Code extension for BMad Method #1
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Open
wsmoak
wants to merge
1
commit into
main
Choose a base branch
from
vscode-extension-contribution
base: main
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
Open
Changes from all commits
Commits
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,5 @@ | ||
| out/ | ||
| node_modules/ | ||
| *.vsix | ||
| examples/ | ||
| coverage/ |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,47 @@ | ||
| # Source files - only compiled output needed | ||
| src/ | ||
| *.ts | ||
|
|
||
| # Exclude test output and source maps from out/ | ||
| out/__tests__/ | ||
| out/**/*.map | ||
|
|
||
| # Dependencies | ||
| node_modules/ | ||
| package-lock.json | ||
|
|
||
| # Development config | ||
| tsconfig.json | ||
| vitest.config.ts | ||
| .vscode/ | ||
| .gitignore | ||
| .envrc | ||
|
|
||
| # Test and coverage | ||
| coverage/ | ||
| .nyc_output/ | ||
|
|
||
| # Documentation and BMAD working files | ||
| docs/ | ||
| _bmad/ | ||
| _bmad-output/ | ||
| CLAUDE.md | ||
| GEMINI.md | ||
| AGENTS.md | ||
| STATUS.md | ||
|
|
||
| # Version control | ||
| .git/ | ||
| .github/ | ||
|
|
||
| # AI tool configs | ||
| .claude/ | ||
| .codex/ | ||
| .gemini/ | ||
|
|
||
| # Archive and scratch | ||
| archive/ | ||
|
|
||
| # Build artifacts | ||
| *.vsix | ||
| *.png |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,26 @@ | ||
| MIT License | ||
|
|
||
| Copyright (c) 2026 BMad Code, LLC | ||
|
|
||
| Permission is hereby granted, free of charge, to any person obtaining a copy | ||
| of this software and associated documentation files (the "Software"), to deal | ||
| in the Software without restriction, including without limitation the rights | ||
| to use, copy, modify, merge, publish, distribute, sublicense, and/or sell | ||
| copies of the Software, and to permit persons to whom the Software is | ||
| furnished to do so, subject to the following conditions: | ||
|
|
||
| The above copyright notice and this permission notice shall be included in all | ||
| copies or substantial portions of the Software. | ||
|
|
||
| THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR | ||
| IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, | ||
| FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE | ||
| AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER | ||
| LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, | ||
| OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE | ||
| SOFTWARE. | ||
|
|
||
| TRADEMARK NOTICE: | ||
| BMad™ , BMAD-CORE™ and BMAD-METHOD™ are trademarks of BMad Code, LLC. The use of these | ||
| trademarks in this software does not grant any rights to use the trademarks | ||
| for any other purpose. |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,4 @@ | ||
| This software contains original code developed and contributed by: | ||
|
|
||
| Copyright (c) 2026 Wendy Smoak | ||
| Contributed to BMad Code, LLC in January 2026 under the MIT License |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,121 @@ | ||
| # BMad Method for VS Code | ||
|
|
||
| A VS Code extension for the BMad Method that displays CodeLens actions above story headers in epic markdown files, enabling one-click story creation and development via Claude Code CLI. | ||
|
|
||
| ## Features | ||
|
|
||
| - Detects BMAD epic files by configurable filename pattern (default: `*epic*.md`) | ||
| - Displays CodeLens actions above story headers matching `### Story N.N: Title` | ||
| - Context-aware actions based on story status and file existence: | ||
| - **Create Story**: When status is `ready` but no story file exists | ||
| - **Start Developing Story**: When status is `ready` and story file exists | ||
| - No CodeLens for stories with other statuses (`in-progress`, `completed`, etc.) | ||
|
|
||
| ## Requirements | ||
|
|
||
| - VS Code 1.80.0 or higher | ||
| - [Claude Code CLI](https://claude.ai/claude-code) installed and authenticated (or configure `bmad.cliTool`) | ||
| - BMAD Method workflows configured in your project | ||
|
|
||
| ## Story File Detection | ||
|
|
||
| The extension looks for story files in `_bmad-output/implementation-artifacts/` with the naming pattern `{story-number}*.md` where dots in the story number are converted to dashes (e.g., story `1.1` looks for files matching `1-1*.md`). | ||
|
|
||
| ## Configuration | ||
|
|
||
| | Setting | Default | Description | | ||
| |---------|---------|-------------| | ||
| | `bmad.enableCodeLens` | `true` | Enable/disable CodeLens for BMAD story files | | ||
| | `bmad.epicFilePattern` | `**/*epic*.md` | Glob pattern for BMAD epic files | | ||
| | `bmad.techSpecFilePattern` | `**/tech-spec-*.md` | Glob pattern for BMAD tech spec files | | ||
| | `bmad.cliTool` | `claude` | CLI tool binary used to run BMAD story workflows | | ||
|
|
||
| ## Compatibility / Known Limitations | ||
|
|
||
| - **Codex is not supported.** The `codex` CLI has known issues and is incompatible with the extension's workflow; do not set `bmad.cliTool` to `codex`. See https://github.com/openai/codex/issues/3641 for details. | ||
|
|
||
| ## Usage | ||
|
|
||
| 1. Open an epic file (e.g., `epic-1-authentication.md`) | ||
| 2. Look for stories with `**Status:** ready` | ||
| 3. Click the CodeLens action above the story header: | ||
| - "Create Story" runs `/bmad:bmm:workflows:create-story {storyNumber}` | ||
| - "Start Developing Story" runs `/bmad:bmm:workflows:dev-story {storyNumber}` | ||
|
|
||
| ## Expected Story Format | ||
|
|
||
| ```markdown | ||
| ### Story 1.1: Implement User Login | ||
|
|
||
| **Status:** ready | ||
| **Priority:** P0 | ||
| **Estimated Effort:** 3 points | ||
| ``` | ||
|
|
||
| ## Development | ||
|
|
||
| ```bash | ||
| # Install dependencies | ||
| npm install | ||
|
|
||
| # Compile TypeScript | ||
| npm run compile | ||
|
|
||
| # Watch for changes | ||
| npm run watch | ||
|
|
||
| # Test in VS Code | ||
| # Open src/extension.ts and press F5 to launch Extension Development Host | ||
| ``` | ||
|
|
||
| ## Testing | ||
|
|
||
| The project uses [Vitest](https://vitest.dev/) for unit and integration testing. | ||
|
|
||
| ```bash | ||
| # Run all tests | ||
| npm test | ||
|
|
||
| # Run tests in watch mode (re-runs on file changes) | ||
| npm run test:watch | ||
|
|
||
| # Run tests with coverage report | ||
| npm run test:coverage | ||
| ``` | ||
|
|
||
| Test files are located in `src/__tests__/` and follow the `*.test.ts` naming convention. | ||
|
|
||
| Coverage reports showing which lines of code were not executed during the tests are generated in `coverage/`: | ||
|
|
||
| - HTML report: open `coverage/index.html` | ||
| - LCOV report: `coverage/lcov.info` (for CI or uploading to coverage services) | ||
|
|
||
| ## Local Installation | ||
|
|
||
| To package and install the extension locally: | ||
|
|
||
| 1. Install the VS Code Extension Manager: | ||
| ```bash | ||
| npm install -g @vscode/vsce | ||
| ``` | ||
|
|
||
| 2. Package the extension: | ||
| ```bash | ||
| vsce package | ||
| ``` | ||
| This creates a `.vsix` file in the project directory. | ||
|
|
||
| 3. Install in VS Code: | ||
| - Open Extensions view (Cmd+Shift+X) | ||
| - Click the `...` menu at the top of the sidebar | ||
| - Select "Install from VSIX..." | ||
| - Choose the generated `.vsix` file | ||
|
|
||
| Or from the command line: | ||
| ```bash | ||
| code --install-extension bmad-method-0.0.1-pre.vsix | ||
| ``` | ||
|
|
||
| ## License | ||
|
|
||
| MIT | ||
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Replace the bare URL with a markdown link.
This avoids MD034 and improves readability.
💡 Suggested fix
📝 Committable suggestion
🧰 Tools
🪛 markdownlint-cli2 (0.18.1)
35-35: Bare URL used
(MD034, no-bare-urls)
🤖 Prompt for AI Agents