📝 Sticky Notes for VS Code

A lightweight and useful Visual Studio Code extension that lets you manage sticky notes directly in your code. No need for external tools — just write // TODO, // FIXME, // NOTE, or other comment types, and they'll instantly show up in a sidebar panel with icons, colors, and navigation.

Install this extension from the VS Code Marketplace

✨ Features

📌 Sticky Notes Sidebar View all your notes in one organized place.
🎨 Color-coded Notes with Icons
- ✅ TODO: → Sky Blue (📋)
- 🐞 FIXME: → Indian Red (🔧)
- 📝 NOTE: → Spring Green (📄)
- 🐛 BUG: → Crimson (🐛)
- ⭐ HACK: → Orange (⭐)
- 👀 REVIEW: → Purple (📋)
- ⚠️ WARNING: → Gold (⚠️)
- ℹ️ INFO: → Dodger Blue (ℹ️)
- 🚫 DEPRECATED: → Gray (🚫)
🖼️ Gutter Icons Each note shows up in the editor gutter with a matching colored icon.
🔄 Auto Refresh Notes update automatically when you open, save, or close a file.
🔗 Two-way Sync
- Click a sidebar note → jumps to that line in your code.
- Click a gutter icon → opens sidebar + highlights the note.

🖼️ Usage

Basic Usage

Write comments in your code like:

// TODO: Refactor this function
// FIXME: Handle null cases
// NOTE: Remember to optimize later

Advanced Usage

Use all available comment types:

// TODO: Implement user authentication
// FIXME: Handle edge case for empty arrays
// NOTE: This is a temporary solution
// BUG: Memory leak in event listeners
// HACK: Workaround for browser compatibility
// REVIEW: Check performance optimization
// WARNING: This function modifies global state
// INFO: API endpoint changed in v2.0
// DEPRECATED: Use new API instead

Steps to Use

Write any of the supported comment types in your code
Open Explorer → Sticky Notes panel
Click notes to jump directly to them
Hover gutter icons to see note text
All notes are automatically categorized and color-coded

🎨 Supported Comment Types

Comment Type	Color	Icon	Description
`// TODO:`	Sky Blue	📋	Tasks to be completed
`// FIXME:`	Indian Red	🔧	Code that needs fixing
`// NOTE:`	Spring Green	📄	Important information
`// BUG:`	Crimson	🐛	Known bugs or issues
`// HACK:`	Orange	⭐	Temporary workarounds
`// REVIEW:`	Purple	📋	Code that needs review
`// WARNING:`	Gold	⚠️	Potential problems
`// INFO:`	Dodger Blue	ℹ️	General information
`// DEPRECATED:`	Gray	🚫	Outdated code

⚙️ Commands

Command	Description
`stickyNotes.refresh`	Refresh sidebar manually (if needed)
`stickyNotes.revealNote`	Jump to code from sidebar note

🛠️ Tech Used

VS Code API
TypeScript
esbuild

📌 Roadmap

[x] Add multiple comment types (TODO, FIXME, NOTE, BUG, HACK, REVIEW, WARNING, INFO, DEPRECATED)
[x] Color-coded icons for each comment type
[ ] Add filters in sidebar (show only specific types)
[ ] Add support for custom keywords
[ ] Export all notes to Markdown
[ ] Add note categories and tags

🤝 Contributing

Contributions are welcome! Fork → Create Branch → Commit → Pull Request.

Development Setup

Fork the repository

Clone your fork

git clone https://github.com/Ankit628792/sticky-notes.git
cd sticky-notes

Install dependencies
```
npm install
```
Make your changes
Test your changes
```
npm run compile
npm run lint
```

Commit and push

git add .
git commit -m "Description of changes"
git push origin main

Create a Pull Request

📚 Documentation

USAGE.md - Detailed usage guide and examples
README.md - Project overview and setup
LICENSE - MIT License terms

🔗 Links

Repository: https://github.com/Ankit628792/sticky-notes
Issues: https://github.com/Ankit628792/sticky-notes/issues
Releases: https://github.com/Ankit628792/sticky-notes/releases

📜 License

See LICENSE file for details.