e096146937
This modifies the capture regex executed by `jq` to capture the TODO text itself as a separate capture group, which is then used for the content of the TODO listing. The web listing looks much cleaner this way. Change-Id: I00a14da57b315a353f700c112ba33f38e16f1f85 Reviewed-on: https://cl.tvl.fyi/c/depot/+/2749 Tested-by: BuildkiteCI Reviewed-by: flokli <flokli@flokli.de>
30 lines
960 B
Text
30 lines
960 B
Text
# Simple jq script to extract all TODO comments in the code base from
|
|
# ripgrep's JSON output.
|
|
#
|
|
# This assumes that the filter used is something like 'TODO\(\w+\):'
|
|
|
|
# Capture the username and todo entry from an input string.
|
|
def capture_todo:
|
|
capture("TODO\\((?<user>\\w+)\\):\\s+(?<todo>.*)$");
|
|
|
|
# Construct a structure with only the fields we need to populate the
|
|
# page.
|
|
def simplify_match:
|
|
.data as $data
|
|
| (.data.submatches[0].match.text | capture_todo) as $capture
|
|
| {
|
|
file: ($data | .path.text | sub("/nix/store/.+-depot/"; "")),
|
|
line: ($data | .line_number),
|
|
todo: ($capture | .todo),
|
|
user: ($capture | .user),
|
|
};
|
|
|
|
# Group all matches first by the user and return them in sorted order
|
|
# by the file in which they appear. This matches the presentation
|
|
# order on the website.
|
|
def group_by_user: .
|
|
| group_by(.user)
|
|
| map(sort_by(.file));
|
|
|
|
# main:
|
|
map(select(.type == "match") | simplify_match) | group_by_user
|