aboutcode-org / aboutcode-org/scancode-toolkit

RFC: Improve tabular output formats

Đang mở
#3,043 7 bình luận 0 reaction 0 người được giao Xem trên GitHub
GUI and outputs must have Priority: high RFC
Ngôn ngữ chính
Python
Star
2.6k
Fork
791
Merge trung bình
1 ngày 12 giờ
Pull request đã merge (30 ngày)
5

Mô tả

The current CSV output is a mess, albeit a convenient mess. We need something and quick. I suggest these short term and long term actions

## For now in v31:

- [x] #3047
The deprecation message should have a link to this PR.

## In v32:

- [ ] Create a new `--csv-file` option that would only list file level details in this way:
- file info columns, license expression, copyright, holder, urls, emails, "for_package".
- no line number columns, no package data
- exactly one row per file
- multiple values are joined with a line in a single cell
- long values that exceed offices tools limits are truncated
- [ ] Create a new `--csv-package` option that would only list package details:
- one row per package instance
- [ ] Create a new `--csv-dependency` option that would only list dependency details:
- one row per dependency instance
- [ ] Create a new `--csv-license` option that would only list file level license scan information, used for debugging and **hidden** from the CLI help:
- one row for each license match with diagnostic details for each match (rule, scores, etc)

- [ ] Drop the hidden `--csv` option in v32
- [ ] Add new XLSX option that creates a proper spreadsheet with multiples tabs
- files
- packages
- dependencies
- summary
- and possibly: file "package_data", file "license_detections"
where these essentially mirror the new csv-* options

For reference, we have these related issues:

- [ ] #2839 is the key issue and would drop CSV for XLSX
- [ ] #1551 shows that serialization in a row is always an issue
- [ ] #2249
- [ ] #1822
- [ ] #1398
- [ ] #829
- [ ] #830
- [ ] #2936 where @yahym uses a pivot table
- [ ] #1330 shows we have documentation issues
- [ ] #1654 ... combining JSONs to create a CSV is not easy

Hướng dẫn đóng góp

Mở hướng dẫn đóng góp

Đánh giá

Issue này chưa được đánh giá.

Nhận issue mới trong hộp thư của bạn

Bản tóm tắt ngắn những issue GitHub phù hợp với người mới.