@qodalis/cli-todo 2.0.0-beta.8 → 2.0.0-rc.1

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@qodalis/cli-todo",
-  "version": "2.0.0-beta.8",
+  "version": "2.0.0-rc.1",
   "description": "@qodalis/cli extension for managing TODO tasks with add, list, complete, and remove commands.",
   "author": "Nicolae Lupei, Qodalis Solutions",
   "license": "MIT",
@@ -20,7 +20,7 @@
   "umd": "./umd/index.global.js",
   "unpkg": "./umd/index.global.js",
   "dependencies": {
-    "@qodalis/cli-core": "2.0.0-beta.8"
+    "@qodalis/cli-core": "2.0.0-rc.1"
   },
   "sideEffects": false,
   "main": "./public-api.js",

package/public-api.d.mts

@@ -1,5 +1,4 @@
-import * as _qodalis_cli_core from '@qodalis/cli-core';
-import { ICliCommandProcessor, CliProcessorMetadata, CliStateConfiguration, CliProcessCommand, ICliExecutionContext, ICliCompletionProvider, ICliCompletionContext, ICliModule } from '@qodalis/cli-core';
+import { ICliCommandProcessor, CliProcessorMetadata, ICliConfigurationOption, CliStateConfiguration, CliProcessCommand, ICliExecutionContext, ICliCompletionProvider, ICliCompletionContext, ICliModule } from '@qodalis/cli-core';
 
 type TodoItem = {
     id: number;
@@ -18,13 +17,13 @@ declare function lineThroughText(text: string): string;
 declare class CliTodoCommandProcessor implements ICliCommandProcessor {
     command: string;
     description: string;
-    author: _qodalis_cli_core.ICliCommandAuthor;
+    author: any;
     version: string;
     processors?: ICliCommandProcessor[];
     metadata?: CliProcessorMetadata;
+    configurationOptions?: ICliConfigurationOption[];
     stateConfiguration?: CliStateConfiguration;
     private todos;
-    private nextId;
     getTodos(): TodoItem[];
     constructor();
     processCommand(command: CliProcessCommand, context: ICliExecutionContext): Promise<void>;
@@ -33,7 +32,12 @@ declare class CliTodoCommandProcessor implements ICliCommandProcessor {
     private formatTodoLine;
     private registerSubProcessors;
     private loadFromOldStorage;
-    private saveToStorage;
+    /**
+     * Change the list and save it, atomically: `change` gets the latest saved
+     * list (another tab may have changed it) to edit in place, or returns a
+     * new one.
+     */
+    private changeTodos;
 }
 
 declare class CliTodoIdCompletionProvider implements ICliCompletionProvider {
@@ -45,4 +49,5 @@ declare class CliTodoIdCompletionProvider implements ICliCompletionProvider {
 
 declare const todoModule: ICliModule;
 
-export { CliTodoCommandProcessor, CliTodoIdCompletionProvider, type TodoItem, formatRelativeDate, isOverdue, lineThroughText, migrateTodoItem, parseDueDate, todoModule };
+export { CliTodoCommandProcessor, CliTodoIdCompletionProvider, formatRelativeDate, isOverdue, lineThroughText, migrateTodoItem, parseDueDate, todoModule };
+export type { TodoItem };

package/public-api.d.ts

@@ -1,5 +1,4 @@
-import * as _qodalis_cli_core from '@qodalis/cli-core';
-import { ICliCommandProcessor, CliProcessorMetadata, CliStateConfiguration, CliProcessCommand, ICliExecutionContext, ICliCompletionProvider, ICliCompletionContext, ICliModule } from '@qodalis/cli-core';
+import { ICliCommandProcessor, CliProcessorMetadata, ICliConfigurationOption, CliStateConfiguration, CliProcessCommand, ICliExecutionContext, ICliCompletionProvider, ICliCompletionContext, ICliModule } from '@qodalis/cli-core';
 
 type TodoItem = {
     id: number;
@@ -18,13 +17,13 @@ declare function lineThroughText(text: string): string;
 declare class CliTodoCommandProcessor implements ICliCommandProcessor {
     command: string;
     description: string;
-    author: _qodalis_cli_core.ICliCommandAuthor;
+    author: any;
     version: string;
     processors?: ICliCommandProcessor[];
     metadata?: CliProcessorMetadata;
+    configurationOptions?: ICliConfigurationOption[];
     stateConfiguration?: CliStateConfiguration;
     private todos;
-    private nextId;
     getTodos(): TodoItem[];
     constructor();
     processCommand(command: CliProcessCommand, context: ICliExecutionContext): Promise<void>;
@@ -33,7 +32,12 @@ declare class CliTodoCommandProcessor implements ICliCommandProcessor {
     private formatTodoLine;
     private registerSubProcessors;
     private loadFromOldStorage;
-    private saveToStorage;
+    /**
+     * Change the list and save it, atomically: `change` gets the latest saved
+     * list (another tab may have changed it) to edit in place, or returns a
+     * new one.
+     */
+    private changeTodos;
 }
 
 declare class CliTodoIdCompletionProvider implements ICliCompletionProvider {
@@ -45,4 +49,5 @@ declare class CliTodoIdCompletionProvider implements ICliCompletionProvider {
 
 declare const todoModule: ICliModule;
 
-export { CliTodoCommandProcessor, CliTodoIdCompletionProvider, type TodoItem, formatRelativeDate, isOverdue, lineThroughText, migrateTodoItem, parseDueDate, todoModule };
+export { CliTodoCommandProcessor, CliTodoIdCompletionProvider, formatRelativeDate, isOverdue, lineThroughText, migrateTodoItem, parseDueDate, todoModule };
+export type { TodoItem };

package/public-api.js

@@ -89,7 +89,7 @@ function lineThroughText(text) {
 }
 
 // src/lib/version.ts
-var LIBRARY_VERSION = "2.0.0-beta.8";
+var LIBRARY_VERSION = "2.0.0-rc.1";
 var API_VERSION = 2;
 
 // src/lib/processors/cli-todo-command-processor.ts
@@ -105,13 +105,28 @@ var CliTodoCommandProcessor = class {
       requiredCoreVersion: ">=2.0.0 <3.0.0",
       requiredCliVersion: ">=2.0.0 <3.0.0"
     };
+    this.configurationOptions = [
+      {
+        key: "showCompletedFirst",
+        label: "Show Completed First",
+        description: "List completed tasks before pending ones",
+        type: "boolean",
+        defaultValue: false
+      },
+      {
+        key: "confirmBeforeDelete",
+        label: "Confirm Before Delete",
+        description: "Ask for confirmation before removing tasks",
+        type: "boolean",
+        defaultValue: false
+      }
+    ];
     this.stateConfiguration = {
       initialState: {
         todos: this.loadFromOldStorage() ?? []
       }
     };
     this.todos = [];
-    this.nextId = 1;
     this.registerSubProcessors();
   }
   getTodos() {
@@ -121,26 +136,26 @@ var CliTodoCommandProcessor = class {
     context.executor.showHelp(command, context);
   }
   writeDescription(context) {
-    const { writer } = context;
-    writer.writeln(this.description);
+    const { writer, translator: t } = context;
+    writer.writeln(t.t("cli.todo.description", this.description));
     writer.writeln();
-    writer.writeln(writer.wrapInColor("Commands:", cliCore.CliForegroundColor.Yellow));
-    writer.writeln(`  ${writer.wrapInColor("todo ls", cliCore.CliForegroundColor.Cyan)}                    List all tasks`);
-    writer.writeln(`  ${writer.wrapInColor("todo ls --pending", cliCore.CliForegroundColor.Cyan)}          List pending tasks only`);
-    writer.writeln(`  ${writer.wrapInColor("todo ls --completed", cliCore.CliForegroundColor.Cyan)}        List completed tasks only`);
-    writer.writeln(`  ${writer.wrapInColor("todo ls --overdue", cliCore.CliForegroundColor.Cyan)}          List overdue tasks only`);
-    writer.writeln(`  ${writer.wrapInColor("todo add <text>", cliCore.CliForegroundColor.Cyan)}            Add a new task`);
-    writer.writeln(`  ${writer.wrapInColor("todo add <text> --due <date>", cliCore.CliForegroundColor.Cyan)}  Add with due date`);
-    writer.writeln(`  ${writer.wrapInColor("todo edit <id> <new text>", cliCore.CliForegroundColor.Cyan)}  Edit a task`);
-    writer.writeln(`  ${writer.wrapInColor("todo done <id>", cliCore.CliForegroundColor.Cyan)}             Mark a task as done`);
-    writer.writeln(`  ${writer.wrapInColor("todo toggle <id>", cliCore.CliForegroundColor.Cyan)}           Toggle done/undone`);
-    writer.writeln(`  ${writer.wrapInColor("todo rm <id>", cliCore.CliForegroundColor.Cyan)}               Remove a task`);
-    writer.writeln(`  ${writer.wrapInColor("todo rm --all", cliCore.CliForegroundColor.Cyan)}              Remove all tasks`);
+    writer.writeln(writer.wrapInColor(t.t("cli.todo.help.commands", "Commands:"), cliCore.CliForegroundColor.Yellow));
+    writer.writeln(`  ${writer.wrapInColor("todo ls", cliCore.CliForegroundColor.Cyan)}                    ${t.t("cli.todo.help.list_all", "List all tasks")}`);
+    writer.writeln(`  ${writer.wrapInColor("todo ls --pending", cliCore.CliForegroundColor.Cyan)}          ${t.t("cli.todo.help.list_pending", "List pending tasks only")}`);
+    writer.writeln(`  ${writer.wrapInColor("todo ls --completed", cliCore.CliForegroundColor.Cyan)}        ${t.t("cli.todo.help.list_completed", "List completed tasks only")}`);
+    writer.writeln(`  ${writer.wrapInColor("todo ls --overdue", cliCore.CliForegroundColor.Cyan)}          ${t.t("cli.todo.help.list_overdue", "List overdue tasks only")}`);
+    writer.writeln(`  ${writer.wrapInColor("todo add <text>", cliCore.CliForegroundColor.Cyan)}            ${t.t("cli.todo.help.add", "Add a new task")}`);
+    writer.writeln(`  ${writer.wrapInColor("todo add <text> --due <date>", cliCore.CliForegroundColor.Cyan)}  ${t.t("cli.todo.help.add_due", "Add with due date")}`);
+    writer.writeln(`  ${writer.wrapInColor("todo edit <id> <new text>", cliCore.CliForegroundColor.Cyan)}  ${t.t("cli.todo.help.edit", "Edit a task")}`);
+    writer.writeln(`  ${writer.wrapInColor("todo done <id>", cliCore.CliForegroundColor.Cyan)}             ${t.t("cli.todo.help.done", "Mark a task as done")}`);
+    writer.writeln(`  ${writer.wrapInColor("todo toggle <id>", cliCore.CliForegroundColor.Cyan)}           ${t.t("cli.todo.help.toggle", "Toggle done/undone")}`);
+    writer.writeln(`  ${writer.wrapInColor("todo rm <id>", cliCore.CliForegroundColor.Cyan)}               ${t.t("cli.todo.help.remove", "Remove a task")}`);
+    writer.writeln(`  ${writer.wrapInColor("todo rm --all", cliCore.CliForegroundColor.Cyan)}              ${t.t("cli.todo.help.remove_all", "Remove all tasks")}`);
     writer.writeln();
-    writer.writeln(writer.wrapInColor("Due date formats:", cliCore.CliForegroundColor.Yellow));
+    writer.writeln(writer.wrapInColor(t.t("cli.todo.help.due_formats", "Due date formats:"), cliCore.CliForegroundColor.Yellow));
     writer.writeln(`  today, tomorrow, monday..sunday, next week, next month, YYYY-MM-DD`);
     writer.writeln();
-    writer.writeln(writer.wrapInColor("Examples:", cliCore.CliForegroundColor.Yellow));
+    writer.writeln(writer.wrapInColor(t.t("cli.common.examples", "Examples:"), cliCore.CliForegroundColor.Yellow));
     writer.writeln(`  todo add Buy groceries --due tomorrow`);
     writer.writeln(`  todo ls --pending`);
     writer.writeln(`  todo edit 3 Buy organic groceries`);
@@ -150,7 +165,6 @@ var CliTodoCommandProcessor = class {
   async initialize(context) {
     context.state.select((x) => x["todos"]).subscribe((todos) => {
       this.todos = (todos || []).map(migrateTodoItem);
-      this.nextId = this.todos.length > 0 ? Math.max(...this.todos.map((t) => t.id)) + 1 : 1;
     });
   }
   formatTodoLine(todo, writer) {
@@ -209,6 +223,10 @@ var CliTodoCommandProcessor = class {
           } else if (args["overdue"]) {
             filtered = filtered.filter((t) => isOverdue(t));
           }
+          const showCompletedFirst = cliCore.getPluginConfigValue(context, "todo", "showCompletedFirst", false);
+          if (showCompletedFirst) {
+            filtered.sort((a, b) => a.completed === b.completed ? 0 : a.completed ? -1 : 1);
+          }
           const doneCount = this.todos.filter((t) => t.completed).length;
           context.writer.writeln(
             context.writer.wrapInColor(
@@ -243,7 +261,7 @@ var CliTodoCommandProcessor = class {
           }
         ],
         processCommand: async (command, context) => {
-          const text = command.value;
+          const text = cliCore.joinShellWords(command.value ?? "");
           if (!text) {
             context.writer.writeError("Please provide a task description.");
             return;
@@ -260,15 +278,17 @@ var CliTodoCommandProcessor = class {
             }
             dueDate = parsed;
           }
-          const newItem = {
-            id: this.nextId++,
-            text,
-            completed: false,
-            createdAt: (/* @__PURE__ */ new Date()).toISOString(),
-            dueDate
-          };
-          this.todos.push(newItem);
-          await this.saveToStorage(context);
+          let newItem;
+          await this.changeTodos(context, (todos) => {
+            newItem = {
+              id: nextIdOf(todos),
+              text,
+              completed: false,
+              createdAt: (/* @__PURE__ */ new Date()).toISOString(),
+              dueDate
+            };
+            todos.push(newItem);
+          });
           let msg = `Added: "${text}"`;
           if (dueDate) {
             msg += ` (${formatRelativeDate(dueDate)})`;
@@ -292,10 +312,8 @@ var CliTodoCommandProcessor = class {
           }
         ],
         processCommand: async (command, context) => {
-          const raw = command.value || "";
-          const spaceIndex = raw.indexOf(" ");
-          const idStr = spaceIndex === -1 ? raw : raw.substring(0, spaceIndex);
-          const newText = spaceIndex === -1 ? void 0 : raw.substring(spaceIndex + 1).trim();
+          const [idStr = "", ...words] = command.positionals ?? [];
+          const newText = words.length ? words.join(" ") : void 0;
           const id = parseInt(idStr, 10);
           if (isNaN(id)) {
             context.writer.writeError("Usage: todo edit <id> <new text> [--due <date>]");
@@ -307,32 +325,33 @@ var CliTodoCommandProcessor = class {
             return;
           }
           const dueArg = command.args["due"];
-          let changed = false;
+          const edit = {};
           if (newText) {
-            todo.text = newText;
-            changed = true;
+            edit.text = newText;
           }
           if (dueArg) {
             if (dueArg === "none") {
-              todo.dueDate = void 0;
-              changed = true;
+              edit.dueDate = void 0;
             } else {
               const parsed = parseDueDate(dueArg);
               if (!parsed) {
                 context.writer.writeError(`Invalid due date: "${dueArg}".`);
                 return;
               }
-              todo.dueDate = parsed;
-              changed = true;
+              edit.dueDate = parsed;
             }
           }
-          if (!changed) {
+          if (Object.keys(edit).length === 0) {
             context.writer.writeError("Nothing to update. Provide new text or --due.");
             return;
           }
-          await this.saveToStorage(context);
+          let updated;
+          await this.changeTodos(context, (todos) => {
+            const item = todos.find((t) => t.id === id);
+            if (item) updated = Object.assign(item, edit);
+          });
           context.writer.writeSuccess(`Updated task #${id}.`);
-          context.process.output(todo);
+          context.process.output(updated ?? { ...todo, ...edit });
         }
       },
       // ── done ────────────────────────────────────────────
@@ -343,7 +362,7 @@ var CliTodoCommandProcessor = class {
         acceptsRawInput: true,
         valueRequired: true,
         processCommand: async (command, context) => {
-          const id = parseInt(command.value || "", 10);
+          const id = parseInt(command.positionals?.[0] ?? "", 10);
           if (isNaN(id)) {
             context.writer.writeError("Please provide a valid task ID.");
             return;
@@ -357,11 +376,16 @@ var CliTodoCommandProcessor = class {
             context.writer.writeInfo(`Task #${id} is already done.`);
             return;
           }
-          todo.completed = true;
-          todo.completedAt = (/* @__PURE__ */ new Date()).toISOString();
-          await this.saveToStorage(context);
+          const completedAt = (/* @__PURE__ */ new Date()).toISOString();
+          await this.changeTodos(context, (todos) => {
+            const item = todos.find((t) => t.id === id);
+            if (item) {
+              item.completed = true;
+              item.completedAt = completedAt;
+            }
+          });
           context.writer.writeSuccess(`Done: "${todo.text}"`);
-          context.process.output(todo);
+          context.process.output({ ...todo, completed: true, completedAt });
         }
       },
       // ── toggle ──────────────────────────────────────────
@@ -371,7 +395,7 @@ var CliTodoCommandProcessor = class {
         acceptsRawInput: true,
         valueRequired: true,
         processCommand: async (command, context) => {
-          const id = parseInt(command.value || "", 10);
+          const id = parseInt(command.positionals?.[0] ?? "", 10);
           if (isNaN(id)) {
             context.writer.writeError("Please provide a valid task ID.");
             return;
@@ -381,12 +405,18 @@ var CliTodoCommandProcessor = class {
             context.writer.writeError(`Task #${id} not found.`);
             return;
           }
-          todo.completed = !todo.completed;
-          todo.completedAt = todo.completed ? (/* @__PURE__ */ new Date()).toISOString() : void 0;
-          await this.saveToStorage(context);
-          const status = todo.completed ? "done" : "reopened";
+          const completed = !todo.completed;
+          const completedAt = completed ? (/* @__PURE__ */ new Date()).toISOString() : void 0;
+          await this.changeTodos(context, (todos) => {
+            const item = todos.find((t) => t.id === id);
+            if (item) {
+              item.completed = completed;
+              item.completedAt = completedAt;
+            }
+          });
+          const status = completed ? "done" : "reopened";
           context.writer.writeSuccess(`Task #${id} marked as ${status}.`);
-          context.process.output(todo);
+          context.process.output({ ...todo, completed, completedAt });
         }
       },
       // ── rm ──────────────────────────────────────────────
@@ -419,12 +449,11 @@ var CliTodoCommandProcessor = class {
               context.writer.writeInfo("Cancelled.");
               return;
             }
-            this.todos = [];
-            await this.saveToStorage(context);
+            await this.changeTodos(context, () => []);
             context.writer.writeSuccess("Removed all tasks.");
             return;
           }
-          const id = parseInt(command.value, 10);
+          const id = parseInt(command.positionals?.[0] ?? "", 10);
           if (isNaN(id)) {
             context.writer.writeError("Please provide a valid task ID.");
             return;
@@ -434,8 +463,22 @@ var CliTodoCommandProcessor = class {
             context.writer.writeError(`Task #${id} not found.`);
             return;
           }
-          const removed = this.todos.splice(index, 1)[0];
-          await this.saveToStorage(context);
+          const confirmBeforeDelete = cliCore.getPluginConfigValue(context, "todo", "confirmBeforeDelete", false);
+          if (confirmBeforeDelete) {
+            const confirmed = await context.reader.readConfirm(
+              `Remove task #${id}: "${this.todos[index].text}"?`,
+              false
+            );
+            if (!confirmed) {
+              context.writer.writeInfo("Cancelled.");
+              return;
+            }
+          }
+          const removed = this.todos[index];
+          await this.changeTodos(
+            context,
+            (todos) => todos.filter((t) => t.id !== id)
+          );
           context.writer.writeSuccess(`Removed: "${removed.text}"`);
         }
       }
@@ -450,12 +493,24 @@ var CliTodoCommandProcessor = class {
       return [];
     }
   }
-  async saveToStorage(context) {
-    context.state.updateState({ todos: this.todos });
-    await context.state.persist();
+  /**
+   * Change the list and save it, atomically: `change` gets the latest saved
+   * list (another tab may have changed it) to edit in place, or returns a
+   * new one.
+   */
+  async changeTodos(context, change) {
+    await context.state.update((state) => {
+      const todos = (state["todos"] ?? []).map(
+        (t) => ({ ...migrateTodoItem(t) })
+      );
+      return { todos: change(todos) ?? todos };
+    });
     localStorage.removeItem("todo-items");
   }
 };
+function nextIdOf(todos) {
+  return todos.length > 0 ? Math.max(...todos.map((t) => t.id)) + 1 : 1;
+}
 
 // src/lib/completion/cli-todo-id-completion-provider.ts
 var TODO_ID_SUBCOMMANDS = /* @__PURE__ */ new Set(["rm", "done", "complete", "toggle", "edit"]);