Skip to content

Commit

Permalink
docs: Update output directory from '_mapped' to '_codemaps' in README…
Browse files Browse the repository at this point in the history
…, changelog, and code
  • Loading branch information
shaneholloman committed Sep 26, 2024
1 parent c0b31e1 commit 447bb47
Show file tree
Hide file tree
Showing 4 changed files with 7 additions and 7 deletions.
2 changes: 1 addition & 1 deletion .gitignore
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
# codemapper artifacts
_github/
_output/
_mapped/
_codemaps/
private/
scripts/

Expand Down
4 changes: 2 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -41,7 +41,7 @@ See audio explainers for this project:
- Handles file encoding detection for accurate content reading
- Provides an option to include files normally ignored by `.gitignore`
- Can clone and analyze GitHub repositories
- Saves output in a '_mapped' directory
- Saves output in a '_codemaps' directory
- Automatically acknowledges large and binary files without printing their contents
- Displays file type and size information for large and binary files

Expand Down Expand Up @@ -92,7 +92,7 @@ codemapper <path_to_directory_or_github_url> [--include-ignored]

## Output

The script generates a Markdown file named `<directory_name>codemap.md` in the '_mapped' directory. This file contains:
The script generates a Markdown file named `<directory_name>codemap.md` in the '_codemaps' directory. This file contains:

1. A table of contents for easy navigation
2. A file tree representation of the directory structure
Expand Down
2 changes: 1 addition & 1 deletion changelog.md
Original file line number Diff line number Diff line change
Expand Up @@ -48,7 +48,7 @@

- 3.0.0 (2024-09-23):
- Major refactor
- Added '_mapped' output directory for generated markdown files
- Added '_codemaps' output directory for generated markdown files
- Improved error handling and user feedback

- 2.5.0 (2024-09-10):
Expand Down
6 changes: 3 additions & 3 deletions src/codemapper/codemapper.py
Original file line number Diff line number Diff line change
Expand Up @@ -18,14 +18,14 @@
• Handles file encoding detection for accurate content reading
• Provides an option to include files normally ignored by .gitignore
• Can clone and analyze GitHub repositories
• Saves output in a '_mapped' directory
• Saves output in a '_codemaps' directory
• Acknowledges large and binary files without printing their contents
Usage:
python codemapper.py <path_to_directory_or_github_url> [--include-ignored]
Output:
Creates a markdown file named '<directory_name>_structure.md' in the '_mapped' directory
Creates a markdown file named '<directory_name>_structure.md' in the '_codemaps' directory
Requirements:
• Python 3.6+ (for f-strings and type hinting)
Expand Down Expand Up @@ -551,7 +551,7 @@ def manage_output_directory(base_name: str) -> str:
Returns:
str: The full path for the output markdown file.
"""
output_dir = os.path.join(".", "_mapped")
output_dir = os.path.join(".", "_codemaps")
os.makedirs(output_dir, exist_ok=True)

file_name = f"{base_name}_codemap.md"
Expand Down

0 comments on commit 447bb47

Please sign in to comment.