tatr-ql 0.2.0 → 0.3.1

package/README.md

@@ -1,2 +1,27 @@
-# tatr
-Task Tracker (Nodejs Version)
+# tatr-ql
+tatr-ql is a Node.js reimplementation of [tsoding/tatr](https://github.com/tsoding/tatr), a Task Tracker Query Language created by [Tsoding](https://github.com/tsoding).
+
+The original project is implemented in C/C++. This project brings the same concept and functionality to the JavaScript/Node.js ecosystem.
+
+> [!NOTE]
+> This is my first piece of AI slop. The tests were AI-generated. Honestly, the main things I implemented myself were the `Zod` schema validation and the integration of [TermDom](https://termdom.org/) with [ZikoJS](https://github.com/zikojs/ziko/) for the UI.
+I could build the rest from scratch, but I don't have the time right now. I mainly needed the API to monitor my 50+ ZikoJS packages on npm.
+
+## Install
+
+```console
+ npm i tatr-ql -g
+```
+
+## Task.md
+
+```md
+# <title>
+
+- STATUS: (OPEN|CLOSED)
+- PRIORITY: <number>
+- TAGS: <comma-and-whitespace-separated-list-of-tags>
+[other properties]
+
+[description]
+```

package/bin/index.js

@@ -1,4 +1,4 @@
-#!/usr/bin/env node
+#!/usr/bin/env node
 import { main } from "../src/cli.js";
 
 main().catch((error) => {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "tatr-ql",
-  "version": "0.2.0",
+  "version": "0.3.1",
   "description": "Task Tracker (Nodejs Version)",
   "keywords": [
     "task",
@@ -27,9 +27,11 @@
     "test:run": "vitest run"
   },
   "bin": {
-    "tatr": "./bin/tatr.js"
+    "tatr": "./bin/index.js"
   },
   "dependencies": {
+    "@b9g/termdom": "^0.1.6",
+    "vanjs-core": "^1.6.1",
     "ziko": "^2.0.0-beta.10",
     "zod": "^4.6.2"
   },

package/src/cli.js

@@ -14,45 +14,21 @@ import { parseTags } from "./task.js";
 import { matchesQuery } from "./query.js";
 import packageJson from "../package.json" with { type: "json" };
 
-const {version : VERSION} = packageJson;
+import {TermDOM} from "@b9g/termdom";
+const term = new TermDOM();
+term.attach();
+const {document, window} = term;
+globalThis.document = document
+globalThis.window = window
+
+
+import {
+  StartPager, 
+  Help,
+  ShowTask
+} from "./components/index.js";
 
-const help = () => console.log(`
-tatr ${VERSION} — filesystem task tracker
-
-Usage:
-  tatr <command> [options]
-
-Commands:
-  new <title>       Create a task
-  ls [query]        List tasks, optionally filtered by TQL
-  show <id>         Show a task
-  edit <id>         Edit TASK.md in $EDITOR
-  close <id>        Mark a task CLOSED
-  reopen <id>       Mark a task OPEN
-  rm <id>           Delete a task
-  tags              Show tag descriptions
-  init              Create tasks/
-  help              Show this help
-  version           Show the version
-
-new options:
-  --priority <n>    Task priority (default: 0)
-  --tags <a,b,c>    Comma-separated tags
-  --suffix <name>   HUID suffix
-  --description <x> Initial description
-
-ls options:
-  --all             Include CLOSED tasks (default is all; kept for compatibility)
-  --open            Only OPEN tasks
-  --closed          Only CLOSED tasks
-
-TQL examples:
-  tatr ls :bug
-  tatr ls ':bug and not :ui'
-  tatr ls 'not tagged'
-  tatr ls ':bug and priority lt 50'
-  tatr ls '[:bug or :enhancement] and priority ge 10'
-`.trim());
+const {version : VERSION} = packageJson;
 
 const parseFlags = (args) => {
   const positionals = [];
@@ -131,11 +107,25 @@ const commandShow = async (id) => {
 
   const task = await readTask(id);
 
-  console.log(`ID:       ${task.id}`);
-  console.log(`TITLE:    ${task.title}`);
-  console.log(`STATUS:   ${task.status}`);
-  console.log(`PRIORITY: ${task.priority}`);
-  console.log(`TAGS:     ${task.tags.join(", ")}`);
+  const {title, status, priority, tags} = task
+
+  ShowTask({id, title, status, priority, tags}).mount(document.body)
+
+  // console.log(`ID:       ${task.id}`);
+  // console.log(`TITLE:    ${task.title}`);
+  // console.log(`STATUS:   ${task.status}`);
+  // console.log(`PRIORITY: ${task.priority}`);
+  // console.log(`TAGS:     ${task.tags.join(", ")}`);
+
+  // table(
+  //   tbody(
+  //     tr(td("ID"),       td(task.id)),
+  //     tr(td("TITLE"),    td(task.title)),
+  //     tr(td("STATUS"),   td(task.status)),
+  //     tr(td("PRIORITY"), td(task.priority)),
+  //     tr(td("TAGS"),     td(task.tags.join(", ")))
+  //   )
+  // ).mount(document.body)
 
   if (task.description) console.log(`\n${task.description}`);
 };
@@ -193,10 +183,11 @@ export const main = async (argv = process.argv.slice(2)) => {
   const [command = "help", ...args] = argv;
 
   switch (command) {
-    case "help":
+    case "help": 
     case "-h":
     case "--help":
-      help();
+      Help({version : VERSION}).mount(document.body);
+      await StartPager()
       break;
     case "version":
     case "-v":

package/src/components/Help.js

@@ -0,0 +1,150 @@
+import { tags } from "ziko/dom";
+const {
+    div, h1, span, h2, section, pre, table, tbody, tr, td
+} = tags
+export const Help = ({ version = '0.1.0'} = {}) =>
+  div(
+    pre(`
+        -
+    `),
+    h1(
+      `tatr ${version}`,
+      span(" — filesystem task tracker")
+    ).style({
+        color : 'blue'
+    }),
+
+    section(
+      h2("Usage"),
+
+      pre(
+        "tatr <command> [options]"
+      )
+    ),
+
+    section(
+      h2("Commands"),
+
+      table(
+        tbody(
+          tr(
+            td("new <title>"),
+            td("Create a task")
+          ),
+
+          tr(
+            td("ls [query]"),
+            td("List tasks, optionally filtered by TQL")
+          ),
+
+          tr(
+            td("show <id>"),
+            td("Show a task")
+          ),
+
+          tr(
+            td("edit <id>"),
+            td("Edit TASK.md in $EDITOR")
+          ),
+
+          tr(
+            td("close <id>"),
+            td("Mark a task CLOSED")
+          ),
+
+          tr(
+            td("reopen <id>"),
+            td("Mark a task OPEN")
+          ),
+
+          tr(
+            td("rm <id>"),
+            td("Delete a task")
+          ),
+
+          tr(
+            td("tags"),
+            td("Show tag descriptions")
+          ),
+
+          tr(
+            td("init"),
+            td("Create tasks/")
+          ),
+
+          tr(
+            td("help"),
+            td("Show this help")
+          ),
+
+          tr(
+            td("version"),
+            td("Show the version")
+          )
+        )
+      )
+    ),
+
+    section(
+      h2("new options"),
+
+      table(
+        tbody(
+          tr(
+            td("--priority <n>"),
+            td("Task priority (default: 0)")
+          ),
+
+          tr(
+            td("--tags <a,b,c>"),
+            td("Comma-separated tags")
+          ),
+
+          tr(
+            td("--suffix <name>"),
+            td("HUID suffix")
+          ),
+
+          tr(
+            td("--description <x>"),
+            td("Initial description")
+          )
+        )
+      )
+    ),
+
+    section(
+      h2("ls options"),
+
+      table(
+        tbody(
+          tr(
+            td("--all"),
+            td("Include CLOSED tasks (default is all; kept for compatibility)")
+          ),
+
+          tr(
+            td("--open"),
+            td("Only OPEN tasks")
+          ),
+
+          tr(
+            td("--closed"),
+            td("Only CLOSED tasks")
+          )
+        )
+      )
+    ),
+
+    section(
+      h2("TQL examples"),
+
+      pre(
+        `tatr ls :bug
+tatr ls ':bug and not :ui'
+tatr ls 'not tagged'
+tatr ls ':bug and priority lt 50'
+tatr ls '[:bug or :enhancement] and priority ge 10'`
+      )
+    )
+  );

package/src/components/ShowTask.js

@@ -0,0 +1,11 @@
+import { tags } from "ziko/dom"
+const { table, tbody, tr, td} = tags
+export const ShowTask = ({id, title, status, priority, tags} = {}) => table(
+    tbody(
+      tr(td("ID"),       td(id)),
+      tr(td("TITLE"),    td(title)),
+      tr(td("STATUS"),   td(status)),
+      tr(td("PRIORITY"), td(priority)),
+      tr(td("TAGS"),     td(tags.join(", ")))
+    )
+  )

package/src/components/StartPager.js

@@ -0,0 +1,54 @@
+export const StartPager = async () => {
+  // Let TermDOM finish its initial layout.
+  await new Promise((resolve) =>
+    window.requestAnimationFrame(resolve)
+  );
+
+  await new Promise((resolve) =>
+    window.requestAnimationFrame(resolve)
+  );
+
+  // Reset the camera after layout has settled.
+  window.scrollTo(0, 0);
+
+  const page = () => Math.max(1, window.innerHeight - 1);
+
+  const height = () =>
+    Math.max(
+      0,
+      document.body.scrollHeight - window.innerHeight
+    );
+
+  const bindings = {
+    " ": () => window.scrollBy(0, page()),
+    f: () => window.scrollBy(0, page()),
+    PageDown: () => window.scrollBy(0, page()),
+
+    b: () => window.scrollBy(0, -page()),
+    PageUp: () => window.scrollBy(0, -page()),
+
+    j: () => window.scrollBy(0, 1),
+    ArrowDown: () => window.scrollBy(0, 1),
+
+    k: () => window.scrollBy(0, -1),
+    ArrowUp: () => window.scrollBy(0, -1),
+
+    g: () => window.scrollTo(0, 0),
+
+    G: () =>
+      window.scrollTo(
+        0,
+        height()
+      ),
+
+    q: () =>
+      term.window.close()
+  };
+
+  document.addEventListener(
+    "keydown",
+    (event) => {
+      bindings[event.key]?.();
+    }
+  );
+};

package/src/components/index.js

@@ -0,0 +1,3 @@
+export * from './StartPager.js'
+export * from './Help.js'
+export * from './ShowTask.js'

package/tasks/20260912-153638/TASK.md

@@ -0,0 +1,6 @@
+# Remove duplicate tags
+
+- STATUS: OPEN
+- PRIORITY: 0
+- TAGS: bug, bug
+

package/tasks/20260912-165231/TASK.md

@@ -0,0 +1,6 @@
+# Fix global install issue
+
+- STATUS: OPEN
+- PRIORITY: 0
+- TAGS: 
+