Expand description
Plugin trait definitions
This module defines the contract between ProGit and plugins.
§Trait Hierarchy
Plugin (core trait)
├── IssuePlugin (issue lifecycle convenience)
├── SyncPlugin (sync operation convenience)
├── IntegrationPlugin (external system sync)
└── AnalyticsPlugin (metrics and reporting)§Usage
Most plugins only need to implement the base Plugin trait.
The specialized traits (IntegrationPlugin, AnalyticsPlugin) are
for plugins that provide specific functionality.
Modules§
- experimental_
diff_ renderer - DiffRenderer (experimental_)
- experimental_
fragments - Widget Fragments (experimental_)
- jobs
- Async job execution contract
Structs§
- Analytics
Query - Query parameters for filtering issues in analytics
- Data
Point - A single data point in a report
- Date
Range - Date range for queries
- External
Link - Link to an issue in an external system
- Field
Mappings - Configuration for field mapping between ProGit and external systems
- Integration
Info - Information about an integration plugin
- Issue
- Issue representation for plugins
- Issue
Snapshot - Historical issue snapshot for analytics
- Metric
Value - Result of a metric computation
- Plugin
Context - Plugin execution context
- Plugin
Metadata - Plugin metadata
- Report
- A generated report
- Sprint
- Sprint definition
- Status
Transition - Status transition record
- Sync
Result - Result of syncing an issue to an external system
- Trend
- Trend indicator for metrics
Enums§
- Auth
Type - Authentication methods supported by integrations
- BulkOp
- Bulk operation types
- Conflict
Resolution - How to resolve conflicts between local and remote issues
- Export
Format - Export formats for data
- Metric
Type - Types of metrics that can be computed
- Plugin
Error - Plugin error types
- Plugin
Hook - Available plugin hooks
- Report
Type - Types of reports that can be generated
- Sync
Status - Status of a sync operation
- Trend
Direction - Direction of trend change
Traits§
- Analytics
Plugin - Trait for plugins that compute metrics, generate reports, or export data
- Integration
Plugin - Trait for plugins that sync with external issue trackers
- Issue
Plugin - Convenience trait for issue lifecycle hooks
- Plugin
- Core plugin trait
- Sync
Plugin - Convenience trait for sync hooks
Type Aliases§
- Plugin
Result - Plugin execution result