Skip to content

README.md

Latest commit

 

History

History
92 lines (66 loc) · 2.61 KB

README.md

File metadata and controls

92 lines (66 loc) · 2.61 KB

🌳 Folder Structure Generator

Quickly create complex folder structures in your VS Code projects with ease! This extension allows you to generate folder and file hierarchies using simple text input, supporting both indented and markdown-style tree formats.

✨ Features

  • 📁 Create folder structures from text input
  • 🔀 Support for indented and markdown-style tree formats
  • 📄 Generate empty files within the structure
  • 📊 Create a report of the generated structure
  • 🚀 Works with your current workspace or any selected folder

📝 Demo

Folder Structure Generator Demo

📥 Installation

  1. Open VS Code
  2. Go to the Extensions view (Ctrl+Shift+X or Cmd+Shift+X)
  3. Search for "Folder Structure Generator"
  4. Click Install

🚀 Usage

  1. Open the Command Palette (Ctrl+Shift+P or Cmd+Shift+P)

  2. Type "Generate Folder Structure" and select the command

  3. In the new document that opens, enter your desired folder structure using either of these formats:

    Indented format:

    src/
    app/
        layout.js
        page.js
    components/
        Button.js
        Header.js

    Markdown-style tree format:

    src
├── app
│   ├── layout.js
│   └── page.js
└── components
    ├── Button.js
    └── Header.js

  4. Run the "Process Folder Structure" command from the Command Palette

  5. Select the folder where you want to create the structure

  6. 🎉 The extension will create the folder structure and show a summary

👥 Contributing

We welcome contributions to the Folder Structure Generator! Here's how you can help:

  1. 🍴 Fork the repository
  2. 🌿 Create a new branch for your feature or bug fix
  3. 🛠️ Make your changes
  4. ✅ Write or update tests as necessary
  5. 🧪 Ensure all tests pass
  6. 📤 Submit a pull request with a clear description of your changes

🛠️ Development Setup

  1. Clone the repository
  2. Run npm install to install dependencies
  3. Open the project in VS Code
  4. Press F5 to start debugging and test your changes

📝 Coding Guidelines

  • Follow the existing code style
  • Write clear, commented code
  • Update documentation for any new features or changes

💬 Feedback and Issues

If you encounter any issues or have suggestions for improvements, please open an issue on our GitHub repository. We'd love to hear from you! 😊

📜 License

This project is licensed under the MIT License - see the LICENSE file for details.

Made with ❤️ from Pakistan 🇵🇰

Thank you for using and contributing to Folder Structure Generator! 🙏