@agent-workshop/adoc-plugin-todo 0.1.0

package/LICENSE

@@ -0,0 +1,5 @@
+Copyright (C) 2026 adoc contributors
+
+Permission to use, copy, modify, and/or distribute this software for any purpose with or without fee is hereby granted.
+
+THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.

package/THIRD_PARTY_NOTICES.md

@@ -0,0 +1,49 @@
+# Third-party notices
+
+adoc's original code and documentation use the Zero-Clause BSD License (0BSD). That license does not replace the
+licenses of third-party components, and no third-party component is relicensed by this repository.
+
+## Browser distributions
+
+Two packages carry bundled browser code:
+
+- `@agent-workshop/adoc-webapp`: the web UI in `dist/`. Its build records the packages actually bundled in
+  `dist/licenses/packages.json` and copies their upstream LICENSE, COPYING, COPYRIGHT and NOTICE files beneath
+  `dist/licenses/`.
+- `@agent-workshop/adoc-plugin-sketch`: the drawing board in `client/`, with its inventory and license files in
+  `client/licenses/`.
+
+Keep these files when redistributing the built browser assets.
+
+The main browser dependencies are React, React DOM, React Router, Mermaid (with KaTeX), xterm.js and Lucide in the web
+UI, and Excalidraw with React and Radix UI in the drawing board. Most use MIT, ISC, BSD or Apache-2.0.
+
+- DOMPurify offers MPL-2.0 OR Apache-2.0; adoc uses the Apache-2.0 option.
+- Some packages are published without a license file although their manifest names one: Excalidraw, the Radix UI
+  primitives, react-remove-scroll-bar and fastdom (all MIT). The build includes the upstream texts kept in
+  `tooling/licenses/`.
+
+### Eclipse Layout Kernel / elkjs
+
+Mermaid bundles elkjs, a separately licensed layout engine, which adoc uses under EPL-2.0 without modifying it. Its
+license is included in the generated license inventory. Corresponding source is available from:
+
+- https://github.com/kieler/elkjs (select the release matching the inventory version)
+- https://github.com/eclipse/elk (the underlying Eclipse Layout Kernel)
+- https://www.eclipse.org/legal/epl-2.0/
+
+Recipients may obtain, modify and redistribute the EPL-covered source under EPL-2.0. adoc's 0BSD license applies to its
+independent code, not to ELK.
+
+## Fonts
+
+- The web UI serves Pretendard, D2Coding (both SIL Open Font License 1.1) and Symbols Nerd Font Mono; their license
+  files are next to them in `dist/assets/fonts/`.
+- The drawing board serves the fonts that Excalidraw ships in `client/fonts/` (Excalifont, Virgil, Nunito, Lilita One,
+  Comic Shanns, Cascadia Code, Liberation Sans, Assistant and Xiaolai); they are distributed under the terms that
+  Excalidraw states for them in https://github.com/excalidraw/excalidraw.
+
+## Installed runtime dependencies
+
+The packages that npm installs next to adoc, such as the MCP SDK, ws, yaml, zod, semver, commander, markdown-it and
+highlight.js, are not bundled: each keeps its own license in its own package.

package/dist/index.js

@@ -0,0 +1,64 @@
+import { action, anchor, definePlugin, html, markdown, raw, source } from "@agent-workshop/adoc-plugin-kit";
+const ITEM = /^(\s*)- \[( |x|X)\] (.*)$/;
+const GROUP = /^## (.+)$/;
+function parse(doc) {
+  const lines = doc.text.split("\n");
+  const title = lines.find((l) => l.startsWith("# "))?.slice(2).trim();
+  const items = [];
+  const groups = [{ items: [] }];
+  lines.forEach((l, i) => {
+    const heading = GROUP.exec(l);
+    if (heading) groups.push({ line: i + 1, heading: heading[1].trim(), items: [] });
+    const m = ITEM.exec(l);
+    if (m) {
+      const item = { line: i + 1, done: m[2] !== " ", text: m[3] };
+      items.push(item);
+      groups[groups.length - 1].items.push(item);
+    }
+  });
+  return { title, items, groups: groups.filter((g) => g.heading !== void 0 || g.items.length > 0), lines };
+}
+var index_default = definePlugin({
+  description: "A list of one-line things to do, as a Markdown task list.",
+  layout: { kind: "file", extension: ".md" },
+  summarize(doc) {
+    const { title, items } = parse(doc);
+    const done = items.filter((i) => i.done).length;
+    return { title: title ?? doc.key, status: `${done}/${items.length} done`, fields: { open: items.length - done, done } };
+  },
+  render(doc) {
+    const { items, groups } = parse(doc);
+    const list = (group) => html`
+      <ul class="adoc-list">
+        ${group.items.map(
+      (item) => html`
+            <li class="adoc-item ${item.done ? "adoc-done" : ""}" ${anchor(item.line)} ${source(doc.file, item.line)}>
+              <input type="checkbox" ${action({ kind: "toggle", name: "toggle", value: item.line, confirm: item.done ? "Ask the agent to reopen this item?" : "Ask the agent to do this item?" })} ${item.done ? raw("checked") : ""} />
+              <span>${markdown(item.text, { inline: true })}</span>
+            </li>`
+    )}
+      </ul>`;
+    return html`
+      ${items.length ? "" : html`<p class="adoc-muted">No items yet.</p>`}
+      ${groups.map(
+      (group) => group.heading === void 0 ? list(group) : html`
+              <section class="adoc-section" ${anchor(group.line)}>
+                <h2 ${source(doc.file, group.line)}>${markdown(group.heading, { inline: true })} <span class="adoc-muted">${group.items.filter((i) => i.done).length}/${group.items.length}</span></h2>
+                ${list(group)}
+              </section>`
+    )}`;
+  },
+  actions: {
+    // A click asks the agent: checking an open item asks it to do the item, unchecking a done one to reopen it.
+    // The file stays as it is until the agent checks or unchecks the item itself.
+    toggle(doc, event) {
+      const { lines } = parse(doc);
+      const m = ITEM.exec(lines[Number(event.value) - 1] ?? "");
+      if (!m) throw new Error(`line ${event.value} is not a task item`);
+      return { message: `user request: ${event.checked ? "do" : "reopen"} item ${doc.key}#${event.value}: ${m[3]}` };
+    }
+  }
+});
+export {
+  index_default as default
+};

package/package.json

@@ -0,0 +1,39 @@
+{
+  "name": "@agent-workshop/adoc-plugin-todo",
+  "version": "0.1.0",
+  "license": "0BSD",
+  "type": "module",
+  "description": "The TODO plugin of adoc: lists of one-line things to do, as Markdown task lists.",
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/dirty49374/adoc.git",
+    "directory": "plugins/todo"
+  },
+  "files": [
+    "dist",
+    "skill",
+    "LICENSE",
+    "THIRD_PARTY_NOTICES.md"
+  ],
+  "engines": {
+    "node": ">=24"
+  },
+  "publishConfig": {
+    "registry": "https://registry.npmjs.org",
+    "access": "public"
+  },
+  "exports": {
+    ".": "./dist/index.js",
+    "./package.json": "./package.json"
+  },
+  "peerDependencies": {
+    "@agent-workshop/adoc-plugin-kit": "^0.1.0"
+  },
+  "devDependencies": {
+    "esbuild": "0.28.2",
+    "@agent-workshop/adoc-plugin-kit": "0.1.0"
+  },
+  "scripts": {
+    "build": "esbuild index.ts --outfile=dist/index.js --format=esm --platform=node --log-level=warning"
+  }
+}

package/skill/SKILL.md

@@ -0,0 +1,57 @@
+---
+name: adoc-todo
+description: "TODO documents: lists of one-line things to do, as Markdown task lists with optional groups. Use when the user wants something remembered or done that fits in one line, or comments on, checks or groups TODO items."
+---
+
+# TODO documents
+
+Document keys look like `TODO-<local id>`. Read the general workflow with `adoc skill view adoc`.
+
+## Purpose
+
+A TODO list keeps small things to do, each one line, so that nothing small gets lost. Bigger work, which needs a design or several steps, becomes a TASK instead.
+
+## States and workflow
+
+- An item is open (`- [ ]`) or done (`- [x]`). Only you check and uncheck items: when you finish one, or when the user asks.
+- In the web UI, checking an open item asks you to do it, and unchecking a done one asks you to reopen it (see Actions); the box stays as it is until you change the file.
+- Group related items under `## Heading` lines when the list has more than about ten items; keep done items in their group so that the group shows its progress.
+
+## Instructions
+
+- Keep every item one line. When an item needs more than a line, it is a TASK: propose one in your conversation; once the user agrees, create the TASK and point the item to it: `- [ ] Rework the auth layer: [[TASK-261010-auth]]`.
+- When you finish an item, check it and append `; done: …`, saying what was done and where, such as a commit or a document key.
+- When the user asks to add something "to the TODO", add one item in the right group; create a group when none fits.
+- Never delete or reword an item the user wrote without asking; you only check it, append the `done:` clause, or point it to a TASK the user agreed to.
+- Check an item that points to a TASK when the TASK is DONE, and list the TODO in the TASK's `related:`.
+- Ask the user in your conversation, not in the file: the view shows only items and group headings.
+
+## File
+
+`TODO-<local id>.md`, a Markdown task list under an optional `# Title`:
+
+```markdown
+# GUI work
+
+- [ ] Refactor PaymentRepo
+
+## Login screen
+
+- [x] Dark mode for the login screen; done: [[TASK-260930-dark-mode]]
+- [ ] Remember the last user name
+```
+
+- One item per line: `- [ ] text` (open) or `- [x] text` (done). Write `[[KEY]]` to refer to another document.
+- A `## Heading` line starts a group, until the next heading; items before the first heading have no group. Other lines are ignored by the view.
+- Recommended local id: a topic, such as `TODO-gui` or `TODO-backend`.
+
+## Anchors
+
+The anchor of an item, and of a group heading, is its 1-based line number: `TODO-gui#5` is line 5. If the line moved, find the item by the `quote` of the comment, or by the item text in an action message.
+
+## Actions
+
+| action | what adoc already did | what you do |
+|---|---|---|
+| `toggle`, message `user request: do item TODO-gui#3: …` | nothing (`applied: false`) | do the item, then check it and append `; done: …` |
+| `toggle`, message `user request: reopen item TODO-gui#3: …` | nothing (`applied: false`) | uncheck the item, remove its `done:` clause, and do what the user asks with it |