dirmapper 1.0.6

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.
• Support for various output styles and formats.

Installation

Using Homebrew

You can install dirmapper using Homebrew:

brew tap nashdean/dirmap
brew install dirmapper

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

NOTE: By default, the CLI ships with a .mapping-ignore file that will ignore the following:

.git/

This file can be overridden by specifying your own .mapping-ignore file (named anything you want) using the flag specified earlier --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

Show Version

To display the version of dirmapper:

dirmap --version

or

dirmap -v

Specify Sorting Order

To generate a directory structure with ascending order:

dirmap /path/to/root_directory /path/to/output_file --sort asc

To generate a directory structure with descending order:

dirmap /path/to/root_directory /path/to/output_file --sort desc

Specify Output Style and Format

You can specify the style and format of the output using --style and --format options. Available styles include tree, indentation, flat_list, markdown, html, and json. Available formats include plain, html, and json.

Example: HTML Style with HTML Format

dirmap /path/to/root_directory /path/to/output_file --style html --format html

Running All Styles with Their Respective Formats

mkdir -p ./style_outputs
dirmap . ./style_outputs/indentation_output.txt --sort asc --style indentation
dirmap . ./style_outputs/flat_list_output.txt --sort asc --style flat_list
dirmap . ./style_outputs/html_output.html --sort asc --style html --format html
dirmap . ./style_outputs/json_output.json --sort asc --style json --format json
dirmap . ./style_outputs/markdown_output.md --sort asc --style markdown
dirmap . ./style_outputs/tree_output.txt --sort asc --style tree

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

Troubleshooting

Homebrew

If you have previously tapped and installed the dirmapper package, here’s how you can uninstall and untap it:

1. Uninstall the Package:

brew uninstall dirmapper

2. Untap the Repository:

brew untap nashdean/dirmap

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