https://github.com/ayan-de/hover-explainer
VS Code extension to display the purpose and importance of files and folders when you hover over them. Powered by a .fileDescriptions.json file auto-managed by the extension.For Beginner who want to read long code bases
https://github.com/ayan-de/hover-explainer
Last synced: 4 months ago
JSON representation
VS Code extension to display the purpose and importance of files and folders when you hover over them. Powered by a .fileDescriptions.json file auto-managed by the extension.For Beginner who want to read long code bases
- Host: GitHub
- URL: https://github.com/ayan-de/hover-explainer
- Owner: ayan-de
- Created: 2025-06-11T05:55:18.000Z (about 1 year ago)
- Default Branch: master
- Last Pushed: 2025-06-19T22:09:06.000Z (about 1 year ago)
- Last Synced: 2025-06-19T23:20:15.982Z (about 1 year ago)
- Language: TypeScript
- Homepage:
- Size: 1.45 MB
- Stars: 1
- Watchers: 0
- Forks: 0
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
Awesome Lists containing this project
README
# 📁 hover-explainer — Understand Your Project at a Glance
`hover-explainer` is a lightweight VS Code extension that shows contextual tooltips on hover over files and folders in the Explorer. Ideal for large teams, onboarding, and open source contributors.
### 🛠 Features
- 📝 Hover over any file/folder to see its description
- ⚙️ `.fileDescriptions.json` is auto-maintained:
- Automatically adds new files/folders
- Removes deleted ones
- Updates on rename
- ✅ Simple JSON-based config, easily version-controlled
- 🔍 Helps you understand codebase structure at a glance
### 📂 How it Works
1. On first use, the extension creates a `.fileDescriptions.json` file in your root directory.
2. When files/folders are created, renamed, or deleted, the file is updated automatically.
3. Add or edit descriptions manually in that JSON file.
### 📸 Screenshot
> _Include a screenshot or gif here showing the tooltip hover in the file explorer._
### 🚀 Installation
Search for `hover-docs` in the VS Code Marketplace or install via CLI:
```bash
code --install-extension ayan-de.hover-docs
```