@agent-workshop/adoc-plugin-note 0.0.0-stage → 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,63 @@
+import { anchor, definePlugin, frontmatter, html, markdown, ref, slug, source } from "@agent-workshop/adoc-plugin-kit";
+function parse(doc) {
+  const { data, body, bodyLine } = frontmatter(doc.text);
+  const sections = [];
+  let intro = "";
+  body.split("\n").forEach((l, i) => {
+    const m = /^## (.+)$/.exec(l);
+    if (m) sections.push({ heading: m[1].trim(), anchor: slug(m[1]), line: bodyLine + i, body: "", bodyLine: bodyLine + i + 1 });
+    else if (sections.length) sections[sections.length - 1].body += l + "\n";
+    else intro += l + "\n";
+  });
+  const status = String(data.status ?? "OPEN");
+  const movedTo = data.moved_to ? String(data.moved_to) : void 0;
+  return { title: String(data.title ?? doc.key), status, movedTo, intro, bodyLine, sections };
+}
+function count(section) {
+  return section ? section.body.split("\n").filter((l) => /^\s*[-*] /.test(l)).length : 0;
+}
+function renderNote(doc, previous) {
+  const note = parse(doc);
+  const before = previous ? parse(previous) : void 0;
+  const old = new Map(before?.sections.map((s) => [s.anchor, s]));
+  const removed = before ? before.sections.filter((s) => !note.sections.some((n) => n.anchor === s.anchor)) : [];
+  return html`
+    <div class="adoc-toolbar">
+      ${note.movedTo ? html`<span class="adoc-muted">moved to ${ref(note.movedTo)}</span>` : ""}
+      ${before && before.status !== note.status ? html`<span class="adoc-changed">status: ${before.status} → ${note.status}</span>` : ""}
+    </div>
+    ${note.intro.trim() ? markdown(note.intro, { file: doc.file, line: note.bodyLine }) : ""}
+    ${note.sections.map((s) => {
+    const prior = old.get(s.anchor);
+    const mark = !before ? "" : !prior ? "adoc-added" : prior.body.trim() !== s.body.trim() ? "adoc-changed" : "";
+    return html`
+        <section class="adoc-section ${mark}" ${anchor(s.anchor)}>
+          <h2 ${source(doc.file, s.line)}>${s.heading}${mark ? html` <span class="adoc-chip">${mark === "adoc-added" ? "new" : "changed"}</span>` : ""}</h2>
+          ${markdown(s.body, { file: doc.file, line: s.bodyLine })}
+        </section>`;
+  })}
+    ${removed.map(
+    (s) => html`
+        <section class="adoc-section adoc-removed">
+          <h2>${s.heading} <span class="adoc-chip">removed</span></h2>
+          ${markdown(s.body)}
+        </section>`
+  )}`;
+}
+var index_default = definePlugin({
+  description: "A free-form shared note: ideas from a conversation, open questions, decisions, or anything the two of you want to keep.",
+  layout: { kind: "file", extension: ".md" },
+  summarize(doc) {
+    const note = parse(doc);
+    const questions = count(note.sections.find((s) => s.anchor === "open-questions"));
+    const decisions = count(note.sections.find((s) => s.anchor === "decisions"));
+    const fields = { "open questions": questions, decisions };
+    if (note.movedTo) fields["moved to"] = note.movedTo;
+    return { title: note.title, status: note.status === "OPEN" ? `OPEN \xB7 ${questions} open questions` : note.status, fields };
+  },
+  render: (doc) => renderNote(doc),
+  renderChanges: (doc, previous) => renderNote(doc, previous)
+});
+export {
+  index_default as default
+};

package/package.json

@@ -1,6 +1,39 @@
 {
   "name": "@agent-workshop/adoc-plugin-note",
-  "version": "0.0.0-stage",
-  "stub": true,
-  "description": "Temporary package placeholder for staged publishing"
+  "version": "0.1.0",
+  "license": "0BSD",
+  "type": "module",
+  "description": "The NOTE plugin of adoc: free-form shared notes for ideas, open questions and decisions.",
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/dirty49374/adoc.git",
+    "directory": "plugins/note"
+  },
+  "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,67 @@
+---
+name: adoc-note
+description: "NOTE documents: free-form shared notes for ideas, open questions and decisions. Use when discussing an idea with the user, explaining something (with Mermaid diagrams), or recording decisions before they become TODO items or TASKs."
+---
+
+# NOTE documents
+
+Document keys look like `NOTE-<local id>`. Read the general workflow with `adoc skill view adoc`.
+
+## Purpose
+
+A NOTE is the shared space where the user and the agent think together: an idea from a conversation developed with comments, a comparison of options, an explanation, meeting notes, or casual talk. The user refines it with comments instead of re-reading the chat. Not every note has to lead anywhere.
+
+## States and workflow
+
+- `OPEN` while the idea is being developed: items move from **Open questions** to **Decisions** as the user answers.
+- When the idea is ready, agree with the user in the conversation on what it becomes: TODO items, a TASK (which lists the note in `notes:`), a spec change, or nothing. When it went into documents, set `status: MOVED` and `moved_to:` the key of the main one, and name the others under **Decisions**. A note that led to nothing stays `OPEN` until it is archived.
+- Finished notes are archived like any document, when the user asks, or with the TASKs that list them in `notes:` (see the TASK skill).
+
+## Instructions
+
+- Write the body in the user's language; the section headings stay in English as below, so that their anchors stay stable.
+- When a conversation produced an idea worth keeping, write a note yourself: summarize what was said into the sections, run `adoc check`, commit, and open it for the user with `adoc ui open NOTE-<local id>`.
+- Draw state machines, sequences and structures with Mermaid (```` ```mermaid ````) whenever a picture explains faster than prose.
+- Keep **Open questions** and **Decisions** short and current, one item per bullet (the status counts the bullets of **Open questions**): rewrite instead of appending history (git keeps the history).
+- Ask the user in **Open questions**, not with `> Question:`. When the user answers a question, move it to **Decisions** with the answer; mark a decision you made on their behalf with `(agent's decision)`.
+- Never turn a note into a TASK without the user's agreement; propose it.
+
+## File
+
+`NOTE-<local id>.md`: YAML front matter, then Markdown with `##` sections.
+
+```markdown
+---
+title: NOTE plugin
+status: OPEN            # OPEN | MOVED
+moved_to: TASK-261003-note-plugin   # only when MOVED
+---
+
+## Background
+
+Why this came up.
+
+## Ideas
+
+- …
+
+## Open questions
+
+- …
+
+## Decisions
+
+- …
+```
+
+- The four sections are the default for developing an idea; use any sections, or none, when the note is about something else.
+- Write `[[KEY]]` to refer to other documents.
+- Recommended local id: today's date (yymmdd) and a title, such as `NOTE-261002-note-plugin`.
+
+## Anchors
+
+The anchor of a section is its heading in lowercase, with every run of other characters than letters and digits turned into one hyphen: `## Open questions` is `NOTE-…#open-questions`.
+
+## Actions
+
+None of its own beyond the common `archive` and `unarchive` (see the adoc skill).

package/README.md

@@ -1,3 +0,0 @@
-# Temporary Holding Version
-
-This version is a temporary placeholder for this package. An operational version to replace this has been submitted for review and is awaiting a staged release.