Skip to content

A VS Code extension that generates a project file tree, allowing users to copy it to the clipboard or insert it into a README.md file.

License

Notifications You must be signed in to change notification settings

psparwez/file-tree

Repository files navigation

File tree

File Tree Structure

This extension allows you to generate and visualize the file tree of a project, which can be copied to the clipboard or inserted into a README.md file.

⚙️ Features

  • Generate a file tree of your project directory.
  • Option to copy the file tree to the clipboard.
  • Option to insert the file tree into your README.md.

📑 Demo


├── /public
│   └── index.html
├── /src
│   ├── /assets
│   ├── /components
│   │   └── App.tsx
│   ├── /styles
│   │   └── app.css
│   ├── index.tsx
│   └── react-app-env.d.ts
├── .gitignore
├── package.json
├── tsconfig.json
└── README.md

🛠️ Installation

  1. Clone the repository:
git clone https://github.com/psparwez/file-tree.git
  1. Open the project in Visual Studio Code.

  2. Install the dependencies:

  3. Run the extension via the Command Palette.

💻 Usage

Use the command palette (Ctrl+Shift+P or Cmd+Shift+P on macOS) and search for Generate File Tree. Choose where to insert the file tree (clipboard or README.md).

🤝 Contributing

  1. Fork the repository.
  2. Create a new branch (git checkout -b feature-name).
  3. Commit your changes (git commit -am 'Add new feature').
  4. Push to the branch (git push origin feature-name).
  5. Create a new pull request.

📜 License

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

About

A VS Code extension that generates a project file tree, allowing users to copy it to the clipboard or insert it into a README.md file.

Topics

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published