Skip to content

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.

License

Notifications You must be signed in to change notification settings

kamrulislambappy/generate-folder-tree

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

5 Commits
 
 
 
 
 
 

Repository files navigation

✦ 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:

    git clone https://github.com/kamrulislambappy/generate-folder-tree.git
    cd generate-folder-tree
  2. Run this script in project root using:

    node generate-tree.js

About

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.

Topics

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published