about summary refs log tree commit diff
path: root/web/todolist/extract-todos.jq
diff options
context:
space:
mode:
authorVincent Ambo <mail@tazj.in>2020-07-19T23·34+0100
committertazjin <mail@tazj.in>2020-07-19T23·40+0000
commit259750277a67bcc89377cbe9456c463cb3f5a59a (patch)
treee9b8596e34f3d64621c5ce1b4956feebb0b1213b /web/todolist/extract-todos.jq
parent15afa8472e1b1bbf236d4cf8e9f399345c48d3fe (diff)
feat(web/todolist): Implement a "todo-list" page generator r/1404
This invokes ripgrep & jq to construct a list of TODOs from known
users across depot sources, and dumps it into a static page that we
can serve.

The structure is relatively simple, but it might be useful. See here
for an example of what this looks like:

https: //tazj.in/blobs/todos.png
Change-Id: I1edef56606273584ab886b9e762c8ed4d210919d
Reviewed-on: https://cl.tvl.fyi/c/depot/+/1296
Tested-by: BuildkiteCI
Reviewed-by: Alyssa Ross <hi@alyssa.is>
Diffstat (limited to 'web/todolist/extract-todos.jq')
-rw-r--r--web/todolist/extract-todos.jq25
1 files changed, 25 insertions, 0 deletions
diff --git a/web/todolist/extract-todos.jq b/web/todolist/extract-todos.jq
new file mode 100644
index 000000000000..cda717fceb70
--- /dev/null
+++ b/web/todolist/extract-todos.jq
@@ -0,0 +1,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