Home

Folder Mapper VSCode Extension

Welcome to the official wiki for Folder Mapper (VSCode Extension)!

Table of Contents

1. Introduction
2. Installation
3. Features
4. Usage
5. Configuration
6. Ignore Patterns
7. Troubleshooting
8. Changelog
9. License

Introduction

Folder Mapper is a tool to generate snapshots of a folder structure. It's the perfect tool for providing AI agents with a project overview or sharing your project's architecture with team members.

Installation

1. Open Visual Studio Code
2. Go to the Extensions view (Ctrl+Shift+X)
3. Search for "Folder Mapper"
4. Click Install
5. Reload Visual Studio Code when prompted

Alternatively, you can install the extension directly from the Visual Studio Code Marketplace.

Features

• 📊 Text-Based Mapping: Generate a comprehensive text-based map of your folder structure.
• 🔍 Depth Control: Customize the mapping depth to focus on specific levels of your project.
• 🚫 Smart Exclusions: Utilize ignore files (.gitignore, .vscignore, .foldermapperignore) to exclude specific files or directories from mapping.
• 🖥️ User-Friendly Interface: Navigate and operate the extension effortlessly through a sleek sidebar interface.
• ⏳ Real-Time Progress: Track the mapping process with a visual progress bar for instant feedback.
• 📂 Flexible Output: Choose your preferred location to save the generated folder structure map.
• 🎨 Theme-Aware Design: Experience a seamless look with UI that automatically adapts to your VS Code theme.
• ⚡ Efficient Performance: Quickly generate maps even for large and complex project structures.

Usage

1. Open the Folder Mapper sidebar in VS Code.
2. Click "Select Folder to Map" to choose the folder you want to map.
3. (Optional) Click "Select Output Folder" to choose where to save the map file.
4. Set the "Depth Limit" if you want to restrict the mapping depth (0 for unlimited).
5. (Optional) Select an ignore file from the dropdown menu to exclude specific files or directories.
6. Click "Start Mapping" to generate the folder structure map.

Ignore Patterns

Folder Mapper supports .gitignore-like exclusion patterns. Create a new .foldermapignore or edit the one created by Folder Mapper at this path: os.homedir/Folder Mapper/Ignore Presets.

Here are some examples:

# Exclude a specific file
ignore_this_file.txt

# Exclude a directory and its contents
node_modules/

# Exclude all files with a specific extension
*.log

# Exclude files that start with a specific prefix
temp_*

# Negate a rule (include a file that would otherwise be excluded)
!important.log

# Exclude files or directories with spaces
"my documents/"

# Exclude a range of files
file[1-3].txt

Troubleshooting

If you encounter any issues while using Folder Mapper, try these steps:

1. Ensure you have the latest version of the extension installed
2. Reload VS Code (File > Reload Window)
3. Check your .foldermapignore file for syntax errors

If problems persist, please open an issue on our GitHub repository.

Please ensure your code adheres to our coding standards and includes appropriate tests.

Changelog

v1.2.31

• Ignore feature: Users can now select and use ignore files (like .gitignore) to exclude specific files or directories from mapping.
• Dropdown menu in the UI for selecting ignore files.
• Resolved an issue where the ignore file feature was not working due to the wrong configuration of the .vscodeignore file.

License

Folder Mapper is released under the MIT License. See the LICENSE file for details.

---

For more information or support, visit our GitHub repository or contact me at [email protected].