Skip to content

feat: VS Code extension for inline annotations#179

Closed
backnotprop wants to merge 2 commits intomainfrom
feat/vscode-extension
Closed

feat: VS Code extension for inline annotations#179
backnotprop wants to merge 2 commits intomainfrom
feat/vscode-extension

Conversation

@backnotprop
Copy link
Owner

@backnotprop backnotprop commented Feb 24, 2026

Summary

  • Adds apps/vscode-extension/ — a VS Code extension for inline annotation markers using start/end <!-- @plannotator NNNN: text --> comments
  • Right-click context menu: "Add Annotation" and "Export Annotations"
  • Keyboard shortcut: Cmd+Alt+P (Mac) / Ctrl+Alt+P (others)
  • Auto-incrementing 4-digit IDs (0001, 0002, ...) with multi-line marker support
  • Export produces Plan Feedback markdown format, copied to clipboard
  • Configurable prefix via plannotator.annotationPrefix setting
  • Zero runtime dependencies, esbuild bundled to CJS
  • Adds dev:vscode and build:vscode root scripts

Closes #91

Test plan

  • Open apps/vscode-extension/ in VS Code, press F5 to launch Extension Development Host
  • Place cursor on a line, right-click → "Plannotator: Add Annotation"
  • Verify <!-- @plannotator 0001: --> inserted above with cursor positioned for typing
  • Select multiple lines → Add Annotation → verify start/end markers wrap the selection
  • Add 3 annotations → verify IDs increment: 0001, 0002, 0003
  • Test keyboard shortcut Cmd+Alt+P
  • Right-click → "Plannotator: Export Annotations" → verify Plan Feedback markdown copied to clipboard
  • Verify bun run build:vscode works from repo root

Publishing checklist

Assets

  • Extension icon — 256x256px PNG (no SVG), referenced as "icon" in package.json
  • apps/vscode-extension/README.md — this is what shows on the marketplace listing
  • apps/vscode-extension/CHANGELOG.md (optional but recommended)
  • Screenshots/GIFs for the README showing add annotation + export flow

package.json updates

  • Bump version (currently 0.0.1 — decide: sync with root or independent versioning)
  • Add "icon": "icon.png"
  • Add "homepage" URL
  • Add "bugs" URL
  • Add "galleryBanner" (optional, customizes marketplace page colors)
  • Review "keywords" for discoverability

Publisher account

CI/CD — extend .github/workflows/release.yml

  • Add vscode-publish job (parallel to existing npm-publish)
  • Build: bun run build:vscode
  • Package: npx @vscode/vsce package --no-dependencies (already in scripts)
  • Publish: npx @vscode/vsce publish -p $VSCE_PAT
  • Attach .vsix to GitHub Release as artifact
  • Respect existing DRY_RUN flag for dry-run mode
  • Decide: publish on every v* tag, or separate vscode-v* tags

Pre-publish validation

  • vsce package succeeds with no warnings
  • All README images use HTTPS URLs (no SVG except trusted badge providers)
  • .vscodeignore excludes src/, node_modules/, config files (already done)
  • Extension activates and works from packaged .vsix (install via Extensions → Install from VSIX)

🤖 Generated with Claude Code

7tg and others added 2 commits March 5, 2026 09:44
…ode)

Opens Plannotator plan reviews, code reviews, and annotations inside VS Code
tabs instead of an external browser. Intercepts PLANNOTATOR_BROWSER via env
var injection in integrated terminals, with cookie persistence and auto-close.

Original repository: https://github.com/7tg/plannotator-vscode
Closes #91

Co-Authored-By: Barbaros Gören <tayyipgoren@gmail.com>
- Update package.json: publisher → backnotprop, repo → plannotator, add private
- Replace node -e URL encoding with curl --data-urlencode in router script
- Simplify panel-manager tests to keep only behavioral tests
- Add dev:vscode, build:vscode, package:vscode scripts to root
- Add *.vsix to .gitignore
- Update bun.lock with new workspace member

Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
@backnotprop backnotprop force-pushed the feat/vscode-extension branch from 7aa8e4f to b70f709 Compare March 5, 2026 17:48
@backnotprop
Copy link
Owner Author

Closing — this PR was for a different VS Code extension concept (inline HTML annotations). Replaced by a new PR integrating the community webview extension from 7tg/plannotator-vscode.

@backnotprop backnotprop closed this Mar 5, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Proposal for IDE-Based Control and Interactive Code Revision

2 participants