Project Structure Generator For AI

A Visual Studio Code extension that generates a tree-like view of your project's file structure as a markdown file, perfect for documentation and AI context sharing.

Features

This extension adds a command to generate a comprehensive visual representation of your project structure:

• Creates a clean tree-like view of your project files and directories
• Automatically excludes common directories like .git, node_modules, .vscode, dist, and build
• Outputs the result as a user-friendly markdown file (configurable name)
• Directories are sorted first, followed by files, all in alphabetical order
• Supports custom exclusion patterns via .structureignore file
• Supports wildcard patterns for file/directory exclusion
• Automatically opens the generated file after creation

Usage

1. Open a project folder in VSCode
2. Open the Command Palette (Ctrl+Shift+P or Cmd+Shift+P on macOS)
3. Type and select "Generate Project Structure"
4. The extension will create a structure file in your project root and open it

Customizing Excluded Files/Directories

You can create a .structureignore file in your project root to specify additional files or directories to exclude:

# This is a comment
temp
*.log
build-*

This will exclude:

• Any file or directory named "temp"
• Any file with a ".log" extension
• Any file or directory starting with "build-"

Extension Settings

This extension contributes the following settings:

• projectStructure.outputFileName: The name of the output file (default: "structure.md")
• projectStructure.defaultExcludes: Default directories and files to exclude from the structure

Example Output

# Project Structure

my-project
├── src
│   ├── components
│   │   ├── Header.js
│   │   └── Footer.js
│   └── utils
│       └── helpers.js
├── public
│   ├── index.html
│   └── style.css
└── package.json

Requirements

• Visual Studio Code 1.74.0 or higher

Known Issues

No known issues at this time.

Release Notes

0.0.2 (Latest)

• New Feature: Configurable output file name via settings
• New Feature: Custom file/directory exclusion via .structureignore file
• New Feature: Wildcard pattern support for file exclusions
• Improvement: Automatically opens the generated file after creation

0.0.1

• Initial release
• Basic functionality to generate project structure as markdown

Enjoy using Project Structure Generator For AI!