https://github.com/psparwez/file-tree
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.
https://github.com/psparwez/file-tree
developer-tools ducumentation extensions file-structures file-tree marketplace typescript vscode vscode-extension
Last synced: 3 months ago
JSON representation
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.
- Host: GitHub
- URL: https://github.com/psparwez/file-tree
- Owner: psparwez
- License: mit
- Created: 2024-12-23T04:02:37.000Z (5 months ago)
- Default Branch: main
- Last Pushed: 2024-12-23T06:58:44.000Z (5 months ago)
- Last Synced: 2025-01-05T10:12:44.888Z (5 months ago)
- Topics: developer-tools, ducumentation, extensions, file-structures, file-tree, marketplace, typescript, vscode, vscode-extension
- Language: TypeScript
- Homepage:
- Size: 41 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
Awesome Lists containing this project
README
# 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:
```bash
git clone https://github.com/psparwez/file-tree.git
```
2. Open the project in Visual Studio Code.
3. Install the dependencies:
4. 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](https://github.com/psparwez/file-tree/tree/main?tab=MIT-1-ov-file) file for details.