cli
cli copied to clipboard
code-pushup
Consolidated Report Header and Average Score for Workspace
Problem Statement
Currently, each project's report in the workspace is displayed with its own header, making it harder to quickly assess the overall status of the workspace. Additionally, there's no aggregated score representing the average scoring across all projects in the workspace.
Example Markdown report
app-1
| 🏷 Category | ⭐ Score | 🛡 Audits |
|---|---|---|
| Design System Coverage | 🟡 62 | 13 |
🏷 Categories
Design System Coverage
Usage of design system components 🟡 Score: 62
...
app-2
| 🏷 Category | ⭐ Score | 🛡 Audits |
|---|---|---|
| Design System Coverage | 🟡 69 | 13 |
🏷 Categories
Design System Coverage
Usage of design system components 🟡 Score: 69
...
app-3
| 🏷 Category | ⭐ Score | 🛡 Audits |
|---|---|---|
| Design System Coverage | 🟡 69 | 13 |
🏷 Categories
Design System Coverage
Usage of design system components 🟡 Score: 69
...
Acceptance criteria
Proposed Solution
- Introduce a single consolidated header for the entire workspace report.
- Display an average score for all projects in the workspace in a dedicated summary table.
- Ensure each project's details remain available but structured under the consolidated header.
Example Structure
🏆 Workspace Summary
| 🏷 Category | ⭐ Average Score | 🛡 Total Audits |
|---|---|---|
| Overall Workspace | 🟡 64.75 | 260 |
Implementation details
- The consolidated header should appear at the beginning of the report.
- The average score should be calculated dynamically as new projects are added.
- Each individual project should maintain its own detailed breakdown, listed under the consolidated section.
