Skip to content

Commit

Permalink
chore: update changelog and fiix backtick bug
Browse files Browse the repository at this point in the history
  • Loading branch information
shaneholloman committed Nov 24, 2024
1 parent 93e639b commit e9ce413
Show file tree
Hide file tree
Showing 4 changed files with 22 additions and 6 deletions.
16 changes: 16 additions & 0 deletions changelog.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,22 @@

## Version History

- 3.9.0 (2024-11-24):
- feature: Add DocMap functionality for documentation mapping
- Added new CLI options:
- --docs flag to generate documentation maps
- --docs-dir option for custom documentation directory paths
- Generates repository-name_docmap.md with focus on documentation
- Automatically includes root README.md content
- Scans standard doc directories (docs, doc, documentation)
- refactor: Implement DocMapConfig dataclass for parameter handling
- Added new docmap.py module for documentation functionality
- Introduced DocMapConfig for improved parameter organization
- Added documentation directory constants in config.py
- Enhanced error handling for missing documentation
- Achieved perfect pylint score (10.00/10)
- [View Full Changelog](https://github.com/shaneholloman/codemapper/compare/v3.8.0...v4.0.1)

- 3.8.0 (2024-11-23):
- refactor: Split codebase into modular structure
- Split main functionality into separate modules:
Expand Down
2 changes: 1 addition & 1 deletion pyproject.toml
Original file line number Diff line number Diff line change
Expand Up @@ -22,7 +22,7 @@ extend-exclude = '''

[project]
name = "codemapper"
version = "4.0.0"
version = "4.0.1"
description = "A tool to generate comprehensive Markdown artifacts of directory structures and file contents"
readme = "README.md"
requires-python = ">=3.10"
Expand Down
2 changes: 1 addition & 1 deletion src/codemapper/__init__.py
Original file line number Diff line number Diff line change
Expand Up @@ -11,6 +11,6 @@
creating detailed Markdown documentation of their structure and contents.
"""

__version__ = "4.0.0" # Bumped from 3.7.0 to reflect structural changes
__version__ = "4.0.1" # Bumped from 3.7.0 to reflect structural changes

# Any other necessary imports or package-level code can go here
8 changes: 4 additions & 4 deletions src/codemapper/docmap.py
Original file line number Diff line number Diff line change
Expand Up @@ -126,9 +126,9 @@ def generate_docmap_content(config: DocMapConfig) -> str:
md_content.extend([
"## Project README\n",
"The following section contains the main project README content:\n",
"```markdown",
"````markdown",
readme_content,
"```\n"
"````\n"
])

# Find and process documentation directory
Expand All @@ -154,9 +154,9 @@ def generate_docmap_content(config: DocMapConfig) -> str:
is_markdown = path.endswith('.md')
md_content.extend([
f"#### {path}\n",
"```markdown" if is_markdown else "```",
"````markdown" if is_markdown else "```",
content,
"```\n"
"````\n" if is_markdown else "```\n"
])

# If neither README nor doc directory found, include a note
Expand Down

0 comments on commit e9ce413

Please sign in to comment.