{"id":15987645,"url":"https://github.com/romanfama592/folder_mapping_action","last_synced_at":"2026-04-21T22:35:30.397Z","repository":{"id":205567654,"uuid":"714555404","full_name":"RomanFama592/folder_mapping_action","owner":"RomanFama592","description":"Incorporate or update the folder mapping information in the README.md file and using the \".gitignore\" to ignore files. Everything automatically and little configuration.","archived":false,"fork":false,"pushed_at":"2023-11-14T05:21:42.000Z","size":28,"stargazers_count":0,"open_issues_count":3,"forks_count":0,"subscribers_count":1,"default_branch":"main","last_synced_at":"2025-02-10T06:42:09.038Z","etag":null,"topics":["actions","docs-generator","folder-structure","gitignore","pipenv","python","workflows"],"latest_commit_sha":null,"homepage":"","language":"Python","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/RomanFama592.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2023-11-05T07:45:43.000Z","updated_at":"2023-11-14T05:34:04.000Z","dependencies_parsed_at":"2024-10-08T03:41:17.122Z","dependency_job_id":"9bc8f85b-2908-4949-be66-681f23b06f1b","html_url":"https://github.com/RomanFama592/folder_mapping_action","commit_stats":null,"previous_names":["romanfama592/folder_mapping_action"],"tags_count":1,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/RomanFama592%2Ffolder_mapping_action","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/RomanFama592%2Ffolder_mapping_action/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/RomanFama592%2Ffolder_mapping_action/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/RomanFama592%2Ffolder_mapping_action/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/RomanFama592","download_url":"https://codeload.github.com/RomanFama592/folder_mapping_action/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":247256116,"owners_count":20909240,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["actions","docs-generator","folder-structure","gitignore","pipenv","python","workflows"],"created_at":"2024-10-08T03:41:06.248Z","updated_at":"2026-04-21T22:35:25.341Z","avatar_url":"https://github.com/RomanFama592.png","language":"Python","funding_links":[],"categories":[],"sub_categories":[],"readme":"\u003cdiv align=\"center\"\u003e\n\n# Folder Mapping\n![Contributions? Welcome](https://img.shields.io/badge/Contributions-Welcome-brightgreen.svg)\n![Maintained? Yes](https://img.shields.io/badge/Maintained%3F-Yes-brightgreen.svg)\n[![Pylint](https://github.com/RomanFama592/folder_mapping_action/actions/workflows/pylint.yml/badge.svg)](https://github.com/RomanFama592/folder_mapping_action/actions/workflows/pylint.yml)\n[![readme_updated](https://github.com/RomanFama592/folder_mapping_action/actions/workflows/update_readme.yml/badge.svg)](https://github.com/RomanFama592/folder_mapping_action/actions/workflows/update_readme.yml)\n\n\u003c/div\u003e\n\nThis 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.\n\n\u003cdetails\u003e\n  \u003csummary\u003e📑 \u003cstrong\u003eContents\u003c/strong\u003e\u003c/summary\u003e\n  \u003col\u003e\n    \u003cli\u003e\u003ca href=\"#project-structure\"\u003e🚀 \u003cstrong\u003eProject Structure\u003c/strong\u003e\u003c/a\u003e\u003c/li\u003e\n    \u003cli\u003e\u003ca href=\"#usage\"\u003e✨ \u003cstrong\u003eUsage\u003c/strong\u003e\u003c/a\u003e\u003c/li\u003e\n    \u003cli\u003e\u003ca href=\"#contributions\"\u003e👋 \u003cstrong\u003eContributions\u003c/strong\u003e\u003c/a\u003e\u003c/li\u003e\n    \u003cli\u003e\u003ca href=\"#license\"\u003e👨‍⚖️ \u003cstrong\u003eLicense\u003c/strong\u003e\u003c/a\u003e\u003c/li\u003e\n    \u003cli\u003e\u003ca href=\"#contact-me\"\u003e📬 \u003cstrong\u003eContact me\u003c/strong\u003e\u003c/a\u003e\u003c/li\u003e\n  \u003c/ol\u003e\n\u003c/details\u003e\n\n\u003cbr\u003e\n\n\u003cp align=\"right\"\u003e\u003ca href=\"#top\"\u003eBack to top 🔼\u003c/a\u003e\u003c/p\u003e\n\u003cbr\u003e\n\n## 🚀 Project Structure\n\nFolder map and example of use:\n\n```\n/\n├── .devcontainer/\n│     ├── Dockerfile\n│     └── devcontainer.json\n├── .github/\n│     └── workflows/\n│          ├── pylint.yml\n│          └── update_readme.yml\n├── src/\n│     ├── __init__.py\n│     ├── args.py\n│     ├── exceptions.py\n│     ├── map_folders.py\n│     └── short_folders.py\n├── .dockerignore\n├── .gitignore\n├── Dockerfile\n├── LICENSE\n├── Pipfile\n├── Pipfile.lock\n├── README.md\n├── README.md.template\n├── action.yml\n├── index.py\n└── requirements.txt\n\n```\n\n\u003cp align=\"right\"\u003e\u003ca href=\"#top\"\u003eBack to top 🔼\u003c/a\u003e\u003c/p\u003e\n\u003cbr\u003e\n\n## ✨ Usage\n\n- **Example of using workflow in [README.md.template](https://github.com/RomanFama592/folder_mapping_action/blob/main/README.md.template)**\n\n- **Example of using template in [update_readme.yml](https://github.com/RomanFama592/folder_mapping_action/blob/main/.github/workflows/update_readme.yml)**\n\n```yaml\n- uses: RomanFama592/folder_mapping_action@v1\n  with:\n    path-directory:\n    description: \"Path to the directory for folder mapping.\"\n    default: \"./\"\n\n    template-output:\n    description: \"Path to the template file for README.md generation.\"\n    default: \"./README.md.template\"\n    \n    path-output:\n    description: \"Path where the generated README.md file will be saved.\"\n    default: \"./README.md\"\n\n    search-word:\n    description: \"Keyword or search term in the template file for folder mapping.\"\n    default: \"map_folder\"\n```\n\n_In your template put `%{{` + your **search word** + `}}%` to find where you want to put the map folder._\n\n\n\u003cp align=\"right\"\u003e\u003ca href=\"#top\"\u003eBack to top 🔼\u003c/a\u003e\u003c/p\u003e\n\u003cbr\u003e\n\n## 👋 Contributions\n\nContributions are what make the Open Source community such an amazing place to learn, inspire, and create. Any contributions you make are **greatly appreciated**.\n\nIf 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](https://github.com/RomanFama592/folder_mapping_action/issues)\n\nDon't forget to **give the project a star ⭐!** Thanks again!\n\n1. Fork the project\n\n2. Clone your fork\n\n```bash\ngit clone https://github.com/@your_username/folder_mapping_action\n```\n\n3. Install `pipenv`\n\n```bash\npip install pipenv\n```\n\n4. Install dependencies\n\n```bash\npipenv install --dev\n```\n\n5. Open enviroment of Python\n\n```bash\npipenv shell\n```\n\n6. Create your Feature Branch\n\n```bash\ngit checkout -b feature/AmazingFeature\n```\n\n7. Push to the Branch\n\n```bash\ngit push origin feature/AmazingFeature\n```\n\n8. Open a Pull Request\n\n**Important**: Use \"conventional commits\" and ensure that the code passes the linter test, pull requests are not accepted without this last point.\n\n\u003cp align=\"right\"\u003e\u003ca href=\"#top\"\u003eBack to top 🔼\u003c/a\u003e\u003c/p\u003e\n\u003cbr\u003e\n\n\n## 👨‍⚖️ License\n\nDistributed under the MIT License. See `LICENSE` for more information.\n\n\u003cp align=\"right\"\u003e\u003ca href=\"#top\"\u003eBack to top 🔼\u003c/a\u003e\u003c/p\u003e\n\u003cbr\u003e\n\n## 📬 Contact me\n\n**Famá Román** \n- famaroman@gmail.com\n- [Linkedin](https://www.linkedin.com/in/romanfama)\n\n\u003cp align=\"right\"\u003e\u003ca href=\"#top\"\u003eBack to top 🔼\u003c/a\u003e\u003c/p\u003e","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fromanfama592%2Ffolder_mapping_action","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fromanfama592%2Ffolder_mapping_action","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fromanfama592%2Ffolder_mapping_action/lists"}