KofTwentyTwo/license-tool
2
0 Fork 0
Code Issues 2 Pull Requests 9 Actions Packages Projects Releases 6 Wiki Activity

audit: summary + group-by report options #35

New Issue
Closed
opened 2026-06-08 18:02:57 +00:00 by KofTwentyTwo · 0 comments
KofTwentyTwo commented 2026-06-08 18:02:57 +00:00 (Migrated from github.com)
Copy link
Copy source

The text/markdown audit report always emits a flat per-file list, burying the grouped rollups. Add opt-in human-readable summary views.

Flags (audit, shared with check):

  • --summary — counts only; suppress the per-file list, per-dependency list, and pending diffs. Keep findings + rollups + violations.
  • --group-by <dim> — license|category|type|directory. Organize source files under each value of the dimension (per-group counts), replacing the flat file list. Unknown value is a usage error (exit 2). directory groups by top-level path segment.

Composition: none = today's full report (unchanged); --summary = counts only; --group-by X = files nested under X; --summary --group-by X = per-group counts only.

Scope: group-by applies to source files; dependency section unaffected (full, or counts under --summary). Affects text, markdown, and JSON (JSON gains an optional groups array and trims detail under --summary; default JSON unchanged).

Approach: render-time grouping — keep model.Report frozen; add pure GroupFiles + RenderOptions threaded into report.Render. Design: docs/DESIGN-audit-summary-reports.md.

The text/markdown audit report always emits a flat per-file list, burying the grouped rollups. Add opt-in human-readable summary views. **Flags (audit, shared with check):** - `--summary` — counts only; suppress the per-file list, per-dependency list, and pending diffs. Keep findings + rollups + violations. - `--group-by <dim>` — `license|category|type|directory`. Organize source files under each value of the dimension (per-group counts), replacing the flat file list. Unknown value is a usage error (exit 2). `directory` groups by top-level path segment. **Composition:** none = today's full report (unchanged); `--summary` = counts only; `--group-by X` = files nested under X; `--summary --group-by X` = per-group counts only. **Scope:** group-by applies to source files; dependency section unaffected (full, or counts under --summary). Affects text, markdown, and JSON (JSON gains an optional `groups` array and trims detail under --summary; default JSON unchanged). **Approach:** render-time grouping — keep model.Report frozen; add pure GroupFiles + RenderOptions threaded into report.Render. Design: docs/DESIGN-audit-summary-reports.md.
Sign in to join this conversation.
No Branch/Tag Specified
Labels
Clear labels
bug
Something isn't working
 dependencies
Pull requests that update a dependency file
 documentation
Improvements or additions to documentation
 duplicate
This issue or pull request already exists
 enhancement
New feature or request
 github_actions
Pull requests that update GitHub Actions code
 go
Pull requests that update go code
 good first issue
Good for newcomers
 help wanted
Extra attention is needed
 invalid
This doesn't seem right
 question
Further information is requested
 wontfix
This will not be worked on
No labels enhancement
Milestone
No items
No Milestone
Projects
Clear projects
No projects
Assignees
Clear assignees
forge-recovery (Forge Recovery) james.maes (James Maes)
No Assignees
1 Participants
Notifications
Due Date
No due date set.
Dependencies

No dependencies set.

Reference: KofTwentyTwo/license-tool#35