mvn-tree-visualizer 1.2.0__tar.gz → 1.4.0__tar.gz

mvn_tree_visualizer-1.4.0/.github/FUNDING.yml

@@ -0,0 +1,13 @@
+# These are supported funding model platforms
+
+github: # Replace with a single GitHub username or organization
+patreon: # Replace with a single Patreon username
+open_collective: # Replace with a single Open Collective username
+ko_fi: irakliskonsoulas
+tidelift: # Replace with a single Tidelift package-name e.g., npm/babel
+community_bridge: # Replace with a single Community Bridge project-name e.g., cloud-foundry
+liberapay: # Replace with a single Liberapay username
+issuehunt: # Replace with a single IssueHunt username
+otechie: # Replace with a single Otechie username
+lfx_crowdfunding: # Replace with a single LFX Crowdfunding project-name e.g., cloud-foundry
+custom: # Replace with up to 4 custom sponsorship URLs e.g., ['link1', 'link2']

mvn_tree_visualizer-1.4.0/.github/ISSUE_TEMPLATE/bug_report.md

@@ -0,0 +1,36 @@
+---
+name: Bug report
+about: Create a report to help us improve
+title: '[BUG] '
+labels: bug
+assignees: ''
+---
+
+**Describe the bug**
+A clear and concise description of what the bug is.
+
+**To Reproduce**
+Steps to reproduce the behavior:
+1. Run command '...'
+2. See error
+
+**Expected behavior**
+A clear and concise description of what you expected to happen.
+
+**Maven dependency tree sample**
+Please provide a sample of your Maven dependency tree output:
+```
+[paste your maven dependency tree here]
+```
+
+**Screenshots**
+If applicable, add screenshots to help explain your problem.
+
+**Environment:**
+- OS: [e.g. Windows 10, macOS, Ubuntu 20.04]
+- Python version: [e.g. 3.13]
+- Package version: [e.g. 1.2.0]
+- Maven version: [e.g. 3.8.1]
+
+**Additional context**
+Add any other context about the problem here.

mvn_tree_visualizer-1.4.0/.github/ISSUE_TEMPLATE/feature_request.md

@@ -0,0 +1,22 @@
+---
+name: Feature request
+about: Suggest an idea for this project
+title: '[FEATURE] '
+labels: enhancement
+assignees: ''
+---
+
+**Is your feature request related to a problem? Please describe.**
+A clear and concise description of what the problem is. Ex. I'm always frustrated when [...]
+
+**Describe the solution you'd like**
+A clear and concise description of what you want to happen.
+
+**Describe alternatives you've considered**
+A clear and concise description of any alternative solutions or features you've considered.
+
+**Use case**
+Describe how this feature would be used and who would benefit from it.
+
+**Additional context**
+Add any other context or screenshots about the feature request here.

mvn_tree_visualizer-1.4.0/.github/ISSUE_TEMPLATE/question.md

@@ -0,0 +1,21 @@
+---
+name: Question
+about: Ask a question about usage or functionality
+title: '[QUESTION] '
+labels: question
+assignees: ''
+---
+
+**Question**
+What would you like to know?
+
+**Context**
+Provide any relevant context about your use case or what you're trying to achieve.
+
+**What you've tried**
+If applicable, describe what you've already tried.
+
+**Environment (if relevant):**
+- OS: [e.g. Windows 10, macOS, Ubuntu 20.04]
+- Python version: [e.g. 3.13]
+- Package version: [e.g. 1.2.0]

mvn_tree_visualizer-1.4.0/.github/PULL_REQUEST_TEMPLATE.md

@@ -0,0 +1,30 @@
+## Description
+Brief description of the changes made in this PR.
+
+## Type of Change
+- [ ] Bug fix (non-breaking change which fixes an issue)
+- [ ] New feature (non-breaking change which adds functionality)
+- [ ] Breaking change (fix or feature that would cause existing functionality to not work as expected)
+- [ ] Documentation update
+- [ ] Code refactoring
+- [ ] Performance improvement
+- [ ] Other (please describe):
+
+## Testing
+- [ ] I have added tests that prove my fix is effective or that my feature works
+- [ ] New and existing unit tests pass locally with my changes
+- [ ] I have tested the CLI functionality manually
+
+## Checklist
+- [ ] My code follows the project's style guidelines
+- [ ] I have performed a self-review of my code
+- [ ] I have commented my code, particularly in hard-to-understand areas
+- [ ] I have made corresponding changes to the documentation
+- [ ] My changes generate no new warnings
+- [ ] I have updated the CHANGELOG.md file (if applicable)
+
+## Screenshots (if applicable)
+Add screenshots to help explain your changes.
+
+## Additional Notes
+Any additional information that would be helpful for reviewers.

mvn_tree_visualizer-1.4.0/.github/SECURITY.md

@@ -0,0 +1,52 @@
+# Security Policy
+
+## Supported Versions
+
+We actively support the following versions of mvn-tree-visualizer:
+
+| Version | Supported          |
+| ------- | ------------------ |
+| 1.3.x   | :white_check_mark: |
+| 1.2.x   | :white_check_mark: |
+| 1.1.x   | :x:                |
+| 1.0.x   | :x:                |
+
+## Reporting a Vulnerability
+
+If you discover a security vulnerability in mvn-tree-visualizer, please report it to us responsibly.
+
+### How to Report
+
+1. **Do not create a public GitHub issue** for security vulnerabilities
+2. **Email us directly** at: dyka3773@gmail.com
+3. **Include the following information:**
+   - Description of the vulnerability
+   - Steps to reproduce
+   - Affected versions
+   - Potential impact
+   - Suggested fix (if available)
+
+### Response Timeline
+
+- **Acknowledgment**: We will acknowledge receipt of your report as soon as possible (usually within 48 hours)
+- **Assessment**: We will assess the vulnerability within 7 days
+- **Fix**: We will work on a fix and release it as soon as possible
+- **Credit**: We will credit you in the security advisory (unless you prefer to remain anonymous)
+
+### Security Best Practices
+
+When using mvn-tree-visualizer:
+
+1. **Keep updated**: Always use the latest version
+2. **Validate inputs**: Be cautious with dependency files from untrusted sources
+3. **File permissions**: Ensure proper file permissions on generated outputs
+4. **CI/CD**: Use in secure CI/CD environments
+
+### Scope
+
+This security policy applies to:
+- The mvn-tree-visualizer Python package
+- Official GitHub repository
+- Documentation and examples
+
+Thank you for helping keep mvn-tree-visualizer secure!

mvn_tree_visualizer-1.4.0/.github/dependabot.yml

@@ -0,0 +1,39 @@
+version: 2
+updates:
+  # Enable version updates for Python dependencies
+  - package-ecosystem: "pip"
+    directory: "/"
+    schedule:
+      interval: "weekly"
+    open-pull-requests-limit: 10
+    commit-message:
+      prefix: "deps"
+      prefix-development: "deps-dev"
+    labels:
+      - "dependencies"
+      - "python"
+
+  - package-ecosystem: "uv"
+    directory: "/"
+    schedule:
+      interval: "weekly"
+    open-pull-requests-limit: 10
+    commit-message:
+      prefix: "deps"
+      prefix-development: "deps-dev"
+    labels:
+      - "dependencies"
+      - "uv"
+      - "python"
+  
+  # Enable version updates for GitHub Actions
+  - package-ecosystem: "github-actions"
+    directory: "/"
+    schedule:
+      interval: "weekly"
+    open-pull-requests-limit: 5
+    commit-message:
+      prefix: "ci"
+    labels:
+      - "dependencies"
+      - "github-actions"

mvn_tree_visualizer-1.4.0/.github/instructions/copilot-instructions.md

@@ -0,0 +1,92 @@
+# GitHub Copilot Instructions for mvn-tree-visualizer
+
+## Project Overview
+This is a Python CLI tool that parses Maven dependency trees (`mvn dependency:tree` output) and generates interactive HTML diagrams (using Mermaid.js) or JSON outputs. The tool supports watch mode for real-time regeneration and has a modular architecture focused on error handling and user experience.
+
+## Architecture & Key Components
+
+### Core Flow
+1. **Input Validation** (`validation.py`) - Find and validate Maven dependency files
+2. **File Merging** (`get_dependencies_in_one_file.py`) - Combine multiple dependency files
+3. **Parsing** (`diagram.py`) - Read merged dependency tree
+4. **Output Generation** (`outputs/`) - Generate HTML (Mermaid.js) or JSON
+5. **Watch Mode** (`file_watcher.py`) - Monitor files for changes using watchdog
+
+### Module Structure
+```
+src/mvn_tree_visualizer/
+├── cli.py              # Entry point with comprehensive error handling
+├── exceptions.py       # Custom exception hierarchy
+├── validation.py       # File discovery and validation logic
+├── diagram.py          # Core dependency tree processing
+├── file_watcher.py     # Real-time file monitoring
+├── get_dependencies... # Multi-file merging logic
+├── TEMPLATE.py         # Jinja2 HTML template for Mermaid.js
+└── outputs/
+    ├── html_output.py  # Mermaid diagram generation
+    └── json_output.py  # Structured JSON output
+```
+
+## Development Conventions
+
+### Error Handling Pattern
+- Use custom exceptions from `exceptions.py`: `DependencyFileNotFoundError`, `DependencyParsingError`, `OutputGenerationError`
+- Provide actionable error messages with Maven commands and file paths
+- Follow the pattern in `cli.py:generate_diagram()` for comprehensive error handling
+
+### Testing Approach
+- Use pytest with descriptive test names like `test_convert_to_mermaid_deeper_tree()`
+- Test both positive cases and error conditions
+- Include realistic Maven dependency tree samples in test data
+- Run tests with: `uv run pytest tests/ -v`
+
+### Package Management
+- Uses `uv` as package manager - always use `uv run` for commands
+- Core dependencies: `jinja2` (templating), `watchdog` (file monitoring)
+- Entry point: `mvn-tree-visualizer` command maps to `cli:cli`
+
+### Code Quality
+- Lint with: `uv run ruff check .`
+- Type hints required throughout (project uses Python 3.13+)
+- Follow existing patterns for file validation and path handling
+
+## Critical Implementation Details
+
+### Maven Dependency Parsing
+- Input format: `[INFO] groupId:artifactId:type:version:scope` with tree structure using `+`, `|`, `\`
+- Handle both 4-part and 5-part dependency strings (see `html_output.py:_convert_to_mermaid`)
+- Depth calculation based on whitespace: `depth = len(parts[0].split(" ")) - 1`
+
+### File Discovery Pattern
+- Multi-file support: searches directory tree for `maven_dependency_file` (configurable)
+- Merges files from different Maven modules into single intermediate file
+- Validates file existence, permissions, and content before processing
+
+### Output Generation
+- HTML uses Mermaid.js with `graph LR` format
+- Version display controlled by `--show-versions` flag
+- JSON output maintains tree structure with parent-child relationships
+
+### Watch Mode Implementation
+- Uses watchdog library for cross-platform file monitoring
+- Monitors specific filename pattern across directory tree
+- Debounces changes and provides timestamped feedback
+
+## Common Development Tasks
+
+### Adding New Output Formats
+1. Create new module in `outputs/` directory
+2. Follow pattern from `html_output.py` and `json_output.py`
+3. Add format option to CLI and update `generate_diagram()` in `cli.py`
+
+### Error Message Improvements
+- All user-facing errors should include specific file paths and suggested Maven commands
+- Use `print_maven_help()` pattern for guiding users to generate dependency files
+- Test error scenarios in addition to happy path
+
+### Testing New Features
+- Include realistic Maven dependency trees in test data
+- Test both single-module and multi-module project scenarios
+- Verify error handling with invalid/missing files
+
+Remember: This tool processes Maven output files, not Maven projects directly. Users must run `mvn dependency:tree -DoutputFile=maven_dependency_file` first.

mvn_tree_visualizer-1.4.0/.github/workflows/ci.yml

@@ -0,0 +1,38 @@
+name: CI
+
+on:
+  push:
+    branches: [ master, develop ]
+  pull_request:
+    branches: [ master, develop ]
+
+jobs:
+  test:
+    runs-on: ubuntu-latest
+    strategy:
+      matrix:
+        python-version: ["3.13"]
+    
+    steps:
+    - uses: actions/checkout@v4
+    
+    - name: Set up Python ${{ matrix.python-version }}
+      uses: actions/setup-python@v5
+      with:
+        python-version: ${{ matrix.python-version }}
+    
+    - name: Install dependencies
+      run: |
+        python -m pip install --upgrade pip
+        pip install -e .
+        pip install pytest ruff
+    
+    - name: Run linter
+      run: ruff check src/ tests/
+    
+    - name: Run tests
+      run: pytest -v
+    
+    - name: Test CLI
+      run: |
+        python -m mvn_tree_visualizer --help

mvn_tree_visualizer-1.4.0/.github/workflows/release.yml

@@ -0,0 +1,58 @@
+name: Semantic Release
+
+on:
+  push:
+    branches: [ master ]
+  workflow_dispatch:
+
+concurrency: ${{ github.workflow }}-${{ github.ref }}
+
+jobs:
+  release:
+    runs-on: ubuntu-latest
+    permissions:
+      contents: write
+      id-token: write
+      issues: write
+      pull-requests: write
+
+    steps:
+    - name: Checkout
+      uses: actions/checkout@v4
+      with:
+        fetch-depth: 0
+        token: ${{ secrets.GITHUB_TOKEN }}
+
+    - name: Set up Python
+      uses: actions/setup-python@v5
+      with:
+        python-version: '3.13'
+
+    - name: Install uv
+      uses: astral-sh/setup-uv@v4
+
+    - name: Install dependencies
+      run: |
+        uv sync --dev
+        
+    - name: Run tests
+      run: |
+        uv run pytest tests/ -v
+
+    - name: Run linting
+      run: |
+        uv run ruff check .
+
+    - name: Python Semantic Release
+      id: release
+      uses: python-semantic-release/python-semantic-release@v10.2.0
+      with:
+        github_token: ${{ secrets.GITHUB_TOKEN }}
+
+    - name: Publish to PyPI
+      if: steps.release.outputs.released == 'true'
+      env:
+        TWINE_USERNAME: __token__
+        TWINE_PASSWORD: ${{ secrets.PYPI_API_TOKEN }}
+      run: |
+        uv run twine upload dist/*

{mvn_tree_visualizer-1.2.0 → mvn_tree_visualizer-1.4.0}/.gitignore

@@ -18,6 +18,14 @@ lib/
 lib64/
 parts/
 sdist/
+
+# Project specific - only ignore in root directory
+/dependency_tree.txt
+/maven_dependency_file
+/diagram.html
+/dependencies.json
+/*.svg
+
 var/
 wheels/
 share/python-wheels/
@@ -179,7 +187,7 @@ cython_debug/
 #  that can be found at https://github.com/github/gitignore/blob/main/Global/VisualStudioCode.gitignore
 #  and can be added to the global gitignore or merged into this file. However, if you prefer, 
 #  you could uncomment the following to ignore the entire vscode folder
-# .vscode/
+.vscode/
 
 # Ruff stuff:
 .ruff_cache/

mvn_tree_visualizer-1.4.0/CHANGELOG.md

@@ -0,0 +1,109 @@
+# Changelog
+
+All notable changes to this project will be documented in this file.
+
+The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
+and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
+
+<!--next-version-placeholder-->
+
+## [1.3.0] - 2025-07-09
+
+### Added
+- Watch mode functionality with `--watch` flag for automatic diagram regeneration
+- File system monitoring using watchdog library for real-time updates
+- New file_watcher module for decoupled file monitoring logic
+- Enhanced error handling system with comprehensive user guidance
+  - Clear error messages for missing dependency files with helpful Maven commands
+  - Specific validation for directories, file permissions, and content
+  - Detailed diagnostics for parsing errors and empty files
+  - User-friendly error messages with emojis and actionable suggestions
+- Custom exception classes for better error categorization
+- Comprehensive test coverage for error scenarios
+
+### Changed
+- **BREAKING**: JSON output now uses simplified package names (artifact-id only) to match HTML output behavior
+  - Root packages now show as "my-app" instead of "com.example:my-app"
+  - Ensures consistency between HTML and JSON output formats
+- Refactored CLI module to separate concerns and improve maintainability
+- Improved error handling with timestamped console output and graceful failure modes
+- Enhanced file processing with better encoding handling (UTF-8) and validation
+- Updated dependency file merging logic with better error detection
+
+### Fixed
+- Removed unused imports and improved code organization
+- Fixed intermediate file path handling in diagram generation
+
+## [1.2.0] - 2025-07-09
+
+### Added
+- Comprehensive type hints throughout the entire codebase
+- `--show-versions` flag to display dependency versions in both HTML and JSON outputs
+- Support for complex dependency trees with real-world examples
+- "Typing :: Typed" classifier in pyproject.toml to indicate type hint support
+- CHANGELOG.md to track project changes
+
+### Changed
+- Enhanced CLI help text to reflect new features
+- Improved JSON output structure for better programmatic access
+- Updated documentation with version feature examples
+
+### Fixed
+- Type annotation issues and improved code clarity
+- JSON serialization for complex dependency structures
+
+## [1.1.0] - 2025-07-05
+
+### Added
+- JSON output format option for programmatic consumption
+- Multi-file support for Maven modules (searches for multiple `maven_dependency_file`)
+- File merging functionality for complex projects
+- Comprehensive error handling for file operations
+- Enhanced CLI with format selection
+
+### Changed
+- Improved project structure with organized outputs directory
+- Better separation of concerns between HTML and JSON generation
+
+### Fixed
+- File handling issues with large dependency trees
+- Output format validation and error messages
+
+## [1.0.0] - 2025-07-01
+
+### Added
+- Initial release of mvn-tree-visualizer
+- HTML diagram generation using Mermaid.js
+- CLI interface for processing Maven dependency files
+- Basic error handling and validation
+- Support for Maven dependency tree parsing
+- Interactive HTML output with visual dependency graphs
+- Improved code documentation and readability with type hints
+- Updated README.md with new feature documentation and usage examples
+
+### Fixed
+- Better static type checking support for development tools
+
+## [1.1.0] - 2025-07-08
+
+### Added
+- JSON output format support alongside existing HTML format
+- `--format` CLI argument to choose between HTML and JSON outputs
+- Comprehensive test suite for both output formats
+- GitHub Actions workflow for automated PyPI publishing
+
+### Changed
+- Decoupled output generation logic from core diagram creation
+- Improved code modularity with separate output modules
+
+### Fixed
+- Enhanced project structure and maintainability
+
+## [1.0.0] - Initial Release
+
+### Added
+- HTML diagram generation using Mermaid.js
+- Interactive SVG export functionality
+- File merging from multiple Maven dependency files
+- Basic CLI interface with essential options
+- Project documentation and contribution guidelines

{mvn_tree_visualizer-1.2.0 → mvn_tree_visualizer-1.4.0}/CONTRIBUTING.md

@@ -47,8 +47,48 @@ pytest
 
 ### Commit and push
 
+We use [Conventional Commits](https://www.conventionalcommits.org/) for commit messages to enable automatic versioning and changelog generation.
+
+**Commit Message Format:**
+```
+<type>[optional scope]: <description>
+
+[optional body]
+
+[optional footer(s)]
+```
+
+**Types:**
+- `feat`: A new feature (triggers minor version bump)
+- `fix`: A bug fix (triggers patch version bump)
+- `docs`: Documentation only changes
+- `style`: Changes that do not affect the meaning of the code
+- `refactor`: A code change that neither fixes a bug nor adds a feature
+- `perf`: A code change that improves performance (triggers patch version bump)
+- `test`: Adding missing tests or correcting existing tests
+- `chore`: Changes to the build process or auxiliary tools
+- `ci`: Changes to CI configuration files and scripts
+
+**Examples:**
+```bash
+feat: add theme support with --theme option
+fix: resolve dependency parsing error with special characters
+docs: update README with new theme examples
+chore: update dependencies to latest versions
+```
+
+**BREAKING CHANGES:**
+For breaking changes, add `!` after the type or include `BREAKING CHANGE:` in the footer:
+```bash
+feat!: change CLI interface for better usability
+# or
+feat: change CLI interface
+
+BREAKING CHANGE: --output-format flag renamed to --format
+```
+
 ```bash
-git commit -m "Your descriptive commit message"
+git commit -m "feat: add your new feature description"
 git push origin 123-add-a-feature
 ```