dirmapper 1.0.5

A CLI tool to generate a directory structure mapping.

Dirmapper

Dirmapper is a CLI tool to generate a directory structure mapping. It provides a visual representation of the directory and file structure, similar to the tree command, with support for .gitignore-like patterns to exclude specific files and directories.

Features

• Generate a hierarchical view of a directory structure.
• Support for .mapping-ignore file to exclude files and directories.
• Optional integration with .gitignore to exclude patterns specified in .gitignore.

Installation

Using pipx

It is recommended to use pipx to install dirmapper in an isolated environment:

pipx install dirmapper

Using pip

You can also install dirmapper using pip:

pip install dirmapper

Usage

Basic Usage

To generate a directory structure mapping:

dirmap /path/to/root_directory /path/to/output_file

Exclude Patterns with .mapping-ignore

Create a .mapping-ignore file in the root directory and specify the patterns you want to exclude:

.git/
*.tmp
*.log

Then run:

dirmap /path/to/root_directory /path/to/output_file --ignore_file /path/to/.mapping-ignore

Disable .gitignore Integration

By default, dirmap will also consider patterns in .gitignore. To disable this feature:

dirmap /path/to/root_directory /path/to/output_file --ignore_file /path/to/.mapping-ignore --no_gitignore

Example

Sample Directory Structure

project/
├── .git/
│   └── config
├── .github/
│   └── workflows/
│       └── ci.yml
├── src/
│   ├── main.py
│   ├── utils.py
└── README.md

Sample .mapping-ignore

.git/
.github/

Command

dirmap project output.txt --ignore_file project/.mapping-ignore

Sample Output

project/
├── src/
│   ├── main.py
│   └── utils.py
└── README.md

Development

Running Tests

Tests are written using pytest. To run the tests:

1. Install the development dependencies:

pip install -e .[dev]

2. Run the tests:

pytest

Contributing

Contributions are welcome! Please feel free to submit a pull request or open an issue on GitHub.

License

This project is licensed under the MIT License. See the LICENSE file for details.

Author

Nash Dean

• GitHub
• Email