Skip to content

Add overview support and emitter display names to spec-dashboard#9891

Merged
timotheeguerin merged 3 commits intomicrosoft:mainfrom
joheredi:feature/spec-dashboard-overview
Mar 4, 2026
Merged

Add overview support and emitter display names to spec-dashboard#9891
timotheeguerin merged 3 commits intomicrosoft:mainfrom
joheredi:feature/spec-dashboard-overview

Conversation

@joheredi
Copy link
Member

@joheredi joheredi commented Mar 3, 2026

Add overview support and emitter display names to spec-dashboard

Summary

This PR adds two new configuration options to the spec-dashboard package to improve the coverage dashboard UX:

  • showOverview — Renders coverage overview cards at the top of the dashboard, showing per-emitter coverage percentages at a glance.
  • emitterDisplayNames — Allows consumers to provide friendly display names for emitter columns (e.g., @azure-tools/typespec-pythonPython) instead of relying on generator metadata or raw package names.

Changes

File Description
apis.ts Added showOverview and emitterDisplayNames optional fields to CoverageFromAzureStorageOptions
coverage-overview.tsx NewCoverageOverview component that aggregates coverage across all summaries and renders a responsive grid of per-emitter cards with color-coded percentages
coverage-utils.ts New — Extracted getCompletedRatio utility for reuse across components
dashboard.tsx Plumbed new props through; renders CoverageOverview when showOverview is enabled
dashboard-az-storage.tsx Pass new options from storage config to Dashboard
dashboard-table.tsx Accept emitterDisplayNames; use displayName ?? report?.generatorMetadata?.name ?? language fallback chain for column headers; removed inlined getCompletedRatio in favor of the shared utility

Display Name Resolution

Column headers now follow this priority:

  1. Explicit emitterDisplayNames[packageName] (if provided)
  2. report.generatorMetadata.name (from coverage data)
  3. Raw package name (fallback)

@github-actions
Copy link
Contributor

github-actions bot commented Mar 3, 2026

No changes needing a change description found.

@joheredi joheredi force-pushed the feature/spec-dashboard-overview branch 2 times, most recently from bef713f to d90c59f Compare March 3, 2026 23:33
@azure-sdk
Copy link
Collaborator

azure-sdk commented Mar 3, 2026

You can try these changes here

🛝 Playground 🌐 Website 🛝 VSCode Extension

@joheredi joheredi force-pushed the feature/spec-dashboard-overview branch from 3318ec1 to 3cbdd15 Compare March 4, 2026 00:27
Copy link
Member

@timotheeguerin timotheeguerin left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

nvm, the tier wasn't added as part of this PR but the UI still pretty bad so we should fix that soon

@timotheeguerin timotheeguerin enabled auto-merge March 4, 2026 15:43
joheredi and others added 3 commits March 4, 2026 19:25
- Add showOverview option and coverage overview component
- Add emitterDisplayNames option for friendly column headers
- Extract coverage utility functions
- Refactor dashboard table to use display names

Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
@joheredi joheredi force-pushed the feature/spec-dashboard-overview branch from 3cbdd15 to 112f347 Compare March 4, 2026 20:36
@timotheeguerin timotheeguerin added this pull request to the merge queue Mar 4, 2026
Merged via the queue into microsoft:main with commit c2a5309 Mar 4, 2026
29 checks passed
github-merge-queue bot pushed a commit to Azure/typespec-azure that referenced this pull request Mar 4, 2026
## Summary

Configures the Can I Use HTTP dashboard to use the new spec-dashboard
features added in [microsoft/typespec -
feature/spec-dashboard-overview](https://github.com/joheredi/typespec/tree/feature/spec-dashboard-overview):

- **Coverage Overview** — Shows per-emitter coverage percentage cards at
the top of the dashboard
- **Emitter Display Names** — Maps package names to friendly labels
(e.g., `@azure-tools/typespec-python` → `Python`)
- **Scenario Tiers** — Adds tier-based filtering with Core and Backlog
categories

### Changes

| File | Description |
|------|-------------|
| `core` | Updated submodule to include spec-dashboard overview support
|
| `website/src/pages/can-i-use/http.astro` | Added `showOverview`,
`emitterDisplayNames`, and `tiers` configuration |
| `website/src/pages/can-i-use/scenario-tiers.ts` | **New** — Scenario
tier definitions (Core / Backlog) |

### Dependencies

This PR depends on the core submodule PR:
microsoft/typespec#9891

---------

Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants