schub 0.1.2 → 0.1.4

package/templates/create-proposal/proposal-template.md

@@ -1,9 +1,11 @@
-# Proposal - {{CHANGE_TITLE}}
+---
+change_id: "{{CHANGE_ID}}"
+created: "{{DATE}}"
+status: Draft
+input: "{{INPUT}}"
+---
 
-**Change ID**: `{{CHANGE_ID}}`
-**Created**: {{DATE}}
-**Status**: Draft
-**Input**: {{INPUT}}
+# Proposal - {{CHANGE_TITLE}}
 
 ## Summary
 
@@ -48,4 +50,4 @@
 
 ## Potential Issues
 
-- [List potential issues, conflicts, discrepancies, risks]
+- [List potential issues, conflicts, discrepancies, risks]

package/templates/create-roadmap/roadmap.md

@@ -0,0 +1,5 @@
+## Roadmap
+
+- **<PROPOSAL_REF>**: **As a** [user type], **I want** [goal], **so that** [value].
+- **<PROPOSAL_REF>**: **As a** [user type], **I want** [goal], **so that** [value].
+- **<PROPOSAL_REF>**: **As a** [user type], **I want** [goal], **so that** [value].

package/templates/create-tasks/task-template.md

@@ -1,9 +1,14 @@
+---
+change_id: "{{CHANGE_ID}}"
+priority: "[P1|P2|P3]"
+depends_on: []
+parallelizable: "[no|yes]"
+blocked_reason: ""
+---
+
 # Task: {{TASK_ID}} {{TASK_TITLE}}
 
-**Change ID**: [`{{CHANGE_ID}}`](../../changes/{{CHANGE_ID}}/proposal.md)  
-**Priority**: P1
-**Depends on**: [optional]  
-**Parallelizable**: [yes/no]
+Note: When a task is blocked, set `blocked_reason` in the frontmatter.
 
 ## Goal
 

package/templates/review-proposal/q&a-template.md

@@ -1,15 +1,20 @@
-# Q&A {{CHANGE_TITLE}}
+---
+change_id: "{{CHANGE_ID}}"
+created: "{{DATE}}"
+---
 
-**Change ID**: `{{CHANGE_ID}}`  
-**Created**: {{DATE}}
+# Q&A {{CHANGE_TITLE}}
 
 ### ❓ <Question 1>
+
 **Answer:** <answer>
 
 ### ❓ <Question 2>
+
 **Answer:** <answer>
 
 ### ❓ <Question 3>
+
 **Answer:** <answer>
 
 #--- TODO: copy into Q&A Template --

package/templates/review-proposal/review-me-template.md

@@ -1,7 +1,9 @@
-# REVIEW_ME: {{CHANGE_TITLE}}
+---
+change_id: "{{CHANGE_ID}}"
+created: "{{DATE}}"
+---
 
-**Change ID**: `{{CHANGE_ID}}`  
-**Created**: {{DATE}}
+# REVIEW_ME: {{CHANGE_TITLE}}
 
 **Purpose**: Open questions to review requirements with the user.
 
@@ -15,4 +17,4 @@
 - Check items off as completed: `[x]`
 - Add comments or findings inline
 - Link to relevant resources or documentation
-- Items are numbered sequentially for easy reference
+- Items are numbered sequentially for easy reference

package/templates/setup-project/project-overview-template.md

@@ -1,3 +1,8 @@
+---
+title: "[Project Name] - Overview"
+project_name: "[Project Name]"
+---
+
 # [Project Name] - Overview
 
 > **Why this project exists**

package/templates/setup-project/project-setup-template.md

@@ -1,3 +1,8 @@
+---
+title: "[Project Name] - Setup"
+project_name: "[Project Name]"
+---
+
 # [Project Name] - Setup
 
 > **How this project is organized**

package/templates/setup-project/project-wow-template.md

@@ -1,3 +1,8 @@
+---
+title: "[Project Name] — Ways of Working"
+project_name: "[Project Name]"
+---
+
 # [Project Name] — Ways of Working
 
 > **How to write and verify code here**

package/src/App.test.tsx

@@ -1,93 +0,0 @@
-import { expect, test } from "bun:test";
-import { mkdirSync, mkdtempSync, writeFileSync } from "node:fs";
-import { homedir, tmpdir } from "node:os";
-import { join } from "node:path";
-import { render } from "ink-testing-library";
-import packageJson from "../package.json";
-import App from "./App";
-import { findSchubRoot } from "./features/tasks";
-
-const schubDir = findSchubRoot(process.env.SCHUB_CWD ?? process.cwd())!;
-const homeDir = homedir();
-const displaySchubDir =
-  schubDir === homeDir ? "~" : schubDir.startsWith(`${homeDir}/`) ? `~${schubDir.slice(homeDir.length)}` : schubDir;
-
-const ansiPattern = new RegExp(`${String.fromCharCode(27)}[[0-9;]*m`, "g");
-const stripAnsi = (value: string) => value.replace(ansiPattern, "");
-
-test("renders tabs with header and footer details", () => {
-  const { lastFrame } = render(<App />);
-  const output = stripAnsi(lastFrame() || "");
-  expect(output).toContain("Status");
-  expect(output).toContain("Plan");
-  expect(output).toContain("switch mode");
-  expect(output).toContain("[o open file]");
-  expect(output).toContain("[c copy]");
-  expect(output).toContain(displaySchubDir);
-  expect(output).toContain(packageJson.version);
-});
-
-test("selected tab shows a blue left indicator", () => {
-  const originalForceColor = process.env.FORCE_COLOR;
-  process.env.FORCE_COLOR = "1";
-
-  try {
-    const { lastFrame } = render(<App />);
-    const output = lastFrame() || "";
-    const statusLine = output.split("\n").find((line) => line.includes("Status")) ?? "";
-    expect(statusLine).toContain("Status");
-    expect(statusLine).not.toContain("│");
-  } finally {
-    if (originalForceColor === undefined) {
-      delete process.env.FORCE_COLOR;
-    } else {
-      process.env.FORCE_COLOR = originalForceColor;
-    }
-  }
-});
-
-test("shows a copy banner after copying an item", async () => {
-  const originalCwd = process.cwd();
-  const baseDir = mkdtempSync(join(tmpdir(), "schub-app-copy-"));
-  const readyRoot = join(baseDir, ".schub", "tasks", "ready");
-  let copied = "";
-  const recordCopy = (value: string) => {
-    copied = value;
-  };
-
-  mkdirSync(readyRoot, { recursive: true });
-  writeFileSync(join(readyRoot, "T900_copy-task.md"), "# Task: T900 Copy Task\n", "utf8");
-
-  try {
-    process.chdir(baseDir);
-    const rendered = render(<App copyToClipboard={recordCopy} />);
-    rendered.stdin.write("c");
-    await new Promise((resolve) => setTimeout(resolve, 0));
-    const output = rendered.lastFrame() ?? "";
-    expect(copied).toBe("T900");
-    expect(output).toContain("Copied to clipboard !");
-  } finally {
-    process.chdir(originalCwd);
-  }
-});
-
-test("renders when no .schub directory is found", () => {
-  const originalCwd = process.cwd();
-  const originalSchubCwd = process.env.SCHUB_CWD;
-  const baseDir = mkdtempSync(join(tmpdir(), "schub-app-"));
-  process.env.SCHUB_CWD = baseDir;
-
-  try {
-    process.chdir(baseDir);
-    const { lastFrame } = render(<App />);
-    const output = lastFrame() ?? "";
-    expect(output).toContain("No .schub directory found.");
-  } finally {
-    process.chdir(originalCwd);
-    if (originalSchubCwd === undefined) {
-      delete process.env.SCHUB_CWD;
-    } else {
-      process.env.SCHUB_CWD = originalSchubCwd;
-    }
-  }
-});

package/src/App.tsx

@@ -1,155 +0,0 @@
-import { homedir } from "node:os";
-import { Box, Text, useInput, useStdout } from "ink";
-import React from "react";
-import packageJson from "../package.json";
-import { copyToClipboard as copyToClipboardDefault } from "./clipboard";
-import PlanView from "./components/PlanView";
-import StatusView from "./components/StatusView";
-import { findSchubRoot } from "./features/tasks";
-
-type Mode = "status" | "plan";
-
-type TabDefinition = {
-  id: Mode;
-  label: string;
-};
-
-const tabs: TabDefinition[] = [
-  { id: "status", label: "Status" },
-  { id: "plan", label: "Plan" },
-];
-
-type AppProps = {
-  copyToClipboard?: (value: string) => void;
-};
-
-const COPY_BANNER_TEXT = "Copied to clipboard !";
-const COPY_BANNER_TIMEOUT_MS = 1500;
-
-export default function App({ copyToClipboard = copyToClipboardDefault }: AppProps) {
-  const [mode, setMode] = React.useState<Mode>("status");
-  const { stdout } = useStdout();
-  const [dimensions, setDimensions] = React.useState(() => ({
-    columns: stdout.columns,
-    rows: stdout.rows,
-  }));
-  const [copyBanner, setCopyBanner] = React.useState<string | null>(null);
-  const versionLabel = `${packageJson.version}`;
-  const homeDir = homedir();
-  const startDir = process.env.SCHUB_CWD ?? process.cwd();
-  const schubDir = findSchubRoot(startDir);
-  const displaySchubDir = (() => {
-    const targetDir = schubDir ?? startDir;
-    if (targetDir === homeDir) {
-      return "~";
-    }
-    if (targetDir.startsWith(`${homeDir}/`)) {
-      return `~${targetDir.slice(homeDir.length)}`;
-    }
-    return targetDir;
-  })();
-
-  React.useEffect(() => {
-    if (!copyBanner) {
-      return;
-    }
-
-    const timeout = setTimeout(() => {
-      setCopyBanner(null);
-    }, COPY_BANNER_TIMEOUT_MS);
-
-    return () => {
-      clearTimeout(timeout);
-    };
-  }, [copyBanner]);
-
-  React.useEffect(() => {
-    const handleResize = () => {
-      setDimensions({ columns: stdout.columns, rows: stdout.rows });
-    };
-
-    stdout.on("resize", handleResize);
-
-    return () => {
-      stdout.off("resize", handleResize);
-    };
-  }, [stdout]);
-
-  useInput((_input, key) => {
-    if (key.tab) {
-      setMode((current) => (current === "status" ? "plan" : "status"));
-    }
-  });
-
-  const handleCopyId = (value: string) => {
-    copyToClipboard(value);
-    setCopyBanner(COPY_BANNER_TEXT);
-  };
-
-  const shortcuts = [
-    { keyLabel: "o", label: "open file" },
-    { keyLabel: "c", label: "copy" },
-  ];
-
-  return (
-    <Box backgroundColor="black" flexDirection="column" width={dimensions.columns} height={dimensions.rows}>
-      <Box flexDirection="column" paddingX={2} paddingY={1} flexShrink={0}>
-        <Box flexDirection="row" justifyContent="space-between" alignItems="center">
-          <Box flexDirection="row">
-            {tabs.map((tab) => {
-              const isSelected = mode === tab.id;
-              return (
-                <Box
-                  key={tab.id}
-                  marginRight={4}
-                  borderStyle="bold"
-                  borderLeft={isSelected}
-                  borderTop={false}
-                  borderRight={false}
-                  borderBottom={false}
-                  borderLeftColor={"blueBright"}
-                  flexDirection="row"
-                  alignItems="center"
-                  paddingLeft={1}
-                >
-                  <Text color={isSelected ? "white" : "gray"} bold={isSelected}>
-                    {tab.label}
-                  </Text>
-                </Box>
-              );
-            })}
-          </Box>
-          {copyBanner ? (
-            <Box backgroundColor="green" paddingX={1}>
-              <Text color="black">{copyBanner}</Text>
-            </Box>
-          ) : null}
-        </Box>
-      </Box>
-      <Box flexDirection="column" paddingX={2} paddingY={1} flexGrow={1} flexShrink={1}>
-        {mode === "status" ? <StatusView onCopyId={handleCopyId} /> : <PlanView onCopyId={handleCopyId} />}
-      </Box>
-      <Box flexDirection="column" paddingX={2} paddingBottom={1} flexShrink={0}>
-        <Box justifyContent="space-between">
-          <Box flexDirection="row">
-            {shortcuts.map((shortcut) => (
-              <Box key={shortcut.keyLabel} marginRight={2}>
-                <Text color="gray">[</Text>
-                <Text color="white">{shortcut.keyLabel}</Text>
-                <Text color="gray"> {shortcut.label}]</Text>
-              </Box>
-            ))}
-          </Box>
-          <Box marginRight={2}>
-            <Text>tab</Text>
-            <Text color="gray"> switch mode</Text>
-          </Box>
-        </Box>
-        <Box justifyContent="space-between" marginTop={1}>
-          <Text color="gray">{displaySchubDir}</Text>
-          <Text color="gray">{versionLabel}</Text>
-        </Box>
-      </Box>
-    </Box>
-  );
-}

package/src/components/PlanView.test.tsx

@@ -1,113 +0,0 @@
-import { expect, test } from "bun:test";
-import { mkdirSync, mkdtempSync, renameSync, writeFileSync } from "node:fs";
-import { tmpdir } from "node:os";
-import { join } from "node:path";
-import { render } from "ink-testing-library";
-import PlanView from "./PlanView";
-
-const ansiPattern = new RegExp(`${String.fromCharCode(27)}\\[[0-9;]*m`, "g");
-const stripAnsi = (value: string) => value.replace(ansiPattern, "");
-
-const extractSection = (output: string, start: string, end?: string): string => {
-  const startIndex = output.indexOf(start);
-  if (startIndex === -1) {
-    return "";
-  }
-
-  const afterStart = output.slice(startIndex + start.length);
-  if (!end) {
-    return afterStart;
-  }
-  const endIndex = afterStart.indexOf(end);
-  if (endIndex === -1) {
-    return afterStart;
-  }
-
-  return afterStart.slice(0, endIndex);
-};
-
-const noopCopy = () => {};
-
-test("plan shows backlog tasks with satisfied dependencies as ready", () => {
-  const originalCwd = process.cwd();
-  const base = mkdtempSync(join(tmpdir(), "schub-plan-view-"));
-  const tasksDir = join(base, ".schub", "tasks", "backlog");
-  mkdirSync(tasksDir, { recursive: true });
-  writeFileSync(join(tasksDir, "T001_ready-task.md"), "# Task: T001 Ready Task\n", "utf8");
-
-  try {
-    process.chdir(base);
-    const { lastFrame } = render(<PlanView onCopyId={noopCopy} />);
-    const output = stripAnsi(lastFrame() ?? "");
-    const readySection = extractSection(output, "Ready to Implement", "Dependency Plan");
-
-    expect(readySection).toContain("T001");
-    expect(readySection).not.toContain("No tasks ready for implementation.");
-  } finally {
-    process.chdir(originalCwd);
-  }
-});
-
-test("plan view omits per-item shortcuts for ready tasks", () => {
-  const originalCwd = process.cwd();
-  const base = mkdtempSync(join(tmpdir(), "schub-plan-actions-"));
-  const tasksDir = join(base, ".schub", "tasks", "backlog");
-  mkdirSync(tasksDir, { recursive: true });
-  writeFileSync(join(tasksDir, "T010_quick-action.md"), "# Task: T010 Quick Action\n", "utf8");
-
-  try {
-    process.chdir(base);
-    const { lastFrame } = render(<PlanView onCopyId={noopCopy} />);
-    const output = stripAnsi(lastFrame() ?? "");
-    const readySection = extractSection(output, "Ready to Implement", "Dependency Plan");
-
-    expect(readySection).toContain("T010");
-    expect(readySection).not.toContain("[o open file]");
-    expect(readySection).not.toContain("[c copy]");
-  } finally {
-    process.chdir(originalCwd);
-  }
-});
-
-test("plan view refreshes ready list and dependency graph when tasks change", async () => {
-  const originalCwd = process.cwd();
-  const base = mkdtempSync(join(tmpdir(), "schub-plan-refresh-"));
-  const tasksDir = join(base, ".schub", "tasks", "backlog");
-  const doneDir = join(base, ".schub", "tasks", "done");
-  const refreshIntervalMs = 50;
-  let unmount: (() => void) | undefined;
-
-  mkdirSync(tasksDir, { recursive: true });
-  mkdirSync(doneDir, { recursive: true });
-
-  try {
-    process.chdir(base);
-    writeFileSync(
-      join(tasksDir, "T002_waiting-task.md"),
-      "# Task: T002 Waiting Task\n\n**Depends on**: T003\n",
-      "utf8",
-    );
-    writeFileSync(join(tasksDir, "T003_dependency.md"), "# Task: T003 Dependency\n", "utf8");
-    const rendered = render(<PlanView refreshIntervalMs={refreshIntervalMs} onCopyId={noopCopy} />);
-    unmount = rendered.unmount;
-    const initial = stripAnsi(rendered.lastFrame() ?? "");
-    const initialReady = extractSection(initial, "Ready to Implement", "Dependency Plan");
-    expect(initialReady).not.toContain("T002");
-    const initialGraph = extractSection(initial, "Dependency Plan");
-    expect(initialGraph).toContain("T002");
-    expect(initialGraph).toContain("T003");
-
-    renameSync(join(tasksDir, "T003_dependency.md"), join(doneDir, "T003_dependency.md"));
-    await new Promise((resolve) => setTimeout(resolve, refreshIntervalMs * 2));
-
-    const refreshed = stripAnsi(rendered.lastFrame() ?? "");
-    const refreshedReady = extractSection(refreshed, "Ready to Implement", "Dependency Plan");
-    expect(refreshedReady).toContain("T002");
-    const refreshedGraph = extractSection(refreshed, "Dependency Plan");
-    expect(refreshedGraph).toContain("T002");
-    expect(refreshedGraph).not.toContain("T003");
-  } finally {
-    unmount?.();
-    process.chdir(originalCwd);
-  }
-});

package/src/components/PlanView.tsx

@@ -1,160 +0,0 @@
-import { dirname } from "node:path";
-import { Box, Text, useInput } from "ink";
-import React from "react";
-import {
-  buildTaskGraph,
-  findSchubRoot,
-  loadTaskDependencies,
-  renderTaskGraphLines,
-  type TaskStatus,
-  trimTaskTitle,
-} from "../features/tasks";
-import { openInVsCode } from "../ide";
-
-const PLAN_TASK_STATUSES: readonly TaskStatus[] = ["backlog", "ready", "wip", "blocked"];
-const READY_TASK_STATUSES: readonly TaskStatus[] = ["backlog", "ready"];
-
-type PlanViewProps = {
-  refreshIntervalMs?: number;
-  onCopyId: (id: string) => void;
-};
-
-const DEFAULT_REFRESH_INTERVAL_MS = 1000;
-
-const buildPlanData = (schubDir: string | null) => {
-  if (!schubDir) {
-    return { visibleTasks: [], readyTasks: [], graphLines: [] };
-  }
-
-  const allTasks = loadTaskDependencies(schubDir);
-  const visibleTasks = allTasks.filter((task) => PLAN_TASK_STATUSES.includes(task.status));
-  const tasksById = new Map(allTasks.map((task) => [task.id, task]));
-  const readyTasks = visibleTasks.filter((task) => {
-    if (!READY_TASK_STATUSES.includes(task.status)) {
-      return false;
-    }
-
-    return task.dependsOn.every((dependencyId) => tasksById.get(dependencyId)?.status === "done");
-  });
-
-  if (visibleTasks.length === 0) {
-    return { visibleTasks, readyTasks, graphLines: [] };
-  }
-
-  const graph = buildTaskGraph(visibleTasks);
-  const graphLines = renderTaskGraphLines(graph);
-  return { visibleTasks, readyTasks, graphLines };
-};
-
-export default function PlanView({ refreshIntervalMs = DEFAULT_REFRESH_INTERVAL_MS, onCopyId }: PlanViewProps) {
-  const schubDir = findSchubRoot();
-  const [, setRefreshTick] = React.useState(0);
-  const planData = buildPlanData(schubDir);
-  const [selection, setSelection] = React.useState(0);
-  const totalReadyTasks = planData.readyTasks.length;
-  const repoRoot = schubDir ? dirname(schubDir) : "";
-
-  React.useEffect(() => {
-    if (!schubDir) {
-      return;
-    }
-
-    const interval = setInterval(() => {
-      setRefreshTick((current) => current + 1);
-    }, refreshIntervalMs);
-
-    return () => {
-      clearInterval(interval);
-    };
-  }, [refreshIntervalMs, schubDir]);
-
-  React.useEffect(() => {
-    if (totalReadyTasks === 0) {
-      setSelection(0);
-      return;
-    }
-    setSelection((current) => Math.min(current, totalReadyTasks - 1));
-  }, [totalReadyTasks]);
-
-  useInput((input, key) => {
-    if (totalReadyTasks === 0) {
-      return;
-    }
-
-    if (key.downArrow) {
-      setSelection((current) => Math.min(current + 1, totalReadyTasks - 1));
-    }
-
-    if (key.upArrow) {
-      setSelection((current) => Math.max(current - 1, 0));
-    }
-
-    if (input === "o") {
-      const selectedTask = planData.readyTasks[selection];
-      openInVsCode(repoRoot, selectedTask.path);
-    }
-
-    if (input === "c") {
-      const selectedTask = planData.readyTasks[selection];
-      onCopyId(selectedTask.id);
-    }
-  });
-
-  if (!schubDir) {
-    return (
-      <Box flexDirection="column">
-        <Text color="red">No .schub directory found.</Text>
-      </Box>
-    );
-  }
-
-  if (planData.visibleTasks.length === 0) {
-    return (
-      <Box flexDirection="column">
-        <Text color="gray">No tasks found in .schub</Text>
-      </Box>
-    );
-  }
-
-  return (
-    <Box flexDirection="column">
-      <Box flexDirection="column">
-        <Box marginBottom={1}>
-          <Text bold color="white">
-            Ready to Implement
-          </Text>
-        </Box>
-        {planData.readyTasks.length === 0 ? (
-          <Text color="gray">No tasks ready for implementation.</Text>
-        ) : (
-          planData.readyTasks.map((task, index) => {
-            const selected = index === selection;
-            return (
-              <Box key={task.id} marginLeft={1}>
-                <Text color={selected ? "blue" : "gray"}>{selected ? "›" : " "}</Text>
-                <Box marginLeft={1}>
-                  <Text color="white" bold={selected}>
-                    {task.id}
-                  </Text>
-                  <Text color="gray"> {trimTaskTitle(task.title)}</Text>
-                </Box>
-              </Box>
-            );
-          })
-        )}
-      </Box>
-      <Box flexDirection="column" marginTop={2}>
-        <Box marginBottom={1}>
-          <Text bold color="white">
-            Dependency Plan
-          </Text>
-        </Box>
-        {planData.graphLines.map((line, index) => (
-          <Text key={`${line.text}-${index}`} color={"grey"}>
-            {line.text}
-          </Text>
-        ))}
-      </Box>
-    </Box>
-  );
-}