Add package description/summary to json output
Open
ecosystem:javascript
ecosystem:os
ecosystem:ruby
enhancement
good-first-issue
I/O
- Dominant language
- Go
- Stars
- 9.6k
- Forks
- 954
- Avg merge
- 23h 27m
- Merged PRs (30d)
- 48
Description
**What would you like to be added**:
Add rpm/gem/npm package description to json output
**Why is this needed**:
It's a required field for our company's internal SBOM. It might be required by other companies as well.
**Additional context**:
It would be similar to dnf/yum repoquery -queryformat "%{summary}"
Contributor guide
Research direction
No file or test is named. Start by tracing Syft's JSON output path and where RPM, gem, and npm package metadata is represented; done when each package's description or summary appears in JSON and existing output tests pass.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- go
- Domain
- cli
- Issue type
- Feature
- Difficulty
- 3/5
- Estimated time
- 1-2 days
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 35/100