donebear 0.3.9 → 0.4.0

package/README.md

@@ -81,7 +81,7 @@ Edit:
 
 ```bash
 npx donebear task edit <id> --title "Pay vendor invoice"
-npx donebear task edit <id> --notes "Waiting for approval" --when upcoming
+npx donebear task edit <id> --description "Waiting for approval" --when upcoming
 npx donebear task edit <id> --clear-deadline
 npx donebear task append <id> "Added follow-up note"
 ```
@@ -161,7 +161,7 @@ npx donebear task list --total         # count only
 | `label`         | list           | list, show                                                                                        |
 | `team`          | list           | list, show                                                                                        |
 | `today`         | —              | List today's tasks                                                                                |
-| `search`        | —              | Search tasks by title or notes                                                                    |
+| `search`        | —              | Search tasks by title or description                                                              |
 | `history`       | —              | Workspace audit log                                                                               |
 | `context`       | —              | Workspace state snapshot (--markdown for prompts)                                                 |
 | `spec`          | —              | CLI spec for agent discovery (no auth required)                                                   |

package/dist/cli.mjs

@@ -7395,8 +7395,8 @@ const filterTasks = (tasks, options) => {
 	if (query.length === 0) return viewFiltered;
 	return viewFiltered.filter((task) => {
 		const title = task.title.toLowerCase();
-		const notes = task.description?.toLowerCase() ?? "";
-		return title.includes(query) || notes.includes(query);
+		const description = task.description?.toLowerCase() ?? "";
+		return title.includes(query) || description.includes(query);
 	});
 };
 const loadTasksForScope = (context, scope, apiOptions) => {
@@ -7477,7 +7477,7 @@ const runTaskShow = async (context, taskRef, options, workspaceOverride) => {
 	if (task.projectId) writeInfo(context, `projectId: ${task.projectId}`);
 	if (task.teamId) writeInfo(context, `teamId: ${task.teamId}`);
 	if (task.assigneeId) writeInfo(context, `assigneeId: ${task.assigneeId}`);
-	if (task.description) writeInfo(context, `notes: ${task.description}`);
+	if (task.description) writeInfo(context, `description: ${task.description}`);
 };
 const resolveTitle = async (context, rawTitle) => {
 	if (rawTitle) {
@@ -7488,20 +7488,28 @@ const resolveTitle = async (context, rawTitle) => {
 	if (prompted) return prompted;
 	throw new CliError("Task title is required.", EXIT_CODES.VALIDATION, "Provide a title as an argument: donebear task add \"My task\"");
 };
-const resolveNotes = async (_context, flagNotes) => {
-	if (typeof flagNotes === "string") {
-		const trimmed = flagNotes.trim();
-		return trimmed.length > 0 ? trimmed : null;
+const resolveDescription = async (context, flagDescription) => {
+	if (typeof flagDescription !== "string") return null;
+	if (flagDescription === "-") {
+		const piped = await readStdin();
+		if (!piped) {
+			writeWarning(context, "No description received on stdin (--description -); task created without a description.");
+			return null;
+		}
+		return piped;
 	}
-	const stdinContent = await readStdin();
-	if (stdinContent) return stdinContent;
-	return null;
+	const trimmed = flagDescription.trim();
+	if (trimmed.length === 0) {
+		writeWarning(context, "Empty --description value; task created without a description.");
+		return null;
+	}
+	return trimmed;
 };
 const runTaskAdd = async (context, title, options, workspaceOverride) => {
 	const commandContext = await resolveCommandContext(context);
 	const userId = await requireUserId(context, commandContext);
 	const normalizedTitle = await resolveTitle(context, title);
-	const notes = await resolveNotes(context, options.notes);
+	const description = await resolveDescription(context, options.description);
 	const { workspace, autoSelected } = await resolveWorkspace(context, {
 		apiBaseUrl: commandContext.apiBaseUrl,
 		storedWorkspaceId: commandContext.localContext.workspaceId,
@@ -7544,7 +7552,7 @@ const runTaskAdd = async (context, title, options, workspaceOverride) => {
 					createdAt: now,
 					creatorId: userId,
 					deadlineAt: deadlineEpoch,
-					description: notes,
+					description,
 					key: taskId.replaceAll("-", "").slice(0, 8),
 					projectId,
 					sortOrder: 0,
@@ -7564,6 +7572,7 @@ const runTaskAdd = async (context, title, options, workspaceOverride) => {
 			autoSelected,
 			created: true,
 			deadlineAt: deadlineEpoch,
+			description,
 			id: taskId,
 			projectId,
 			teamId,
@@ -7577,6 +7586,7 @@ const runTaskAdd = async (context, title, options, workspaceOverride) => {
 	if (autoSelected) writeInfo(context, `Auto-selected workspace: ${workspace.name}`);
 	writeSuccess(context, `Added task: ${normalizedTitle}`);
 	writeInfo(context, `id: ${taskId}`);
+	if (description) writeInfo(context, `description: ${description}`);
 };
 const runTaskMutation = async (context, taskRef, payload) => {
 	const commandContext = await resolveCommandContext(context);
@@ -7644,7 +7654,7 @@ const resolveTeamId = async (context, commandContext, teamRef, workspaceRef) =>
 	}), teamRef, "Team");
 };
 const validateTaskEditOptions = (options) => {
-	if (options.clearNotes && typeof options.notes === "string") throw new Error("Use either --notes or --clear-notes, not both.");
+	if (options.clearDescription && typeof options.description === "string") throw new Error("Use either --description or --clear-description, not both.");
 	if (options.clearDeadline && typeof options.deadline === "string") throw new Error("Use either --deadline or --clear-deadline, not both.");
 	if (options.clearProject && typeof options.project === "string") throw new Error("Use either --project or --clear-project, not both.");
 	if (options.clearTeam && typeof options.team === "string") throw new Error("Use either --team or --clear-team, not both.");
@@ -7655,10 +7665,10 @@ const applyScalarEdits = (updates, options) => {
 		if (title.length === 0) throw new Error("Task title cannot be empty.");
 		updates.title = title;
 	}
-	if (options.clearNotes) updates.description = null;
-	else if (typeof options.notes === "string") {
-		const notes = options.notes.trim();
-		updates.description = notes.length > 0 ? notes : null;
+	if (options.clearDescription) updates.description = null;
+	else if (typeof options.description === "string") {
+		const description = options.description.trim();
+		updates.description = description.length > 0 ? description : null;
 	}
 	if (typeof options.when === "string") Object.assign(updates, buildTaskStartFields(parseTaskView(options.when)));
 	if (options.clearDeadline) updates.deadlineAt = null;
@@ -7674,7 +7684,7 @@ const runTaskEdit = async (context, taskRef, options, workspaceOverride) => {
 	else if (typeof options.project === "string") updates.projectId = await resolveProjectId(context, commandContext, options.project, wsRef);
 	if (options.clearTeam) updates.teamId = null;
 	else if (typeof options.team === "string") updates.teamId = await resolveTeamId(context, commandContext, options.team, wsRef);
-	if (Object.keys(updates).length === 0) throw new Error("No updates provided. Use --title, --notes, --clear-notes, --when, --deadline, --clear-deadline, --project, --clear-project, --team, or --clear-team.");
+	if (Object.keys(updates).length === 0) throw new Error("No updates provided. Use --title, --description, --clear-description, --when, --deadline, --clear-deadline, --project, --clear-project, --team, or --clear-team.");
 	updates.updatedAt = Date.now();
 	await runTaskMutation(context, taskRef, {
 		action: "UPDATE",
@@ -7781,7 +7791,7 @@ const runTaskRandom = async (context, options, workspaceOverride) => {
 	writeInfo(context, `start: ${task.start}`);
 	writeInfo(context, `startBucket: ${task.startBucket}`);
 	writeInfo(context, `deadline: ${formatDateOnlyEpoch(task.deadlineAt) ?? "(none)"}`);
-	if (task.description) writeInfo(context, `notes: ${task.description}`);
+	if (task.description) writeInfo(context, `description: ${task.description}`);
 };
 const resolveChecklistItemReference = async (context, commandContext, taskId, itemRef) => {
 	const trimmed = itemRef.trim();
@@ -7852,7 +7862,7 @@ Agent tip: run "donebear spec task add" for full option reference
 			}, workspaceOverride);
 		});
 	});
-	task.command("list").alias("ls").description("List tasks").option("-w, --workspace <workspace>", "Workspace id, slug, or exact name").option("-s, --state <state>", "open|done|archived|all", "open").option("-n, --limit <count>", "Maximum number of tasks", (value) => parsePositiveInteger(value, "Limit"), DEFAULT_TASK_LIST_LIMIT).option("-q, --search <query>", "Filter by title or notes").option("-v, --view <view>", "Filter by view (inbox|anytime|today|upcoming|someday|logbook|trash)").addHelpText("after", `
+	task.command("list").alias("ls").description("List tasks").option("-w, --workspace <workspace>", "Workspace id, slug, or exact name").option("-s, --state <state>", "open|done|archived|all", "open").option("-n, --limit <count>", "Maximum number of tasks", (value) => parsePositiveInteger(value, "Limit"), DEFAULT_TASK_LIST_LIMIT).option("-q, --search <query>", "Filter by title or description").option("-v, --view <view>", "Filter by view (inbox|anytime|today|upcoming|someday|logbook|trash)").addHelpText("after", `
 Examples:
   donebear task list --json
   donebear task list --state done --json
@@ -7873,7 +7883,7 @@ Views:  inbox | anytime | today | upcoming | someday | logbook | trash
 			await runTaskShow(context, taskId, options, workspaceOverride);
 		});
 	});
-	task.command("read").description("Print the description (notes) of a task").argument("<id>", "Task id or unique prefix").option("-w, --workspace <workspace>", "Workspace id, slug, or exact name").action(async (taskId, options, command) => {
+	task.command("read").description("Print the description of a task").argument("<id>", "Task id or unique prefix").option("-w, --workspace <workspace>", "Workspace id, slug, or exact name").action(async (taskId, options, command) => {
 		const context = contextFromCommand(command);
 		await runWithErrorHandling(context, async () => {
 			await runTaskRead(context, taskId, options, workspaceOverride);
@@ -7897,12 +7907,12 @@ Views:  inbox | anytime | today | upcoming | someday | logbook | trash
 			await runTaskRandom(context, options, workspaceOverride);
 		});
 	});
-	task.command("add").alias("create").description("Create a task").argument("[title]", "Task title (prompted interactively if omitted)").option("-w, --workspace <workspace>", "Workspace id, slug, or exact name").option("-n, --notes <text>", "Task notes (or pipe via stdin)").option("--when <view>", "inbox|anytime|today|upcoming|someday", "inbox").option("--deadline <date>", "Deadline (YYYY-MM-DD or ISO datetime)").option("--project <key-or-id>", "Project key or id").option("--team <key-or-id>", "Team key or id").option("--idempotency-key <key>", "Stable key making retries safe (repeated calls create only one task)").addHelpText("after", `
+	task.command("add").alias("create").description("Create a task").argument("[title]", "Task title (prompted interactively if omitted)").option("-w, --workspace <workspace>", "Workspace id, slug, or exact name").option("-d, --description <text>", "Task description (use --description - to read from piped stdin)").option("--when <view>", "inbox|anytime|today|upcoming|someday", "inbox").option("--deadline <date>", "Deadline (YYYY-MM-DD or ISO datetime)").option("--project <key-or-id>", "Project key or id").option("--team <key-or-id>", "Team key or id").option("--idempotency-key <key>", "Stable key making retries safe (repeated calls create only one task)").addHelpText("after", `
 Examples:
   donebear task add "Fix login bug" --when today --json
   donebear task add "Write tests" --deadline 2030-03-15 --project PROJ --json
-  donebear task add "Review PR" --when anytime --notes "Check for XSS" --json
-  echo "Multi-line notes" | donebear task add "My task"
+  donebear task add "Review PR" --when anytime --description "Check for XSS" --json
+  echo "Multi-line description" | donebear task add "My task" --description -
   donebear task add                       # prompts for title interactively
 
 Date format: YYYY-MM-DD (e.g. 2030-03-15)
@@ -7913,7 +7923,7 @@ View (--when): inbox | anytime | today | upcoming | someday
 			await runTaskAdd(context, title, options, workspaceOverride);
 		});
 	});
-	task.command("edit").description("Update task fields").argument("<id>", "Task id or unique prefix").option("-w, --workspace <workspace>", "Workspace id, slug, or exact name").option("--title <title>", "Replace task title").option("--notes <text>", "Replace task notes (empty string clears)").option("--clear-notes", "Clear task notes").option("--when <view>", "Set view bucket (inbox|anytime|today|upcoming|someday)").option("--deadline <date>", "Set deadline (YYYY-MM-DD or ISO datetime)").option("--clear-deadline", "Clear deadline").option("--project <key-or-id>", "Set project (key or id)").option("--clear-project", "Remove project assignment").option("--team <key-or-id>", "Set team (key or id)").option("--clear-team", "Remove team assignment").action(async (taskId, options, command) => {
+	task.command("edit").description("Update task fields").argument("<id>", "Task id or unique prefix").option("-w, --workspace <workspace>", "Workspace id, slug, or exact name").option("--title <title>", "Replace task title").option("--description <text>", "Replace task description (empty string clears)").option("--clear-description", "Clear task description").option("--when <view>", "Set view bucket (inbox|anytime|today|upcoming|someday)").option("--deadline <date>", "Set deadline (YYYY-MM-DD or ISO datetime)").option("--clear-deadline", "Clear deadline").option("--project <key-or-id>", "Set project (key or id)").option("--clear-project", "Remove project assignment").option("--team <key-or-id>", "Set team (key or id)").option("--clear-team", "Remove team assignment").action(async (taskId, options, command) => {
 		const context = contextFromCommand(command);
 		await runWithErrorHandling(context, async () => {
 			await runTaskEdit(context, taskId, options, workspaceOverride);
@@ -8230,7 +8240,7 @@ const runSearch = async (context, query, options, workspaceOverride) => {
 	if (context.copy) copyToClipboard(taskListLines(limited).join("\n"));
 };
 const registerSearchCommand = (program, workspaceOverride) => {
-	program.command("search").description("Search tasks by title or notes").argument("[query]", "Search query (prompted interactively if omitted)").option("-w, --workspace <workspace>", "Workspace id, slug, or exact name").option("-s, --state <state>", "open|done|archived|all", "all").option("-n, --limit <count>", "Maximum number of results", (value) => parsePositiveInteger(value, "Limit"), DEFAULT_SEARCH_LIMIT).addHelpText("after", `
+	program.command("search").description("Search tasks by title or description").argument("[query]", "Search query (prompted interactively if omitted)").option("-w, --workspace <workspace>", "Workspace id, slug, or exact name").option("-s, --state <state>", "open|done|archived|all", "all").option("-n, --limit <count>", "Maximum number of results", (value) => parsePositiveInteger(value, "Limit"), DEFAULT_SEARCH_LIMIT).addHelpText("after", `
 Examples:
   donebear search "meeting"
   donebear search "launch" --state open
@@ -8777,13 +8787,14 @@ const COMMAND_SPECS = {
 		examples: [
 			"donebear task add \"Fix login bug\" --when today --json",
 			"donebear task add \"Write tests\" --deadline 2026-03-15 --project PROJ --json",
-			"donebear task add \"Review PR\" --when anytime --notes \"Triage for bugs\" --json",
-			"echo \"Multi-line notes\" | donebear task add \"My task\"",
+			"donebear task add \"Review PR\" --when anytime --description \"Triage for bugs\" --json",
+			"echo \"Multi-line description\" | donebear task add \"My task\" --description -",
 			"donebear task add  # prompts for title interactively in TTY"
 		],
 		json_output: {
 			created: "boolean",
 			deadlineAt: "number | null",
+			description: "string | null",
 			id: "string (UUID)",
 			projectId: "string | null",
 			teamId: "string | null",
@@ -8792,19 +8803,19 @@ const COMMAND_SPECS = {
 			workspaceId: "string",
 			workspaceName: "string"
 		},
-		notes: "Title is prompted interactively when omitted in TTY. Notes can be piped via stdin. Task id accepts full UUID or prefix of >= 4 chars in all other task subcommands.",
+		notes: "Title is prompted interactively when omitted in TTY. The description is NOT read from stdin unless you pass --description - explicitly; without --description the task is created with no description (and the saved description is echoed back in the output). Task id accepts full UUID or prefix of >= 4 chars in all other task subcommands.",
 		options: {
 			"--deadline": {
 				description: "Due date",
 				format: "YYYY-MM-DD",
 				type: "string"
 			},
-			"--idempotency-key": {
-				description: "Stable key making retries safe (repeated calls create only one task)",
+			"--description": {
+				description: "Body / description text. Pass --description - to read from piped stdin.",
 				type: "string"
 			},
-			"--notes": {
-				description: "Body / description text (or pipe via stdin)",
+			"--idempotency-key": {
+				description: "Stable key making retries safe (repeated calls create only one task)",
 				type: "string"
 			},
 			"--project": {
@@ -8847,7 +8858,7 @@ const COMMAND_SPECS = {
 			}
 		},
 		command: "task append",
-		description: "Append text to task notes",
+		description: "Append text to a task's description",
 		examples: ["donebear task append abc1 \"Additional context\" --json"],
 		json_output: {
 			id: "string",
@@ -8908,8 +8919,8 @@ const COMMAND_SPECS = {
 				description: "Clear the due date",
 				type: "boolean"
 			},
-			"--clear-notes": {
-				description: "Clear notes/description",
+			"--clear-description": {
+				description: "Clear the description",
 				type: "boolean"
 			},
 			"--clear-project": {
@@ -8925,8 +8936,8 @@ const COMMAND_SPECS = {
 				format: "YYYY-MM-DD",
 				type: "string"
 			},
-			"--notes": {
-				description: "Replace notes/description",
+			"--description": {
+				description: "Replace the task description",
 				type: "string"
 			},
 			"--project": {
@@ -9024,7 +9035,7 @@ const COMMAND_SPECS = {
 			}
 		},
 		command: "task prepend",
-		description: "Prepend text to task notes",
+		description: "Prepend text to a task's description",
 		examples: ["donebear task prepend abc1 \"URGENT: \" --json"],
 		json_output: {
 			id: "string",
@@ -9040,7 +9051,7 @@ const COMMAND_SPECS = {
 			type: "string"
 		} },
 		command: "task read",
-		description: "Print task description/notes as plain text",
+		description: "Print task description as plain text",
 		examples: ["donebear task read abc1"],
 		options: { "--workspace": { type: "string" } },
 		usage: "donebear task read <id> [options]"
@@ -9216,15 +9227,15 @@ const TOP_LEVEL_SPECS = {
 		notes: "Task id accepts full UUID or a prefix of >= 4 chars.",
 		subcommands: {
 			add: "Create a new task",
-			append: "Append text to task notes",
+			append: "Append text to a task's description",
 			archive: "Archive a task",
 			checklist: "Manage task checklist items",
 			done: "Mark a task as complete",
 			edit: "Update task fields",
 			list: "List tasks (--state, --view, --search, --limit)",
-			prepend: "Prepend text to task notes",
+			prepend: "Prepend text to a task's description",
 			random: "Pick a random task (--state to filter)",
-			read: "Print task notes as plain text",
+			read: "Print task description as plain text",
 			reopen: "Reopen a completed task",
 			show: "Get task details by id",
 			unarchive: "Restore an archived task"