web/todolist/extract-todos.jq


1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25

# 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+\):'

# Construct a structure with only the fields we need to populate the
# page.
def simplify_match:
  .data.submatches[0].match.text as $todo
  | {
     file: (.data.path.text | sub("/nix/store/.+-depot/"; "")),
     line: .data.line_number,
     todo: $todo,
     user: ($todo | capture("TODO\\((?<user>\\w+)\\)") | .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