Project Structure Finder 📁🔍

Project Structure Finder is a powerful VS Code extension that enables you to scan your workspace, interactively select files, and generate a comprehensive snapshot of your project's architecture. Perfect for sharing project context with AI models, documenting codebases, or creating clean project blueprints.

✨ Key Features

• Interactive Sidebar — A dedicated activity bar panel showing your entire workspace as a live file tree.
• Precision Selection — Use checkboxes to include exactly what you need. Parent folders show indeterminate states when partially selected.
• Rebuild Your Project — New! Recreate the entire folder and file structure from a previously generated structure file.
• Include File Contents — Toggle a global option to embed the full text of selected files directly into the output.
• Smart Noise Filtering — Automatically excludes common clutter like node_modules, .git, dist, and binary files.
• Large File Protection — Configurable size limits ensure the output stays manageable and safe for AI tokens.
• Blazing Fast Performance — Fully asynchronous scanning ensures even massive projects remain responsive.

🚀 Getting Started

1. Open the Panel

Click the Project Structure icon in the VS Code Activity Bar (left-hand side).

2. Select Your Files

Check or uncheck files and folders in the tree view. The extension remembers your selections as you work.

3. Configure Output

Use the toolbar buttons to:

• $(pass-filled) Toggle Contents: Enable or disable embedding file contents.
• $(check-all) Select All: Quickly check all visible files.
• $(close-all) Deselect All: Clear all selections.
• $(refresh) Refresh: Re-scan the workspace for new files.

4. Generate

Click the $(file-code) Generate button. Choose a filename, and your project snapshot is ready!

5. Rebuild

Click the $(repo-clone) Rebuild button to recreate a project structure from an existing text file. Just select your source file and a destination folder.

📄 Output Format Example

The generated file is clean, structured, and easy to read:

================================================================================
  PROJECT STRUCTURE: my-cool-app
  Generated: 2024-05-10T10:30:00.000Z
  File Contents: Included
================================================================================

📁 DIRECTORY TREE
--------------------------------------------------------------------------------
my-cool-app/
├── 📁 src/
│   ├── 📄 main.ts
│   └── 📄 utils.ts
└── 📄 package.json

================================================================================
  FILE CONTENTS
--------------------------------------------------------------------------------
📄 src/main.ts
--------------------------------------------------------------------------------
console.log("Hello World");

--------------------------------------------------------------------------------
📄 package.json
--------------------------------------------------------------------------------
{ "name": "my-cool-app", "version": "1.0.0" }

================================================================================
  SUMMARY
--------------------------------------------------------------------------------
  Folders:              2
  Included Files:       3
================================================================================

⚙️ Configuration

Customize the extension behavior in VS Code Settings (Ctrl+,):

🛠️ Development & Contribution

If you want to contribute or build the extension from source, check out our Development Guide.

📜 License

This project is licensed under the MIT License.