diff options
Diffstat (limited to 'web/todolist/extract-todos.jq')
-rw-r--r-- | web/todolist/extract-todos.jq | 30 |
1 files changed, 30 insertions, 0 deletions
diff --git a/web/todolist/extract-todos.jq b/web/todolist/extract-todos.jq new file mode 100644 index 000000000000..d4e0476c403a --- /dev/null +++ b/web/todolist/extract-todos.jq @@ -0,0 +1,30 @@ +# 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 |