RepoInsight README
🚀 Overview
RepoInsight is a VS Code extension that analyzes your project and generates a visual, interactive report including:
- 📁 Folder structure (tree view)
- 📊 Total files & lines of code
- 📦 Dependencies
- 🧠 Tech share (based on file extensions)
- 🎯 Interactive filtering + highlighting
- 📈 Pie chart visualization (Chart.js)
🛠️ Usage
- Open any project folder in VS Code
- Press
Ctrl+Shift+P (or Cmd+Shift+P on Mac)
- Run command: RepoInsight: Analyze Project
- View generated report in a WebView panel
Features
📁 Project Structure Viewer
- Displays complete folder & file hierarchy
- Clean tree format with icons
📊 Code Statistics
- Total number of files
- Total lines of code (LOC)
📦 Dependency Analysis
- Reads
package.json
- Lists all dependencies
📈 Tech Share Visualization
- Calculates % of code per file type
- Displays:
- List view
- Pie chart (Chart.js)
🎯 Interactive Filters
- Filter files by extension
- Highlights matching files in structure
🔐 Safe Webview Rendering
- Uses Content Security Policy (CSP)
- Prevents unsafe script injection
⚙️ Requirements
- VS Code
^1.80.0 (or compatible)
- Node.js environment (for development)
- A project folder open in VS Code
🔧 Extension Settings
Currently, RepoInsight does not add custom settings.
⚠️ Known Issues
- Large projects may take time to analyze
- Binary files may slightly affect LOC count
- Only detects dependencies from
package.json
- Tech detection is based on file extensions (not frameworks)
📝 Release Notes
1.0.0
- Initial release
- Folder structure visualization
- LOC & file count
- Dependency listing
- Tech share calculation
- Interactive filters
- Chart visualization
🧑💻 Author
Ananya Suresh Nambiar
🎉 Enjoy using RepoInsight!
| |
