sfora-cli 0.9.0 → 0.11.0

package/dist/format/callout.js

@@ -0,0 +1,227 @@
+// GENERATED by scripts/sync-format.mjs from packages/markdown/src — DO NOT EDIT.
+// Edit packages/markdown/src and re-run the sync (any sfora-cli build does it).
+/**
+ * Callouts — the GFM alert grammar, `> [!NOTE]`.
+ *
+ * A callout is an ordinary blockquote whose first line is a type marker. That
+ * is the whole trick: every reader that does not know about callouts still
+ * sees quoted prose, and the bytes stay a blockquote on disk. There is no new
+ * fence, no new frontmatter key, nothing an agent has to learn.
+ *
+ *     > [!WARNING] Ship blocker
+ *     > The migration has to run before the deploy.
+ *
+ * Fifteen types. The first five are GitHub's alert set — note, tip, important,
+ * warning, caution — and the other ten are the Obsidian set every vault and
+ * every other markdown tool already writes, so a document pasted in from one of
+ * them keeps its tone instead of falling back to a plain quote. The marker is
+ * written uppercase and read case-insensitively, because people type `[!note]`
+ * and pasted GitHub markdown says `[!NOTE]` — both are the same callout, and
+ * the first save canonicalizes.
+ *
+ * Two things beyond the type sit on the marker line, and both are round-tripped
+ * rather than normalised away:
+ *
+ *   - an ALIAS. `[!WARN]`, `[!SUMMARY]`, `[!ERROR]` name a type by another
+ *     word. They resolve to the canonical type for rendering, and the word the
+ *     author actually typed is carried on `authoredAs` so the bytes come back
+ *     unchanged. Normalising the spelling would rewrite a line the author did
+ *     not touch, which is churn in a file two agents and a person share.
+ *   - a FOLD marker. Obsidian's `[!NOTE]+` and `[!NOTE]-` say the callout is
+ *     collapsible and whether it starts open. It is one character of grammar
+ *     and it is the whole difference between a callout and a details block.
+ *
+ * Pure functions over lines: no DOM, no ProseMirror, no React. The reader
+ * (`src/lib/utils/markdown.ts`), the Tiptap node
+ * (`src/components/editor/extensions/callout.ts`), and the CLI all read the
+ * grammar from here so they cannot disagree about what a callout is.
+ */
+export const CALLOUT_TYPES = [
+    // GitHub's five.
+    "note",
+    "tip",
+    "important",
+    "warning",
+    "caution",
+    // Obsidian's ten.
+    "abstract",
+    "info",
+    "todo",
+    "success",
+    "question",
+    "failure",
+    "danger",
+    "bug",
+    "example",
+    "quote",
+];
+/**
+ * The other words people write for a type that already exists. Ported from
+ * open-knowledge's `callout-transformer.ts:41-71`, which took them from
+ * Obsidian, so a vault's markdown lands here meaning what it meant there.
+ *
+ * An alias is a spelling, not a type: it never widens `CalloutType`, and the
+ * authored word survives on `Callout.authoredAs` rather than in the enum.
+ */
+export const CALLOUT_ALIASES = {
+    summary: "abstract",
+    tldr: "abstract",
+    check: "success",
+    done: "success",
+    help: "question",
+    faq: "question",
+    fail: "failure",
+    missing: "failure",
+    error: "danger",
+    cite: "quote",
+    idea: "tip",
+    hint: "tip",
+    warn: "warning",
+    attention: "warning",
+};
+const MARKER = /^\[!([A-Za-z]+)\]([+-])?[ \t]*(.*)$/;
+/**
+ * The marker as written: uppercase, so `[!NOTE]` is what lands on disk — unless
+ * the author spelled the type another way, in which case their word goes back.
+ *
+ * `authoredAs` is checked, not trusted. It is an attribute by the time it gets
+ * here (the editor carries it on the node), and an attribute a paste or a
+ * command could have set to anything; a marker that no longer resolves to this
+ * callout's type would come back as a plain quote with a stray bracket. So a
+ * spelling that does not resolve to `type` is discarded and the canonical word
+ * is written instead — the tone is preserved and only the churn is paid.
+ */
+export function calloutMarker(type, options = {}) {
+    const authored = options.authoredAs?.trim();
+    const token = authored && resolveCalloutType(authored) === type
+        ? authored
+        : type.toUpperCase();
+    return `[!${token}]${options.fold ?? ""}`;
+}
+/** True for the fifteen canonical type names, in any case. Aliases are not types. */
+export function isCalloutType(value) {
+    return CALLOUT_TYPES.includes(value.toLowerCase());
+}
+/**
+ * The token on a marker line — canonical or alias — resolved to the type that
+ * renders it, or null when it names nothing. Every caller that has to decide
+ * "is this a callout?" asks this rather than `isCalloutType`, because an alias
+ * IS a callout and only differs in how it is spelled.
+ */
+export function resolveCalloutType(token) {
+    const lower = token.toLowerCase();
+    if (isCalloutType(lower))
+        return lower;
+    return CALLOUT_ALIASES[lower] ?? null;
+}
+/**
+ * Drop one level of `>` quoting. A single space after the marker is part of
+ * the marker, not the content — `>  indented` keeps one space.
+ */
+export function stripQuoteMarkers(lines) {
+    return lines.map((line) => line.replace(/^[ \t]{0,3}>[ ]?/, ""));
+}
+/**
+ * Read a callout out of the lines of a blockquote.
+ *
+ * Accepts either raw source lines (`> [!NOTE]`) or lines whose quote markers a
+ * caller has already stripped (`[!NOTE]`) — the reader strips as it scans, the
+ * editor does not. The two are told apart by looking at the block as a whole:
+ * if every non-blank line is quoted, one level comes off. That way a callout
+ * whose body contains a nested quote survives either way round.
+ *
+ * Returns null for anything that is not a callout, which is the signal to
+ * render an ordinary blockquote.
+ */
+export function parseCallout(blockquoteLines) {
+    return readCallout(blockquoteLines)?.callout ?? null;
+}
+/**
+ * Index, within the same lines, of the callout body's first line — or -1 when
+ * the block is not a callout. A caller that re-parses `body` as markdown needs
+ * it to map a node back to the document line it came from; the reader joins
+ * its checkboxes to the document's line scan that way. Kept off `Callout`
+ * itself because the type is a value the editor and CLI construct by hand.
+ */
+export function calloutBodyLine(blockquoteLines) {
+    return readCallout(blockquoteLines)?.bodyLine ?? -1;
+}
+function readCallout(blockquoteLines) {
+    const nonBlank = blockquoteLines.filter((line) => line.trim() !== "");
+    if (nonBlank.length === 0)
+        return null;
+    const quoted = nonBlank.every((line) => /^[ \t]{0,3}>/.test(line));
+    const lines = quoted ? stripQuoteMarkers(blockquoteLines) : [...blockquoteLines];
+    // The emptiness check above ran on the RAW lines, and a line can be
+    // non-blank before its `>` marker comes off and blank after — a bare `>` is
+    // the whole of CommonMark's empty blockquote. Without this the findIndex
+    // returns -1 and the deref below throws, taking down the render of any post
+    // that contains one.
+    const first = lines.findIndex((line) => line.trim() !== "");
+    if (first === -1)
+        return null;
+    const match = MARKER.exec(lines[first].trim());
+    if (!match)
+        return null;
+    const keyword = match[1];
+    const type = resolveCalloutType(keyword);
+    if (!type)
+        return null;
+    // The author's own spelling, kept only when it is not the canonical word.
+    // Same test open-knowledge makes (`callout-transformer.ts:223-224`): a
+    // lowercase `[!note]` is the canonical type spelled small, so it still
+    // canonicalizes on save and the existing law does not move.
+    const authoredAs = keyword.toLowerCase() === type ? undefined : keyword;
+    const fold = match[2] === "+" || match[2] === "-" ? match[2] : undefined;
+    const title = match[3].trim();
+    // Same trim as `trimBlankEdges`, unrolled so the leading blanks it drops can
+    // be added to the body's line index rather than silently lost.
+    const rest = lines.slice(first + 1).map((line) => line.replace(/\s+$/, ""));
+    let start = 0;
+    while (start < rest.length && rest[start] === "")
+        start++;
+    let end = rest.length;
+    while (end > start && rest[end - 1] === "")
+        end--;
+    const body = rest.slice(start, end).join("\n");
+    return {
+        callout: {
+            type,
+            ...(title ? { title } : {}),
+            body,
+            ...(authoredAs ? { authoredAs } : {}),
+            ...(fold ? { fold } : {}),
+        },
+        bodyLine: first + 1 + start,
+    };
+}
+/**
+ * Write a callout back out. The inverse of `parseCallout` on the canonical
+ * form, and the only place the serialized shape is spelled: one blockquote,
+ * marker line first, body quoted line by line. A blank body line is a bare
+ * `>` — no trailing space, so the bytes survive editors that strip them.
+ *
+ * The marker line is rebuilt from the three fields that spell it — type,
+ * authored word, fold — rather than kept as a string, so a callout the editor
+ * constructed by hand and one parsed off disk are written by the same code.
+ */
+export function calloutToMarkdown(callout) {
+    const title = callout.title?.trim();
+    const marker = calloutMarker(callout.type, {
+        authoredAs: callout.authoredAs,
+        fold: callout.fold,
+    });
+    const head = title ? `> ${marker} ${title}` : `> ${marker}`;
+    const body = trimBlankEdges(callout.body.split("\n"));
+    if (body.length === 0)
+        return head;
+    return [head, ...body.map((line) => (line === "" ? ">" : `> ${line}`))].join("\n");
+}
+function trimBlankEdges(lines) {
+    const out = lines.map((line) => line.replace(/\s+$/, ""));
+    while (out.length > 0 && out[0] === "")
+        out.shift();
+    while (out.length > 0 && out[out.length - 1] === "")
+        out.pop();
+    return out;
+}

package/dist/format/cardMarkdown.d.ts

@@ -14,6 +14,8 @@ export interface MarkdownCardInput {
     labels?: string[];
     kind?: "question";
     resolution?: string;
+    scope?: "out";
+    blockedBy?: number[];
 }
 export interface MarkdownBoardRef {
     _id: string;

package/dist/format/cardMarkdown.js

@@ -1,3 +1,5 @@
+// GENERATED by scripts/sync-format.mjs from packages/markdown/src — DO NOT EDIT.
+// Edit packages/markdown/src and re-run the sync (any sfora-cli build does it).
 // Pure markdown <-> kanban card serialization for the agent FS API (/v1/fs).
 //
 // Mirrors postMarkdown.ts: frontmatter/YAML, mentions, slugs, dates, and the
@@ -68,9 +70,17 @@ export function cardToMarkdown(card, board, column, commentsCount) {
         ["kind", card.kind], // undefined for ordinary tasks → skipped
         ["status", card.status],
         ["resolution", card.resolution], // set once a question is decided
+        ["scope", card.scope], // "out" for a question ruled out of scope
         ["priority", card.priority ?? "none"],
         ["assignees", card.assignees ?? []],
         ["labels", card.labels ?? []],
+        // Emitted only when edges exist — key absent means "no blockers".
+        [
+            "blocked-by",
+            card.blockedBy && card.blockedBy.length > 0
+                ? card.blockedBy.map(String)
+                : undefined,
+        ],
         ["due", toDateOnly(card.dueAt)],
         ["created", toISO(card._creationTime)],
         ["lastActivityAt", toISO(card.lastActivityAt)],

package/dist/format/checklist.d.ts

@@ -0,0 +1,34 @@
+export declare const CHECKBOX_RE: RegExp;
+/** One checkbox, as both the scan and the reader see it. */
+export interface ChecklistItem {
+    /** 0-based line index in the body. The reader's join key. */
+    line: number;
+    /** 0-based position in document order — the index `toggleChecklistItem` takes. */
+    index: number;
+    checked: boolean;
+    /** The item's text, markup intact. */
+    text: string;
+}
+export interface ChecklistProgress {
+    done: number;
+    total: number;
+}
+/**
+ * Every checkbox in a body, in document order.
+ *
+ * Non-rendering bytes are skipped: a `- [ ]` inside a ``` block, an inline
+ * code span or an HTML comment is a sample, not a task, and counting it is how
+ * a click on the first real checkbox ends up rewriting a line inside someone's
+ * code. That judgement comes from `lineGeometry`'s shared mask — the same one
+ * lint and the block parsers read — so nothing here decides on its own what
+ * renders. A fence inside a blockquote or a callout counts too, since a quoted
+ * `- [ ]` is otherwise a task.
+ *
+ * Indented code is skipped the only way a line scan can tell: four spaces of
+ * indent with no enclosing list item above it is a code block, whereas the
+ * same indent under a bullet is a nested list. Bodies carry no frontmatter —
+ * callers hand us a body, same as the reader — so the fence scan starts at 0.
+ */
+export declare function scanChecklist(body: string | undefined | null): ChecklistItem[];
+export declare function checklistProgress(body: string | undefined | null): ChecklistProgress;
+export declare function toggleChecklistItem(body: string, index: number): string;

package/dist/format/checklist.js

@@ -0,0 +1,158 @@
+// GENERATED by scripts/sync-format.mjs from packages/markdown/src — DO NOT EDIT.
+// Edit packages/markdown/src and re-run the sync (any sfora-cli build does it).
+// Checklist items are plain markdown checkboxes — `- [ ]` / `- [x]` — in an
+// entity body. There is no separate sub-task entity: the body IS the list, so
+// progress and toggling are string operations over it.
+//
+// ONE scan answers all three questions — which lines are checkboxes, how many
+// are done, and which line index N addresses. The reader (src/lib/utils/
+// markdown.ts) walks the mdast tree instead, and joins back to this scan BY
+// LINE, so a rendered checkbox and the line a toggle rewrites are the same
+// line by construction rather than by two counters agreeing.
+//
+// Pure: no React, no Convex, no Node. The web app re-exports this from
+// src/lib/subtasks.ts; the mobile preprocessor keeps its own copy because
+// packages/mobile installs outside the pnpm workspace.
+import { lineText, maskNonRenderingLines } from "./lineGeometry.js";
+/** The blockquote markers opening a line — `>` runs, callout syntax included. */
+const QUOTE_PREFIX_RE = /^(?:[ \t]{0,3}>[ \t]?)*/;
+/**
+ * Non-rendering lines that only a blockquote-relative scan can see.
+ *
+ * The mask reads the raw lines, where `> ```` ``` ```` is not a fence open at
+ * all, so a sample checkbox inside a quoted or callout fence would count as a
+ * task. Quote markers therefore come off before the scan — but only within a
+ * contiguous run of lines at the SAME quote depth, because a blockquote is its
+ * own container: an unclosed fence inside one ends with the quote and must not
+ * swallow the real checkboxes that follow it at top level.
+ *
+ * It is the whole mask that runs on the stripped lines, not just the fence
+ * half, and it cuts both ways: a `<code>` left open inside a blockquote hides
+ * the checkbox below it even where the raw scan sees the line plainly, and a
+ * ``` inside a quoted comment is comment text rather than a fence, so the task
+ * after the `-->` survives. Both are pinned in checklist.test.ts.
+ *
+ * Depth 0 is left to the caller's raw mask, which already reads those lines
+ * with their `>`-looking content intact.
+ */
+function quotedNonRenderingMask(lines) {
+    const mask = new Array(lines.length).fill(false);
+    const depths = lines.map((_, i) => (lineText(lines, i).match(QUOTE_PREFIX_RE)[0].match(/>/g) ?? []).length);
+    for (let start = 0; start < lines.length; start++) {
+        const depth = depths[start];
+        if (depth === 0)
+            continue;
+        let end = start;
+        while (end + 1 < lines.length && depths[end + 1] === depth)
+            end++;
+        const stripped = [];
+        for (let i = start; i <= end; i++) {
+            stripped.push(lineText(lines, i).replace(QUOTE_PREFIX_RE, ""));
+        }
+        const quoted = maskNonRenderingLines(stripped);
+        for (let i = 0; i < quoted.length; i++) {
+            if (quoted[i].trim() === "")
+                mask[start + i] = true;
+        }
+        start = end;
+    }
+    return mask;
+}
+// A checkbox line: optional blockquote markers, then a bullet (`-`/`*`/`+`) or
+// an ordered marker (`1.`/`1)`), then the state box. Every one of these forms
+// is a task item to GFM, so every one of them is addressable here — a reader
+// that renders `1. [ ] ship` interactive and a toggler whose regex cannot see
+// it is the divergence this grammar exists to close.
+//
+// Captures the prefix, the state character, the gap, and the item text, so a
+// toggle rebuilds the line byte for byte apart from the box it flipped.
+export const CHECKBOX_RE = /^((?:[ \t]{0,3}>[ \t]?)*[ \t]*(?:[-*+]|\d{1,9}[.)])[ \t]+)\[([ xX])\]([ \t]+)(.*)$/;
+// The same opening, without the box — any list item at all. Establishes the
+// list context that tells an indented nested checkbox from indented code.
+const BULLET_RE = /^(?:[ \t]{0,3}>[ \t]?)*([ \t]*)(?:[-*+]|\d{1,9}[.)])[ \t]+/;
+/** Indentation of a line's content, blockquote markers not counted. */
+const INDENT_RE = /^(?:[ \t]{0,3}>[ \t]?)*([ \t]*)/;
+/**
+ * Every checkbox in a body, in document order.
+ *
+ * Non-rendering bytes are skipped: a `- [ ]` inside a ``` block, an inline
+ * code span or an HTML comment is a sample, not a task, and counting it is how
+ * a click on the first real checkbox ends up rewriting a line inside someone's
+ * code. That judgement comes from `lineGeometry`'s shared mask — the same one
+ * lint and the block parsers read — so nothing here decides on its own what
+ * renders. A fence inside a blockquote or a callout counts too, since a quoted
+ * `- [ ]` is otherwise a task.
+ *
+ * Indented code is skipped the only way a line scan can tell: four spaces of
+ * indent with no enclosing list item above it is a code block, whereas the
+ * same indent under a bullet is a nested list. Bodies carry no frontmatter —
+ * callers hand us a body, same as the reader — so the fence scan starts at 0.
+ */
+export function scanChecklist(body) {
+    if (!body)
+        return [];
+    const lines = body.split("\n");
+    const masked = maskNonRenderingLines(lines);
+    const quoted = quotedNonRenderingMask(lines);
+    const out = [];
+    // Indent of the innermost list item still open above the cursor, or null
+    // when we are at top level. A non-blank unindented line that is not itself a
+    // list item closes the list.
+    let openIndent = null;
+    for (let i = 0; i < lines.length; i++) {
+        if (quoted[i])
+            continue;
+        // Structure is read off the MASKED line, so a fenced, commented-out or
+        // code-spanned checkbox is not a list item and not a task; the item's own
+        // text still comes off the raw line, markup intact.
+        const line = lineText(masked, i);
+        if (line.trim() === "")
+            continue;
+        const bullet = BULLET_RE.exec(line);
+        if (!bullet) {
+            if (INDENT_RE.exec(line)[1].length === 0)
+                openIndent = null;
+            continue;
+        }
+        const indent = bullet[1].length;
+        if (indent >= 4 && (openIndent === null || openIndent >= indent))
+            continue;
+        openIndent = indent;
+        const raw = lineText(lines, i);
+        const box = CHECKBOX_RE.exec(raw);
+        // The box has to be one of the bytes that render, and it has to be the
+        // box the grammar found. Both halves are reachable on one line: with a
+        // comment carried down from above, `- [ ] a --> - [ ] b` renders a
+        // checkbox, but not the one CHECKBOX_RE anchored at the head of the line,
+        // and that is the one a toggle would rewrite. No addressable box, no item.
+        if (!box || line[box[1].length] !== "[")
+            continue;
+        out.push({
+            line: i,
+            index: out.length,
+            checked: box[2] !== " ",
+            text: box[4],
+        });
+    }
+    return out;
+}
+// Count checkbox items in a body. total === 0 means "no checklist".
+export function checklistProgress(body) {
+    const items = scanChecklist(body);
+    return { done: items.filter((item) => item.checked).length, total: items.length };
+}
+// Toggle the Nth checkbox (0-based, in document order) and return the new body.
+// Returns the original body unchanged if the index is out of range.
+export function toggleChecklistItem(body, index) {
+    const item = scanChecklist(body)[index];
+    if (!item)
+        return body;
+    const lines = body.split("\n");
+    const raw = lines[item.line];
+    const eol = raw.endsWith("\r") ? "\r" : "";
+    const m = CHECKBOX_RE.exec(eol ? raw.slice(0, -1) : raw);
+    if (!m)
+        return body;
+    lines[item.line] = `${m[1]}[${item.checked ? " " : "x"}]${m[3]}${m[4]}${eol}`;
+    return lines.join("\n");
+}