From 259750277a67bcc89377cbe9456c463cb3f5a59a Mon Sep 17 00:00:00 2001 From: Vincent Ambo Date: Mon, 20 Jul 2020 00:34:14 +0100 Subject: [PATCH] feat(web/todolist): Implement a "todo-list" page generator 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 --- ci-builds.nix | 1 + web/todolist/default.nix | 113 ++++++++++++++++++++++++++++++++++ web/todolist/extract-todos.jq | 25 ++++++++ 3 files changed, 139 insertions(+) create mode 100644 web/todolist/default.nix create mode 100644 web/todolist/extract-todos.jq diff --git a/ci-builds.nix b/ci-builds.nix index 2e4e40392..349ce9e98 100644 --- a/ci-builds.nix +++ b/ci-builds.nix @@ -74,6 +74,7 @@ in lib.fix (self: { tools.cheddar tools.nsfv-setup web.cgit-taz + web.todolist web.tvl (drvify "getBins-tests" nix.getBins.tests) ] diff --git a/web/todolist/default.nix b/web/todolist/default.nix new file mode 100644 index 000000000..187830e73 --- /dev/null +++ b/web/todolist/default.nix @@ -0,0 +1,113 @@ +# Generates a simple web view of open TODOs in the depot. +# +# Only TODOs that match the form 'TODO($username)' are considered, and +# only for users that are known to us. +{ depot, lib, ... }: + +with depot.nix.yants; + +let + inherit (depot.third_party) + jq + ripgrep + runCommandNoCC + writeText + ; + + inherit (builtins) + elem + filter + fromJSON + head + readFile + ; + + inherit (lib) concatStringsSep; + + # We should extract this from TVL slapd, but that data is not easily + # accessible right now. + knownUsers = [ + "tazjin" + "riking" + "Profpatsch" + "grfn" + "lukegb" + ]; + + todo = struct { + file = string; + line = int; + todo = string; + user = string; + }; + + allTodos = fromJSON (readFile (runCommandNoCC "depot-todos.json" {} '' + ${ripgrep}/bin/rg --json 'TODO\(\w+\):.*$' ${depot.depotPath} | \ + ${jq}/bin/jq -s -f ${./extract-todos.jq} > $out + '')); + + knownUserTodos = filter (todos: elem (head todos).user knownUsers) allTodos; + + fileLink = defun [ todo string ] (t: + '' + //${t.file}:${toString t.line}''); + + todoElement = defun [ todo string ] (t: '' +

At ${fileLink t}:

+
${t.todo}
+ + ''); + + userParagraph = todos: + let user = (head todos).user; + in '' +

+

${user}

+ ${concatStringsSep "\n" (map todoElement todos)} +

+
+ ''; + + todoPage = writeText "index.html" '' + + + + + + + + TVL's todo-list + + + +
+

The Virus Lounge's todo-list

+
+
+
+ ${concatStringsSep "\n" (map userParagraph knownUserTodos)} +
+ + + ''; + +in runCommandNoCC "tvl-todos" {} '' + mkdir $out + cp ${todoPage} $out/index.html + ln -s ${depot.web.tvl}/static $out/static +'' diff --git a/web/todolist/extract-todos.jq b/web/todolist/extract-todos.jq new file mode 100644 index 000000000..cda717fce --- /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\\((?\\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