How picnicsupermarket/error-prone-support works
Main Components
The system architecture should be divided into these key components:
a. Core Components:
• Error Prone Contrib (Main bug checker implementations)
• Refaster Support (Core functionality for code transformation)
• Documentation Support (Documentation generation tools)
• Utils (Shared utilities and helpers)
b. Testing Components:
• Refaster Test Support
• Integration Tests
c. Build & Deployment:
• Maven Build System
• GitHub Actions Workflows
Component Relationships
[Core Components]
┌─────────────────────┐ ┌─────────────────────┐
• Error Prone Contrib│◄────┤ Refaster Support │
• ┘ └─────────────────────┘
• ▲ ▲
┌─────────────────────┐ ┌─────────────────────┐
• Utils │◄────┤ Documentation │
• ┘ │ Support │
• ┘
[Testing Infrastructure]
┌─────────────────────┐ ┌─────────────────────┐
• Refaster Test │◄────┤ Integration │
• Support │ │ Tests │
• ┘ └─────────────────────┘
[Build & Deployment]
┌─────────────────────┐ ┌─────────────────────┐
• Maven Build │◄────┤ GitHub Actions │
• System │ │ Workflows │
• ┘ └─────────────────────┘
Component Details
For each component, include:
• Name
• Primary responsibility
• Key interfaces/classes
• Dependencies on other components
Data Flow
Following interactions:
• Source code input
• Static analysis processing
• Bug detection output
• Code transformation suggestions
• Documentation generation
• Test execution flow
Integration Points
Integration with:
• Google Error Prone
• Maven/Gradle build systems
• IDE tooling
• CI/CD pipelines
Notes
Annotations for:
• Required Java version (JDK 17+)
• Build system requirements
• Key configuration points
• Extension points
Integration points with external tools
• How the components interact
• Where to add new features
• How to extend existing functionality
• Testing and deployment workflows
• Using consistent styling
• Providing adequate spacing
• Including clear labels
• Adding concise descriptions