ASCII Project Tree Generator

A powerful Node.js command-line tool that generates beautiful ASCII directory tree structures for your projects. Perfect for documentation, AI / vibe coding and sharing your project structure.

✨ Features

• 🌳 Hierarchical .gitignore parsing - Finds ALL .gitignore files in your project and applies them exactly like git does
• 🎯 Git-like behavior - Root .gitignore applies globally, subdirectory .gitignore files only affect their scope
• 🔍 Smart directory skipping - Won't search for .gitignore files in already ignored directories (no more third-party noise!)
• 📁 Flexible filtering - Include/exclude files using regex patterns
• 📊 Directory depth control - Limit how deep the tree goes
• 🐛 Debug mode - See exactly what gets matched by your patterns and .gitignore files
• 💾 Custom output - Save to any file location with custom naming
• 🚀 Dry run mode - Preview results before saving the file
• ⚡ Fast and lightweight - No external dependencies

📦 Installation

Global Installation (Recommended)

npm install -g ascii-tree-generator

Local Installation

npm install ascii-tree-generator

Or use directly with npx

npx ascii-tree-generator

🚀 Quick Start

Generate a tree for your current project:

ascii-tree-generator

This creates project-ascii-tree.txt in your current directory with output like:

my-project/
├── src/
│ ├── components/
│ │ ├── Header.js
│ │ └── Footer.js
│ ├── utils/
│ │ └── helpers.js
│ └── index.js
├── package.json
└── README.md

🎯 Hierarchical .gitignore Support

This tool now works exactly like git when it comes to .gitignore files!

How it works:

• 🔍 Finds ALL .gitignore files in your project recursively
• 📂 Applies them hierarchically - root .gitignore affects everything, subdirectory .gitignore files only affect their subdirectory and below
• 🚫 Skips ignored directories - won't read .gitignore files from node_modules, .venv, or other ignored directories
• ✅ Handles negation patterns (!) correctly to override parent directory patterns

Example project structure:

my-fullstack-project/
├── .gitignore              (affects entire project)
├── frontend/
│   ├── .gitignore          (affects only frontend/ and below)
│   ├── src/
│   └── dist/               (ignored by frontend/.gitignore)
├── backend/
│   ├── .gitignore          (affects only backend/ and below)
│   ├── api/
│   └── uploads/            (ignored by backend/.gitignore)
└── node_modules/           (ignored by root .gitignore)

When you run the tool, you'll see:

Found 3 .gitignore file(s) with 25 total patterns:
  - root: 8 patterns
  - frontend: 12 patterns  
  - backend: 5 patterns

No more noise from third-party .gitignore files in dependencies! 🎉

🔧 Git Integration

Git Hooks Example

Perfect for keeping your project documentation up-to-date! Add this to your git hooks:

Post-commit hook (.git/hooks/post-commit):

#!/bin/sh
# Change to the project root directory
cd "$(git rev-parse --show-toplevel)"

# Option 1: If globally installed
ascii-tree-generator

# Option 2: If installed locally
./node_modules/.bin/ascii-tree-generator

# Option 3: Using npx (always works)
npx ascii-tree-generator

# Option 4: Different output location for docs
ascii-tree-generator --output-path ./docs/ --output-name "project-structure.txt"

Pre-push hook (.git/hooks/pre-push):

#!/bin/sh
# Generate fresh tree before pushing
cd "$(git rev-parse --show-toplevel)"
npx ascii-tree-generator --output-name "current-structure.txt"
git add current-structure.txt
echo "📁 Project structure updated"

Package.json Scripts

Add to your package.json:

{
  "scripts": {
    "tree": "ascii-tree-generator",
    "tree:docs": "ascii-tree-generator --output-path ./docs/ --include-pattern '\\.(md|txt|json)$'",
    "tree:src": "ascii-tree-generator --include-pattern 'src/' --max-depth 4"
  }
}

Then run:

npm run tree
npm run tree:docs
npm run tree:src

📖 Usage Examples

Basic Usage

# Generate tree with default settings
ascii-tree-generator

# Preview without creating file
ascii-tree-generator --dry-run

# Include all files (ignore ALL .gitignore files)
ascii-tree-generator --all

Filtering Examples

# Only show JavaScript and TypeScript files
ascii-tree-generator --include-pattern "\.(js|ts)$"

# Only show source code (exclude tests)
ascii-tree-generator --exclude-pattern "test|spec"

# Show only files in src/ directory
ascii-tree-generator --include-pattern "src/"

# Exclude temporary and log files
ascii-tree-generator --exclude-pattern "\.(tmp|log)$"

Depth and Output Control

# Limit to 2 levels deep
ascii-tree-generator --max-depth 2

# Custom output file and location
ascii-tree-generator --output-name "structure.txt" --output-path "./docs/"

# Exclude specific directories
ascii-tree-generator --except-dir "node_modules, build, dist"

# Exclude specific files
ascii-tree-generator --except-file "README.md, script.js"

Advanced Examples

# Only source files, limited depth
ascii-tree-generator --include-pattern "\.(js|ts|jsx|tsx|json)$" --max-depth 3

# Debug your patterns and .gitignore processing
ascii-tree-generator --debug --include-pattern "component"

# Generate tree for specific file types with custom output
ascii-tree-generator --include-pattern "\.(md|txt|json)$" --output-name "docs-structure.txt"

⚙️ Command Line Options

| Option | Description | Example | |--------|-------------|---------| | --all | Include all files (ignore ALL .gitignore files) | --all | | --except-dir | Additional directories to ignore | --except-dir "build,dist" | | --except-file | Additional files to ignore | --except-file "*.log,*.tmp" | | --output-name | Custom output filename | --output-name "my-tree.txt" | | --output-path | Custom output directory | --output-path "./docs/" | | --dry-run | Preview without creating file | --dry-run | | --debug | Show pattern matching and .gitignore debug info | --debug | | --max-depth | Maximum directory depth | --max-depth 3 | | --include-pattern | Regex to include files | --include-pattern "\.js$" | | --exclude-pattern | Regex to exclude files/dirs | --exclude-pattern "\.tmp$" | | --help, -h | Show help message | --help |

🎯 Pattern Matching Guide

Include Patterns (Files Only)

Include patterns only apply to files, not directories. Directories are shown for structure.

# JavaScript files only
--include-pattern "\.js$"

# Multiple file types
--include-pattern "\.(js|ts|json)$"

# Files containing 'component' in name
--include-pattern "component"

# Files in specific directory
--include-pattern "src/"

Exclude Patterns (Files & Directories)

Exclude patterns apply to both files and directories.

# Exclude test files and directories
--exclude-pattern "test|spec"

# Exclude by file extension
--exclude-pattern "\.(tmp|log|cache)$"

# Exclude by directory name
--exclude-pattern "build|dist|coverage"

Regex Tips

• Use single backslash while using CLI: "\.js$" not "\\.js$"
• Quote your patterns to avoid shell interpretation
• Use --debug to test your patterns
• $ means end of string, ^ means start of string

🔧 Programmatic Usage

You can also use this tool in your Node.js applications:

const { AsciiTreeGenerator } = require('ascii-tree-generator');

const generator = new AsciiTreeGenerator({
  includePattern: '\\.js$',
  maxDepth: 3,
  outputName: 'custom-tree.txt',
  dryRun: false
});

generator.run();

Configuration Options

const options = {
  all: false, // Include all files (ignore .gitignore files)
  exceptDirs: [], // Additional dirs to ignore
  exceptFiles: [], // Additional files to ignore
  outputName: 'project-ascii-tree.txt',
  outputPath: '.', // Output directory
  dryRun: false, // Preview mode
  maxDepth: Infinity, // Directory depth limit
  includePattern: null, // Regex for including files
  excludePattern: null, // Regex for excluding files/dirs
  debug: false // Show debug information
};

📝 .gitignore Behavior

This tool replicates git's .gitignore behavior exactly:

Hierarchical Application

• Root .gitignore applies to the entire project
• Subdirectory .gitignore files only apply to their subdirectory and below
• Patterns are applied in order from root → most specific directory
• Negation patterns (!) work correctly to override parent directory patterns

Smart Directory Skipping

• ✅ Won't search for .gitignore files in directories that are already ignored
• ✅ Skips deep recursion into node_modules, .venv, etc.
• ✅ Eliminates noise from third-party .gitignore files

Example Output

Found 2 .gitignore file(s) with 15 total patterns:
  - root: 8 patterns
  - frontend: 7 patterns

📊 Output Formats

The tool generates clean, readable ASCII trees:

project-name/
├── src/
│ ├── components/
│ │ ├── Header.js
│ │ ├── Footer.js
│ │ └── Navigation.js
│ ├── utils/
│ │ ├── helpers.js
│ │ └── constants.js
│ └── index.js
├── tests/
│ └── app.test.js
├── package.json
├── README.md
└── .gitignore

🐛 Troubleshooting

Common Issues

Pattern not matching anything?

• Use --debug to see what your pattern is matching
• Remember to escape special regex characters
• Test with simple patterns first

Too many .gitignore files being found?

• This was fixed in v1.1.0! The tool now skips .gitignore files in ignored directories
• Use --debug to see which .gitignore files are being processed

Different results than expected?

• The tool now works exactly like git - check your .gitignore hierarchy
• Use --debug to see how patterns are being applied

Debug Mode

Use --debug to see detailed information about .gitignore processing and pattern matching:

ascii-tree-generator --debug --include-pattern "\.js$"

This shows:

• Which .gitignore files are found and processed
• Which patterns are being applied to each file/directory
• Why files are included or excluded
• How hierarchical .gitignore rules are applied

🤝 Contributing

We welcome contributions! Please see our Contributing Guide for details.

📄 License

This project is licensed under the MIT License.

🔗 Links

• npm package
• Issue Tracker
• Changelog

Made with ❤️ by Maciej Popenda for the developer community