@nickmeriano/task 0.5.0 → 0.6.0

package/dist/file-store.d.ts

@@ -0,0 +1,113 @@
+import { type Store } from "./store.ts";
+import type { Comment, ProjectConfig, Task, TaskFilter, TaskInput, TaskPatch } from "./types.ts";
+export declare const TICKETS_DIR = "tickets";
+/** Finished tickets moved out of the hot path — same per-ticket layout. */
+export declare const ARCHIVE_DIR = "archive";
+/**
+ * The canonical persistence layer: one directory per ticket under
+ * `.task/tickets/`, holding a frontmatter+markdown `ticket.md` and one file
+ * per comment. Everything is plain text committed to git, which is the point —
+ * ticket edits diff, review, and merge like code, and two branches touching
+ * different tickets (or adding comments to the same one) merge cleanly by
+ * construction.
+ *
+ * There is no database and no cache: boards are dozens of tickets, and
+ * re-reading a handful of small files per operation is cheaper than opening
+ * SQLite ever was. If boards outgrow that, a derived (gitignored) index can be
+ * added without changing the format — the files stay the source of truth.
+ */
+export declare class FileStore implements Store {
+    readonly root: string;
+    readonly taskDir: string;
+    readonly config: ProjectConfig;
+    private ticketsDir;
+    private archiveDir;
+    constructor(root: string);
+    close(): void;
+    displayId(number: number): string;
+    /** Accepts "PHONE-12", "phone-12" or "12". */
+    parseId(ref: string): number;
+    private ticketPath;
+    /**
+     * A ticket's comments live wherever the ticket does — the whole directory
+     * moves on archive, so an archived ticket's discussion stays readable.
+     */
+    private commentsPath;
+    private readDir;
+    /** Every live ticket on the board, freshly parsed — the files are the state. */
+    private readAll;
+    private readOne;
+    /** Cheap presence check — the archive's numbers, without parsing anything. */
+    private archivedNumbers;
+    private isArchived;
+    /** The error every write path throws instead of touching the archive. */
+    private assertNotArchived;
+    private writeTicket;
+    /**
+     * Only `blocked_by` is stored (on the blocked ticket); the `blocks` side is
+     * derived here, so the two views can never disagree.
+     */
+    private toTask;
+    private applyFilter;
+    list(filter?: TaskFilter): Task[];
+    get(number: number): Task | null;
+    create(input: TaskInput): Task;
+    update(number: number, patch: TaskPatch): Task;
+    /**
+     * Make every other ticket's `blocked_by` agree with "this task blocks
+     * exactly `targets`". Returns whether anything changed; every touched ticket
+     * (and, via the caller, this one) gets its `updated` bumped.
+     */
+    private reconcileBlocks;
+    /** `task link A --blocks B` and friends — additive, unlike the patch form. */
+    link(number: number, relation: "blocks" | "blocked_by", target: number): Task;
+    unlink(number: number, relation: "blocks" | "blocked_by", target: number): Task;
+    delete(number: number): void;
+    /**
+     * Move a finished ticket's whole directory to `.task/archive/` — one rename,
+     * which git records as a move, so history follows the ticket. Archived
+     * tickets leave every hot path (`list`, the board, link derivation) but stay
+     * readable via `get`/`comments` and keep their number reserved forever.
+     * Links other tickets hold on this one are left in place: they're
+     * dangling-tolerant everywhere, and unarchiving puts them back in force.
+     */
+    archive(number: number): Task;
+    unarchive(number: number): Task;
+    /**
+     * One file per comment, append-only: two writers commenting concurrently on
+     * the same ticket produce two files and merge without a conflict — which is
+     * why they aren't lines inside `ticket.md`.
+     */
+    comments(number: number): Comment[];
+    addComment(number: number, body: string, author?: string): Comment;
+    deleteComment(number: number, commentId: string): Comment;
+    commentCounts(): Map<number, number>;
+}
+/**
+ * The board in `root`, on whichever backend it uses: text files when the
+ * `tickets/` tree exists or the config says version ≥ 2, the legacy SQLite
+ * store otherwise. Old boards keep working untouched until `task migrate`.
+ */
+export declare function openBoard(root: string): Store;
+export interface InitOptions {
+    name: string;
+    prefix?: string;
+}
+/**
+ * Create `.task/` in `root`: config and a .gitignore. New boards are
+ * text-canonical from the start — tickets appear under `tickets/` as they're
+ * created, and everything in `.task/` except the ignores belongs in git.
+ */
+export declare function initProject(root: string, options: InitOptions): Store;
+export interface MigrateResult {
+    tasks: number;
+    comments: number;
+}
+/**
+ * `task migrate` — export every ticket and comment from a legacy `tasks.db`
+ * into the text layout, flip the config to version 2, and gitignore the
+ * database. The database file itself is left on disk untouched, as a backup;
+ * it just stops being the state.
+ */
+export declare function migrateBoard(root: string): MigrateResult;
+//# sourceMappingURL=file-store.d.ts.map

package/dist/file-store.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"file-store.d.ts","sourceRoot":"","sources":["../src/file-store.ts"],"names":[],"mappings":"AAkBA,OAAO,EAOL,KAAK,KAAK,EACX,MAAM,YAAY,CAAA;AACnB,OAAO,KAAK,EACV,OAAO,EACP,aAAa,EAEb,IAAI,EACJ,UAAU,EACV,SAAS,EACT,SAAS,EACV,MAAM,YAAY,CAAA;AAEnB,eAAO,MAAM,WAAW,YAAY,CAAA;AACpC,2EAA2E;AAC3E,eAAO,MAAM,WAAW,YAAY,CAAA;AAuBpC;;;;;;;;;;;;GAYG;AACH,qBAAa,SAAU,YAAW,KAAK;IACrC,QAAQ,CAAC,IAAI,EAAE,MAAM,CAAA;IACrB,QAAQ,CAAC,OAAO,EAAE,MAAM,CAAA;IACxB,QAAQ,CAAC,MAAM,EAAE,aAAa,CAAA;IAC9B,OAAO,CAAC,UAAU,CAAQ;IAC1B,OAAO,CAAC,UAAU,CAAQ;gBAEd,IAAI,EAAE,MAAM;IAUxB,KAAK,IAAI,IAAI;IAEb,SAAS,CAAC,MAAM,EAAE,MAAM,GAAG,MAAM;IAIjC,8CAA8C;IAC9C,OAAO,CAAC,GAAG,EAAE,MAAM,GAAG,MAAM;IAQ5B,OAAO,CAAC,UAAU;IAIlB;;;OAGG;IACH,OAAO,CAAC,YAAY;IAOpB,OAAO,CAAC,OAAO;IAaf,gFAAgF;IAChF,OAAO,CAAC,OAAO;IAIf,OAAO,CAAC,OAAO;IAMf,8EAA8E;IAC9E,OAAO,CAAC,eAAe;IAOvB,OAAO,CAAC,UAAU;IAIlB,yEAAyE;IACzE,OAAO,CAAC,iBAAiB;IAOzB,OAAO,CAAC,WAAW;IAKnB;;;OAGG;IACH,OAAO,CAAC,MAAM;IAsBd,OAAO,CAAC,WAAW;IAkBnB,IAAI,CAAC,MAAM,GAAE,UAAe,GAAG,IAAI,EAAE;IAiBrC,GAAG,CAAC,MAAM,EAAE,MAAM,GAAG,IAAI,GAAG,IAAI;IAahC,MAAM,CAAC,KAAK,EAAE,SAAS,GAAG,IAAI;IAuC9B,MAAM,CAAC,MAAM,EAAE,MAAM,EAAE,KAAK,EAAE,SAAS,GAAG,IAAI;IAgF9C;;;;OAIG;IACH,OAAO,CAAC,eAAe;IAiCvB,8EAA8E;IAC9E,IAAI,CAAC,MAAM,EAAE,MAAM,EAAE,QAAQ,EAAE,QAAQ,GAAG,YAAY,EAAE,MAAM,EAAE,MAAM,GAAG,IAAI;IAW7E,MAAM,CAAC,MAAM,EAAE,MAAM,EAAE,QAAQ,EAAE,QAAQ,GAAG,YAAY,EAAE,MAAM,EAAE,MAAM,GAAG,IAAI;IAS/E,MAAM,CAAC,MAAM,EAAE,MAAM,GAAG,IAAI;IAiB5B;;;;;;;OAOG;IACH,OAAO,CAAC,MAAM,EAAE,MAAM,GAAG,IAAI;IAkB7B,SAAS,CAAC,MAAM,EAAE,MAAM,GAAG,IAAI;IAiB/B;;;;OAIG;IACH,QAAQ,CAAC,MAAM,EAAE,MAAM,GAAG,OAAO,EAAE;IAsBnC,UAAU,CAAC,MAAM,EAAE,MAAM,EAAE,IAAI,EAAE,MAAM,EAAE,MAAM,SAAK,GAAG,OAAO;IAe9D,aAAa,CAAC,MAAM,EAAE,MAAM,EAAE,SAAS,EAAE,MAAM,GAAG,OAAO;IAYzD,aAAa,IAAI,GAAG,CAAC,MAAM,EAAE,MAAM,CAAC;CAYrC;AAcD;;;;GAIG;AACH,wBAAgB,SAAS,CAAC,IAAI,EAAE,MAAM,GAAG,KAAK,CAM7C;AAED,MAAM,WAAW,WAAW;IAC1B,IAAI,EAAE,MAAM,CAAA;IACZ,MAAM,CAAC,EAAE,MAAM,CAAA;CAChB;AAED;;;;GAIG;AACH,wBAAgB,WAAW,CAAC,IAAI,EAAE,MAAM,EAAE,OAAO,EAAE,WAAW,GAAG,KAAK,CAcrE;AAED,MAAM,WAAW,aAAa;IAC5B,KAAK,EAAE,MAAM,CAAA;IACb,QAAQ,EAAE,MAAM,CAAA;CACjB;AAED;;;;;GAKG;AACH,wBAAgB,YAAY,CAAC,IAAI,EAAE,MAAM,GAAG,aAAa,CA+ExD"}