@nijaru/tk 0.0.5 → 0.1.3

package/src/lib/format.test.ts

@@ -1,433 +0,0 @@
-import { test, expect, describe, afterEach } from "bun:test";
-import {
-  shouldUseColor,
-  formatTaskRow,
-  formatTaskList,
-  formatTaskDetail,
-  formatJson,
-} from "./format";
-import type { TaskWithMeta, LogEntry } from "../types";
-
-describe("shouldUseColor", () => {
-  const originalEnv = process.env.NO_COLOR;
-
-  afterEach(() => {
-    if (originalEnv === undefined) {
-      delete process.env.NO_COLOR;
-    } else {
-      process.env.NO_COLOR = originalEnv;
-    }
-  });
-
-  test("returns false when NO_COLOR is set (non-empty)", () => {
-    process.env.NO_COLOR = "1";
-    expect(shouldUseColor()).toBe(false);
-  });
-
-  test("returns false when NO_COLOR is set to any value", () => {
-    process.env.NO_COLOR = "true";
-    expect(shouldUseColor()).toBe(false);
-    process.env.NO_COLOR = "yes";
-    expect(shouldUseColor()).toBe(false);
-  });
-
-  test("respects NO_COLOR empty string as color enabled", () => {
-    process.env.NO_COLOR = "";
-    // NO_COLOR="" is treated as unset — color depends on TTY (always false in tests)
-    expect(shouldUseColor()).toBe(false);
-  });
-});
-
-describe("formatTaskRow", () => {
-  const task: TaskWithMeta = {
-    id: "tk-a1b2",
-    project: "tk",
-    ref: "a1b2",
-    title: "Test task",
-    description: null,
-    priority: 1,
-    status: "open",
-    labels: [],
-    assignees: [],
-    parent: null,
-    blocked_by: [],
-    estimate: null,
-    due_date: null,
-    logs: [],
-    created_at: new Date().toISOString(),
-    updated_at: new Date().toISOString(),
-    completed_at: null,
-    external: {},
-    blocked_by_incomplete: false,
-    is_overdue: false,
-    days_until_due: null,
-  };
-
-  test("formats task without color", () => {
-    const result = formatTaskRow(task, false);
-    expect(result).toContain("tk-a1b2");
-    expect(result).toContain("p1");
-    expect(result).toContain("open");
-    expect(result).toContain("Test task");
-    expect(result).not.toContain("\x1b[");
-  });
-
-  test("formats task with color", () => {
-    const result = formatTaskRow(task, true);
-    expect(result).toContain("tk-a1b2");
-    expect(result).toContain("\x1b[");
-  });
-
-  test("truncates long titles to 50 chars", () => {
-    const longTask: TaskWithMeta = {
-      ...task,
-      title: "A".repeat(100),
-    };
-    const result = formatTaskRow(longTask, false);
-    expect(result.split("A").length - 1).toBeLessThanOrEqual(50);
-  });
-
-  test("includes column dividers", () => {
-    const result = formatTaskRow(task, false);
-    expect(result).toContain(" | ");
-    const parts = result.split(" | ");
-    expect(parts.length).toBe(4); // ID | PRIO | STATUS | TITLE
-  });
-
-  test("truncates long project names with ellipsis", () => {
-    const longProjectTask: TaskWithMeta = {
-      ...task,
-      id: "mylongproject-a1b2",
-    };
-    const result = formatTaskRow(longProjectTask, false);
-    expect(result).toContain("mylon…-a1b2");
-    expect(result).not.toContain("mylongproject");
-  });
-
-  test("keeps short project names intact", () => {
-    const result = formatTaskRow(task, false);
-    expect(result).toContain("tk-a1b2");
-  });
-
-  test("shows overdue marker for overdue tasks", () => {
-    const overdueTask: TaskWithMeta = {
-      ...task,
-      due_date: "2020-01-01",
-      is_overdue: true,
-    };
-    const result = formatTaskRow(overdueTask, false);
-    expect(result).toContain("[OVERDUE]");
-  });
-
-  test("does NOT show overdue marker for tasks due today", () => {
-    const today = new Date().toISOString().split("T")[0] ?? null;
-    const todayTask: TaskWithMeta = {
-      ...task,
-      due_date: today,
-      is_overdue: false,
-    };
-    const result = formatTaskRow(todayTask, false);
-    expect(result).not.toContain("[OVERDUE]");
-  });
-
-  test("shows [due today] for tasks due today", () => {
-    const today = new Date().toISOString().split("T")[0] ?? null;
-    const todayTask: TaskWithMeta = {
-      ...task,
-      due_date: today,
-      is_overdue: false,
-      days_until_due: 0,
-    };
-    const result = formatTaskRow(todayTask, false);
-    expect(result).toContain("[due today]");
-    expect(result).not.toContain("[OVERDUE]");
-  });
-
-  test("shows [due Nd] for tasks due in N days within threshold", () => {
-    const future = new Date();
-    future.setDate(future.getDate() + 3);
-    const dateStr = future.toISOString().split("T")[0] ?? null;
-    const soonTask: TaskWithMeta = {
-      ...task,
-      due_date: dateStr,
-      is_overdue: false,
-      days_until_due: 3,
-    };
-    const result = formatTaskRow(soonTask, false);
-    expect(result).toContain("[due 3d]");
-  });
-
-  test("shows no due-soon marker at 8 days", () => {
-    const future = new Date();
-    future.setDate(future.getDate() + 8);
-    const dateStr = future.toISOString().split("T")[0] ?? null;
-    const notSoonTask: TaskWithMeta = {
-      ...task,
-      due_date: dateStr,
-      is_overdue: false,
-      days_until_due: 8,
-    };
-    const result = formatTaskRow(notSoonTask, false);
-    expect(result).not.toContain("[due");
-    expect(result).not.toContain("[OVERDUE]");
-  });
-
-  test("shows no due-soon marker when overdue", () => {
-    const overdueWithSoon: TaskWithMeta = {
-      ...task,
-      due_date: "2020-01-01",
-      is_overdue: true,
-      days_until_due: null,
-    };
-    const result = formatTaskRow(overdueWithSoon, false);
-    expect(result).toContain("[OVERDUE]");
-    expect(result).not.toContain("[due today]");
-    expect(result).not.toContain("[due ");
-  });
-
-  test("shows no due-soon marker for done tasks", () => {
-    const doneTask: TaskWithMeta = {
-      ...task,
-      status: "done",
-      days_until_due: null,
-      completed_at: new Date().toISOString(),
-    };
-    const result = formatTaskRow(doneTask, false);
-    expect(result).not.toContain("[due");
-  });
-});
-
-describe("formatTaskList", () => {
-  test("returns helpful message for empty list", () => {
-    expect(formatTaskList([])).toBe("No tasks found. Run 'tk add \"title\"' to create one.");
-  });
-
-  test("allows custom empty hint", () => {
-    expect(formatTaskList([], undefined, "Custom hint")).toBe("Custom hint");
-  });
-
-  test("includes header and divider", () => {
-    const tasks: TaskWithMeta[] = [
-      {
-        id: "tk-a1b2",
-        project: "tk",
-        ref: "a1b2",
-        title: "Test",
-        description: null,
-        priority: 3,
-        status: "open",
-        labels: [],
-        assignees: [],
-        parent: null,
-        blocked_by: [],
-        estimate: null,
-        due_date: null,
-        logs: [],
-        created_at: new Date().toISOString(),
-        updated_at: new Date().toISOString(),
-        completed_at: null,
-        external: {},
-        blocked_by_incomplete: false,
-        is_overdue: false,
-        days_until_due: null,
-      },
-    ];
-    const result = formatTaskList(tasks, false);
-    expect(result).toContain("ID");
-    expect(result).toContain("PRI");
-    expect(result).toContain("STATUS");
-    expect(result).toContain("TITLE");
-    expect(result).toContain("----");
-  });
-
-  test("formats multiple tasks", () => {
-    const tasks: TaskWithMeta[] = [
-      {
-        id: "tk-a1b2",
-        project: "tk",
-        ref: "a1b2",
-        title: "First",
-        description: null,
-        priority: 1,
-        status: "open",
-        labels: [],
-        assignees: [],
-        parent: null,
-        blocked_by: [],
-        estimate: null,
-        due_date: null,
-        logs: [],
-        created_at: new Date().toISOString(),
-        updated_at: new Date().toISOString(),
-        completed_at: null,
-        external: {},
-        blocked_by_incomplete: false,
-        is_overdue: false,
-        days_until_due: null,
-      },
-      {
-        id: "tk-c3d4",
-        project: "tk",
-        ref: "c3d4",
-        title: "Second",
-        description: null,
-        priority: 3,
-        status: "active",
-        labels: [],
-        assignees: [],
-        parent: null,
-        blocked_by: [],
-        estimate: null,
-        due_date: null,
-        logs: [],
-        created_at: new Date().toISOString(),
-        updated_at: new Date().toISOString(),
-        completed_at: null,
-        external: {},
-        blocked_by_incomplete: false,
-        is_overdue: false,
-        days_until_due: null,
-      },
-    ];
-    const result = formatTaskList(tasks, false);
-    expect(result).toContain("tk-a1b2");
-    expect(result).toContain("tk-c3d4");
-    expect(result).toContain("First");
-    expect(result).toContain("Second");
-  });
-});
-
-describe("formatTaskDetail", () => {
-  const task: TaskWithMeta = {
-    id: "tk-a1b2",
-    project: "tk",
-    ref: "a1b2",
-    title: "Test task",
-    description: "A description",
-    priority: 1,
-    status: "open",
-    labels: ["bug", "urgent"],
-    assignees: ["nick"],
-    parent: null,
-    blocked_by: ["tk-c3d4"],
-    estimate: 3,
-    due_date: "2026-01-15",
-    logs: [],
-    created_at: "2024-01-01T00:00:00.000Z",
-    updated_at: "2024-01-01T00:00:00.000Z",
-    completed_at: null,
-    external: {},
-    blocked_by_incomplete: true,
-    is_overdue: false,
-    days_until_due: null,
-  };
-
-  test("includes all task fields", () => {
-    const result = formatTaskDetail(task, [], false);
-    expect(result).toContain("ID:");
-    expect(result).toContain("tk-a1b2");
-    expect(result).toContain("Title:");
-    expect(result).toContain("Test task");
-    expect(result).toContain("Status:");
-    expect(result).toContain("open");
-    expect(result).toContain("Priority:");
-    expect(result).toContain("p1");
-    expect(result).toContain("Description:");
-    expect(result).toContain("A description");
-  });
-
-  test("shows labels", () => {
-    const result = formatTaskDetail(task, [], false);
-    expect(result).toContain("Labels:");
-    expect(result).toContain("bug, urgent");
-  });
-
-  test("shows assignees", () => {
-    const result = formatTaskDetail(task, [], false);
-    expect(result).toContain("Assignees:");
-    expect(result).toContain("nick");
-  });
-
-  test("shows estimate", () => {
-    const result = formatTaskDetail(task, [], false);
-    expect(result).toContain("Estimate:");
-    expect(result).toContain("3");
-  });
-
-  test("shows due date", () => {
-    const result = formatTaskDetail(task, [], false);
-    expect(result).toContain("Due:");
-    expect(result).toContain("2026-01-15");
-  });
-
-  test("shows blockers with status", () => {
-    const result = formatTaskDetail(task, [], false);
-    expect(result).toContain("Blockers:");
-    expect(result).toContain("tk-c3d4");
-    expect(result).toContain("(blocked)");
-  });
-
-  test("shows resolved blockers", () => {
-    const resolvedTask: TaskWithMeta = {
-      ...task,
-      blocked_by_incomplete: false,
-    };
-    const result = formatTaskDetail(resolvedTask, [], false);
-    expect(result).toContain("(resolved)");
-  });
-
-  test("shows overdue indicator", () => {
-    const overdueTask: TaskWithMeta = {
-      ...task,
-      is_overdue: true,
-    };
-    const result = formatTaskDetail(overdueTask, [], false);
-    expect(result).toContain("[OVERDUE]");
-  });
-
-  test("includes log entries", () => {
-    const logs: LogEntry[] = [
-      { ts: "2024-01-01T00:00:00.000Z", msg: "Started work" },
-      { ts: "2024-01-02T00:00:00.000Z", msg: "Made progress" },
-    ];
-    const result = formatTaskDetail(task, logs, false);
-    expect(result).toContain("Log:");
-    expect(result).toContain("Started work");
-    expect(result).toContain("Made progress");
-  });
-
-  test("shows completed_at for done tasks", () => {
-    const doneTask: TaskWithMeta = {
-      ...task,
-      status: "done",
-      completed_at: "2024-01-02T00:00:00.000Z",
-    };
-    const result = formatTaskDetail(doneTask, [], false);
-    expect(result).toContain("Completed:");
-  });
-});
-
-describe("formatJson", () => {
-  test("formats objects as pretty JSON", () => {
-    const data = { foo: "bar", num: 42 };
-    const result = formatJson(data);
-    expect(result).toBe('{\n  "foo": "bar",\n  "num": 42\n}');
-  });
-
-  test("formats arrays", () => {
-    const data = [1, 2, 3];
-    const result = formatJson(data);
-    expect(result).toBe("[\n  1,\n  2,\n  3\n]");
-  });
-
-  test("handles null", () => {
-    expect(formatJson(null)).toBe("null");
-  });
-
-  test("handles nested objects", () => {
-    const data = { nested: { value: true } };
-    const result = formatJson(data);
-    expect(result).toContain('"nested"');
-    expect(result).toContain('"value"');
-  });
-});

package/src/lib/format.ts

@@ -1,189 +0,0 @@
-import type { TaskWithMeta, LogEntry } from "../types";
-import { PRIORITY_COLORS, STATUS_COLORS, OVERDUE_COLOR, RESET } from "../types";
-import { formatPriority } from "./priority";
-import { formatDate, formatRelativeTime, DUE_SOON_THRESHOLD } from "./time";
-
-const DUE_SOON_COLOR = "\x1b[33m"; // yellow
-
-// Message colors
-const GREEN = "\x1b[32m";
-const RED = "\x1b[31m";
-const YELLOW = "\x1b[33m";
-const DIM = "\x1b[2m";
-
-/**
- * Determines if color output should be used for the given stream.
- * Respects NO_COLOR env var (https://no-color.org/) and TTY detection.
- */
-export function shouldUseColor(stream: NodeJS.WriteStream = process.stdout): boolean {
-  if (process.env.NO_COLOR !== undefined && process.env.NO_COLOR !== "") {
-    return false;
-  }
-  return stream.isTTY ?? false;
-}
-
-/** Format text green (success) */
-export function green(msg: string): string {
-  return shouldUseColor() ? `${GREEN}${msg}${RESET}` : msg;
-}
-
-/** Format text red (error) — checks stderr since errors are written there */
-export function red(msg: string): string {
-  return shouldUseColor(process.stderr) ? `${RED}${msg}${RESET}` : msg;
-}
-
-/** Format text yellow (warning) */
-export function yellow(msg: string): string {
-  return shouldUseColor() ? `${YELLOW}${msg}${RESET}` : msg;
-}
-
-/** Format text dim/muted */
-export function dim(msg: string): string {
-  return shouldUseColor() ? `${DIM}${msg}${RESET}` : msg;
-}
-
-function truncate(text: string, maxLen: number): string {
-  return text.length <= maxLen ? text : text.slice(0, maxLen - 1) + "…";
-}
-
-function formatId(id: string, maxLen = 11): string {
-  // Truncate project prefix to fit maxLen, keep full 4-char ref
-  // "myproject-a1b2" -> "mypr…-a1b2"
-  const dash = id.lastIndexOf("-");
-  if (dash === -1) return truncate(id, maxLen);
-  const project = id.slice(0, dash);
-  const ref = id.slice(dash + 1);
-  const maxProjectLen = maxLen - ref.length - 1; // -1 for dash
-  return project.length > maxProjectLen
-    ? `${truncate(project, maxProjectLen)}-${ref}`
-    : `${project}-${ref}`;
-}
-
-export function formatTaskRow(task: TaskWithMeta, useColor?: boolean): string {
-  const color = useColor ?? shouldUseColor();
-  const id = formatId(task.id).padEnd(11);
-  const priority = formatPriority(task.priority).padEnd(4);
-  const isOverdue = task.is_overdue;
-  const dueSoon =
-    !isOverdue && task.days_until_due !== null && task.days_until_due <= DUE_SOON_THRESHOLD;
-
-  let statusText: string = task.status;
-  if (task.status === "done" && task.completed_at) {
-    statusText = `done ${formatRelativeTime(task.completed_at)}`;
-  }
-  const status = statusText.padEnd(12);
-
-  if (color) {
-    const pc = PRIORITY_COLORS[task.priority];
-    const sc = isOverdue ? OVERDUE_COLOR : dueSoon ? DUE_SOON_COLOR : STATUS_COLORS[task.status];
-    const tc = task.status === "done" ? DIM : "";
-    const title = truncate(task.title, 50);
-    return `${id} | ${pc}${priority}${RESET} | ${sc}${status}${RESET} | ${tc}${title}${RESET}`;
-  }
-
-  let dueSoonMarker = "";
-  if (dueSoon) {
-    dueSoonMarker = task.days_until_due === 0 ? " [due today]" : ` [due ${task.days_until_due}d]`;
-  }
-  const overdueMarker = isOverdue ? " [OVERDUE]" : "";
-  const title = truncate(task.title, 50);
-  return `${id} | ${priority} | ${status} | ${title}${overdueMarker}${dueSoonMarker}`;
-}
-
-export function formatTaskList(
-  tasks: TaskWithMeta[],
-  useColor?: boolean,
-  emptyHint?: string,
-): string {
-  if (tasks.length === 0) {
-    return emptyHint ?? "No tasks found. Run 'tk add \"title\"' to create one.";
-  }
-  const color = useColor ?? shouldUseColor();
-
-  const header = "ID          | PRIO | STATUS       | TITLE";
-  const divider = "-".repeat(65);
-  const rows = tasks.map((t) => formatTaskRow(t, color));
-
-  return [header, divider, ...rows].join("\n");
-}
-
-export function formatTaskDetail(task: TaskWithMeta, logs: LogEntry[], useColor?: boolean): string {
-  const color = useColor ?? shouldUseColor();
-  const lines: string[] = [];
-
-  const sc = color ? STATUS_COLORS[task.status] : "";
-  const pc = color ? PRIORITY_COLORS[task.priority] : "";
-  const oc = color ? OVERDUE_COLOR : "";
-  const r = color ? RESET : "";
-
-  lines.push(`ID:          ${task.id}`);
-  lines.push(`Title:       ${task.title}`);
-  lines.push(`Status:      ${sc}${task.status}${r}`);
-  lines.push(`Priority:    ${pc}${formatPriority(task.priority)}${r}`);
-
-  if (task.description) {
-    lines.push(`Description: ${task.description}`);
-  }
-
-  if (task.labels.length > 0) {
-    lines.push(`Labels:      ${task.labels.join(", ")}`);
-  }
-
-  if (task.assignees.length > 0) {
-    lines.push(`Assignees:   ${task.assignees.join(", ")}`);
-  }
-
-  if (task.parent) {
-    lines.push(`Parent:      ${task.parent}`);
-  }
-
-  if (task.estimate !== null) {
-    lines.push(`Estimate:    ${task.estimate}`);
-  }
-
-  if (task.due_date) {
-    const yc = color ? DUE_SOON_COLOR : "";
-    const dueSoon =
-      !task.is_overdue && task.days_until_due !== null && task.days_until_due <= DUE_SOON_THRESHOLD;
-    let dueSoonStr = "";
-    if (dueSoon) {
-      const marker = task.days_until_due === 0 ? "[due today]" : `[due ${task.days_until_due}d]`;
-      dueSoonStr = ` ${yc}${marker}${r}`;
-    }
-    const overdueStr = task.is_overdue ? ` ${oc}[OVERDUE]${r}` : "";
-    lines.push(`Due:         ${task.due_date}${overdueStr}${dueSoonStr}`);
-  }
-
-  lines.push(`Created:     ${formatDate(task.created_at)}`);
-  lines.push(`Updated:     ${formatDate(task.updated_at)}`);
-
-  if (task.completed_at) {
-    lines.push(`Completed:   ${formatDate(task.completed_at)}`);
-  }
-
-  if (task.blocked_by.length > 0) {
-    const blockStatus = task.blocked_by_incomplete ? " (blocked)" : " (resolved)";
-    lines.push(`Blockers:    ${task.blocked_by.join(", ")}${blockStatus}`);
-  }
-
-  if (logs.length > 0) {
-    lines.push("");
-    lines.push("Log:");
-    for (const entry of logs) {
-      lines.push(`  [${formatDate(entry.ts)}] ${entry.msg}`);
-    }
-  }
-
-  return lines.join("\n");
-}
-
-export function formatJson(data: unknown): string {
-  return JSON.stringify(data, null, 2);
-}
-
-export function formatConfig(config: { version: number; project: string }): string {
-  const lines: string[] = [];
-  lines.push(`Version:  ${config.version}`);
-  lines.push(`Project:  ${config.project}`);
-  return lines.join("\n");
-}