Skip to content

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

Notifications You must be signed in to change notification settings

ayan-de/hover-explainer

Repository files navigation

📁 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:

code --install-extension ayan-de.hover-docs

About

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

Resources

Stars

Watchers

Forks

Packages

No packages published