feat: summarize scan output to favor web report, removing list and table views#258
Merged
Conversation
There was a problem hiding this comment.
Pull Request Overview
This PR removes legacy list/table views in favor of a concise summary output, adds support for tracking NES remediation availability, and updates all related tests and docs.
- Introduces
countComponentsByStatusand updatesdisplayResultsto show package counts instead of detailed tables. - Adds a new
NES_AVAILABLEstatus to indicate remediations available and propagates it through types, services, and UI. - Cleans up/remove outdated UI utilities (
eol.ui.ts,date.ui.ts), flags, and tests for table/list rendering.
Reviewed Changes
Copilot reviewed 19 out of 19 changed files in this pull request and generated 2 comments.
Show a summary per file
| File | Description |
|---|---|
| src/commands/scan/eol.ts | Reworked CLI display to summary counts; removed table logic; added guidance lines |
| src/commands/scan/eol.ts | Added countComponentsByStatus function |
| src/ui/shared.ui.ts | Added NES_AVAILABLE color/indicator; removed unused constants |
| src/service/nes/nes.svc.ts | Set nesAvailable in scan result info |
| src/api/types/nes.types.ts | Extended component info with nesAvailable & remediation; updated statuses |
| src/api/queries/nes/sbom.ts | Included remediation { id } in GraphQL query |
| src/api/types/hd-cli.types.ts | Adjusted ScanResult components map type |
| package.json | Added terminal-link dependency; removed @oclif/table |
| .envrc.example | Updated EOL_REPORT_URL domain suffix |
| .cursorrules | Removed obsolete service-no-cli-table rule |
| README.md | Removed --table flag docs |
| test/ui/eol.ui.test.ts | Deleted legacy UI tests for list/table views |
| test/ui/date.ui.test.ts | Deleted obsolete date UI tests |
| test/service/eol.svc.test.ts | Deleted old purl name resolver tests |
| e2e/scan/eol.test.ts | Updated end-to-end tests to expect summary output |
Comments suppressed due to low confidence (2)
src/commands/scan/eol.ts:169
- The new
countComponentsByStatusfunction and updated summary display indisplayResultslack unit tests. Consider adding tests to cover scenarios for different status counts and remediation availability.
export function countComponentsByStatus(components: InsightsEolScanComponent[]): Record<ComponentStatus, number> {
src/api/types/nes.types.ts:64
- [nitpick] Adding
NES_AVAILABLEtoComponentStatusblends remediation availability with component lifecycle statuses. Consider separating remediation availability into its own field or category instead of treating it as a status.
export const VALID_STATUSES = ['UNKNOWN', 'OK', 'EOL', 'SUPPORTED', 'NES_AVAILABLE'] as const;
Contributor
Good bot 🤖 |
KLongmuirHD
requested changes
Jun 12, 2025
KLongmuirHD
reviewed
Jun 12, 2025
KLongmuirHD
approved these changes
Jun 12, 2025
edezekiel
reviewed
Jun 12, 2025
edezekiel
reviewed
Jun 12, 2025
edezekiel
reviewed
Jun 12, 2025
edezekiel
reviewed
Jun 12, 2025
edezekiel
approved these changes
Jun 12, 2025
Contributor
edezekiel
left a comment
There was a problem hiding this comment.
LGTM - left a few comments about e2e specs though
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
See individual commits.
Closes https://github.com/neverendingsupport/data-and-integrations/issues/71
Closes https://github.com/neverendingsupport/data-and-integrations/issues/72
Closes https://github.com/neverendingsupport/data-and-integrations/issues/114