https://github.com/kamrulislambappy/generate-folder-tree
A simple Node.js script to generate a visually organized tree view of your project folder structure, excluding common unwanted directories like `node_modules`, `.git`, `.next`, and `.turbo`. This tool helps developers quickly visualize and document their project layout in the terminal or export it to a file.
https://github.com/kamrulislambappy/generate-folder-tree
folder-tree javascript
Last synced: 11 months ago
JSON representation
A simple Node.js script to generate a visually organized tree view of your project folder structure, excluding common unwanted directories like `node_modules`, `.git`, `.next`, and `.turbo`. This tool helps developers quickly visualize and document their project layout in the terminal or export it to a file.
- Host: GitHub
- URL: https://github.com/kamrulislambappy/generate-folder-tree
- Owner: kamrulislambappy
- License: mit
- Created: 2025-08-05T06:02:13.000Z (11 months ago)
- Default Branch: main
- Last Pushed: 2025-08-05T06:09:33.000Z (11 months ago)
- Last Synced: 2025-08-05T08:19:19.856Z (11 months ago)
- Topics: folder-tree, javascript
- Language: JavaScript
- Homepage:
- Size: 5.86 KB
- Stars: 0
- Watchers: 0
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# ✦ generate-folder-tree ✦
A simple Node.js script to generate a visually organized tree view of your project folder structure, excluding common unwanted directories like `node_modules`, `.git`, `.next`, and `.turbo`. This tool helps developers quickly visualize and document their project layout in the terminal or export it to a file.
---
## ✦ Features
- ✦ Recursively lists all directories and files
- ✦ Sorts directories and files alphabetically
- ✦ Excludes common large or irrelevant folders (`node_modules`, `.git`, etc.)
- ✦ Prints a tree structure similar to the Unix `tree` command
- ✦ Outputs to console or can be redirected to a file
---
## ✦ Prerequisites
- ✦ Node.js installed (v12 or higher recommended)
- ✦ Basic familiarity with running scripts in the terminal
---
## ✦ Installation & Usage
1. Clone or download this repository to your local machine:
```bash
git clone https://github.com/kamrulislambappy/generate-folder-tree.git
cd generate-folder-tree
```
2. Run this script in project root using:
```bash
node generate-tree.js
```