Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
5 changes: 5 additions & 0 deletions .gitignore
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
out/
node_modules/
*.vsix
examples/
coverage/
47 changes: 47 additions & 0 deletions .vscodeignore
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
26 changes: 26 additions & 0 deletions LICENSE
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.
4 changes: 4 additions & 0 deletions NOTICE
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
121 changes: 121 additions & 0 deletions README.md
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.
Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

⚠️ Potential issue | 🟡 Minor

Replace the bare URL with a markdown link.

This avoids MD034 and improves readability.

💡 Suggested fix
-- **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.
+- **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 [openai/codex#3641](https://github.com/openai/codex/issues/3641) for details.
📝 Committable suggestion

‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.

Suggested change
- **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.
- **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 [openai/codex#3641](https://github.com/openai/codex/issues/3641) for details.
🧰 Tools
🪛 markdownlint-cli2 (0.18.1)

35-35: Bare URL used

(MD034, no-bare-urls)

🤖 Prompt for AI Agents
In `@README.md` at line 35, Replace the bare URL in the README sentence that warns
about the `codex` CLI with a Markdown link; locate the sentence mentioning
"**Codex is not supported.** The `codex` CLI..." and change the trailing plain
URL (https://github.com/openai/codex/issues/3641) to a markdown link such as
`[https://github.com/openai/codex/issues/3641](https://github.com/openai/codex/issues/3641)`
or better `[openai/codex#3641](https://github.com/openai/codex/issues/3641)` so
the URL is not bare and the line no longer triggers MD034.


## 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
Loading