todo.md

CodeMapper RoadMap

• Add these tasks to the github project board

Core Functionality

tag is: core

• The git pull needs to be a shallow clone, we dont want history!
• Implement direct repository URL analysis
• Expand Git hosting service support (GitLab, Bitbucket)
• Develop progress indicator for large repository processing
• Enable custom branch selection
• Implement intelligent repository categorization
  • Deterministic analysis
  • AI-powered analysis
  • Add option to update original repo with categories (for owners)
• Create config yaml file for user preferences
  • Git pull location
  • CodeMaps location
  • DocMaps location
  • Output format default
  • api keys for AI integration
  • Ai services to use
  • Always shallow clone

File Outputs

tag is: outputs

• Default output dirs will be .docmaps and .codemaps
• Consider adding an additional llms.txt to satisfy the new hype-train of making a robots.txt equivalent
• Generate *_codemap.md for file contents and directory structure
• Create separate *_docmap.md for documentation directories
• Add repository source information to output file header
• Markdown (default)
  • XML
  • JSON
  • YAML
  • RST
  • AsciiDoc
• Go to top of page link in markdown output next to each heading
• Add and --exclude option for files and directories

CodeMapper Service

tag is: service

• Create a server version of CodeMapper with API
• Implement user authentication and authorization
• Ansible playbook for server deployment

Documentation

tag is: docs

• Utilize changelog.md for version tracking

AI Integration

tag is: ai

• Implement AI-generated alt text for images --option
• Implement AI-generated code summarization --option
• Explore base64 image encoding and embedding in output --option

User Experience

tag is: ux

• Create PreFlight checks for CodeMapper
  • Check for git
  • Check for Python version
  • Check for required libraries
• Create function for an install advisory for first-time users
  • Checks for git
  • Detect your OS
  • Give advise on how to install git based on OS
• Develop comprehensive help command and menu
• Add builtin aliases for codemapper [cm, codemap, map] can be additionally defined in config
• Enhance Table of Contents generation
  • Consider using md_toc library for robustness
• Implement a warning and alt method for huge repository processing
• EPIC: Introduce Mermaid flow chart option for code execution flow visualization

Developer Experience

tag is: dev

• Implement CI for linting
• Implement CI for automated testing
• Implement CI for PyPI package deployment