Keywords:
directory-tree
,folder-structure
,file-explorer
,project-visualization
,markdown-generator
,documentation-tool
,dev-utility
,file-system-scanner
Generate beautiful folder structure visualizations with tech-specific icons for documentation, sharing, or analysis.
- π Creates clear, readable folder structure visualizations
- πΌοΈ Tech-specific icons for different file types
- π Summary statistics of files and folders
- βοΈ Customizable depth and ignore patterns
- πΎ Saves output as a Markdown file
- π¨ Colorized terminal output
npm install -g structure-maker
npm install structure-maker
Navigate to the directory you want to visualize and run:
structure-maker
This will:
- Generate a tree visualization of your current directory
- Create a
folder-structure.md
file with detailed documentation - Display a colorized version of the tree in your terminal
Option | Description |
---|---|
--depth |
Maximum depth to traverse (default: infinite) |
--ignore |
Comma-separated patterns to ignore |
Limit directory depth:
structure-maker --depth 2
Ignore specific folders or files:
structure-maker --ignore dist,build,temp
Combine options:
structure-maker --depth 3 --ignore logs,temp
The tool generates a Markdown file (folder-structure.md
) with:
- Directory statistics (files and folders count)
- Breakdown of file types
- Complete directory tree with file sizes
Example terminal output:
project-root/
ββ π src
β ββ π components
β β ββ π» Button.js (2.3 KB)
β β ββ π» Header.js (1.7 KB)
β ββ π» index.js (0.5 KB)
ββ π docs
β ββ π README.md (3.2 KB)
ββ π package.json (1.1 KB)
Extension | Icon | Description |
---|---|---|
.js , .ts , .py , .java
|
π» | Code files |
.md , .txt
|
π | Text documents |
.json |
π | Data files |
.jpg , .png , .gif
|
πΌοΈ | Image files |
.mp4 , .avi
|
π₯ | Video files |
.mp3 , .wav
|
π΅ | Audio files |
.pdf , .docx
|
π | Document files |
Other | π | Generic files |
Contributions are welcome and appreciated! Here's how you can contribute:
- Use the GitHub Issues tab to report bugs or suggest features
- Clearly describe the issue including steps to reproduce when it is a bug
- Make sure to include your environment details (OS, Node.js version)
- Fork the repository
- Create your feature branch (
git checkout -b feature/amazing-feature
) - Make your changes
- Run tests if available
- Commit your changes (
git commit -m 'Add some amazing feature'
) - Push to the branch (
git push origin feature/amazing-feature
) - Open a Pull Request
- Add more file type icons
- Improve the markdown output formatting
- Add export options for different formats (JSON, HTML, etc.)
- Create a web UI version
- Add stats visualization
- Improve performance for large directories
- Maintain the existing code style
- Add comments for complex logic
- Update documentation as needed
This project is licensed under the ISC License - see the LICENSE file for details.
Chauhan Yuvraj
Made with β€οΈ for developers who love clean documentation