Note Extension
Add context-aware, persistent notes to your code lines in Visual Studio Code. Instantly create, edit, and highlight notes with a modern dashboard. Perfect for reminders, code reviews, and collaborative work.
🚀 Features
- Context-aware notes: Add notes to any line in your code
- Modern dashboard: Edit notes with type, priority, tags, due date, status, and pin options
- Color-coded summaries: Visual priority and status indicators with emojis
- Persistent storage: Notes are saved in
.vscode/notes.json per project
- Collapsible icons: Notes collapse into a lightbulb icon with summary info
- Security features: Input validation, XSS protection, and file security
- Theme-aware UI: Looks great in both dark and light themes
✨ How to Use
1. Add or Edit a Note
- Click the lightbulb icon at the end of a line, or use
Ctrl+Alt+N to add a note
- The note dashboard will open. Fill in:
- Type (Bug, Feature, Todo, Info, Warning, Question, Improvement)
- Priority (Critical, High, Medium, Low, None)
- Tags (comma-separated)
- Due Date
- Status (Todo, In Progress, Review, Done, Blocked, Cancelled)
- Pinned (checkbox)
- Content (your note)
- Click Save or press Ctrl+S to save your note
2. View Notes in Code
- After saving, the note collapses into a color-coded summary at the end of the line
- Color coding:
- 🔴 Critical/High priority: Red/Orange
- 🟡 Medium priority: Yellow
- 🟢 Low priority: Green
- ✅ Done status: Green
- 🔄 In Progress: Blue
- 🚫 Blocked: Red
- Hover over the icon to see the note content
3. Remove or Update Notes
- Open the note panel and use Delete to remove the note
- Edit any field and click Save to update
🗂️ Notes Storage
- Notes are stored in
.vscode/notes.json in your project folder
- You can add
.vscode/notes.json to .gitignore for privacy, or commit it to share with your team
⌨️ Commands & Shortcuts
Keyboard Shortcut
Command Palette Commands
- Add Note to Line: Add a new note at cursor position
- Edit Note at Cursor: Edit existing note or add new one
- Quick Add Note: Add note without opening dashboard
- Delete Note at Cursor: Remove note at cursor position
- Toggle Note Visibility: Show/hide note content
To access commands: Press Ctrl+Shift+P and type the command name
🔒 Security Features
- Input validation: Prevents empty content and oversized notes
- XSS protection: Blocks dangerous HTML/JavaScript content
- File security: Path traversal and null byte injection protection
- JSON validation: Size limits and corruption recovery
📝 Changelog
- v0.0.10: Added color-coded note summaries and enhanced categories
- v0.0.9: Implemented comprehensive security features
- v0.0.8: Added modern dashboard with editable fields
- v0.0.7: Persistent JSON storage and line summary with emoji
| |
