This project is a CLI tool that maps the folder structure of a directory and generates an output file with a customizable name based on a template. The main purpose of this tool is to provide a clear and concise representation of the folder structure, taking into account exclusions defined in the .gitignore file to avoid displaying specific files. Skip the files until you find another .gitignore file. From that path onwards, exclude the files specified in this new file.

Back to top 🔼

Folder map and example of use:

/
├── .devcontainer/
│     ├── Dockerfile
│     └── devcontainer.json
├── .github/
│     └── workflows/
│          ├── pylint.yml
│          └── update_readme.yml
├── src/
│     ├── __init__.py
│     ├── args.py
│     ├── exceptions.py
│     ├── map_folders.py
│     └── short_folders.py
├── .dockerignore
├── .gitignore
├── Dockerfile
├── LICENSE
├── Pipfile
├── Pipfile.lock
├── README.md
├── README.md.template
├── action.yml
├── index.py
└── requirements.txt

Back to top 🔼

• Example of using workflow in README.md.template

• Example of using template in update_readme.yml

- uses: RomanFama592/folder_mapping_action@v1
  with:
    path-directory:
    description: "Path to the directory for folder mapping."
    default: "./"

    template-output:
    description: "Path to the template file for README.md generation."
    default: "./README.md.template"
    
    path-output:
    description: "Path where the generated README.md file will be saved."
    default: "./README.md"

    search-word:
    description: "Keyword or search term in the template file for folder mapping."
    default: "map_folder"

In your template put %{{ + your search word + }}% to find where you want to put the map folder.

Back to top 🔼

Contributions are what make the Open Source community such an amazing place to learn, inspire, and create. Any contributions you make are greatly appreciated.

If you have a suggestion that would make this better, please fork the repo and create a Pull Request. You can also simply open an issue

Don't forget to give the project a star ⭐! Thanks again!

1. Fork the project

2. Clone your fork

git clone https://github.com/@your_username/folder_mapping_action

3. Install pipenv

pip install pipenv

4. Install dependencies

pipenv install --dev

5. Open enviroment of Python

pipenv shell

6. Create your Feature Branch

git checkout -b feature/AmazingFeature

7. Push to the Branch

git push origin feature/AmazingFeature

8. Open a Pull Request

Important: Use "conventional commits" and ensure that the code passes the linter test, pull requests are not accepted without this last point.

Back to top 🔼

Distributed under the MIT License. See LICENSE for more information.

Back to top 🔼

Famá Román

• famaroman@gmail.com
• Linkedin

Back to top 🔼