@zinn-dev/cli 0.6.0 → 0.7.0

package/README.md

@@ -68,6 +68,24 @@ zinn task view MDR-1
 
 When a project key is supplied, the list follows the project's column order and the task order within each column.
 
+## Task relations
+
+```sh
+zinn task relation create MDR-1 MDR-2 --type dependency
+zinn task relation create MDR-1 MDR-2 --type duplicate
+zinn task relation create MDR-1 OTHER-1 --type related
+zinn task relation list MDR-1
+```
+
+`dependency` means the first task depends on the second, `duplicate` means the first task is a duplicate of the second. `related` is a bit different as the order of the tasks mentioned _does not matter_, either case describes the same relation.
+
+Relations do not have any side effects. They are purely for information.
+Tasks from separate projects can be related to each other. Tasks can also be related to archived tasks.
+
+`task view` a task's existing relations.
+
+Use `task relation create --help` to discover types.
+
 ## Edit tasks
 
 Edit a task's title, description, or both:

package/index.ts

@@ -25,6 +25,8 @@ Commands:
   task archive
   task unarchive
   task delete
+  task relation create
+  task relation list
 
 Run zinn <namespace> --help or zinn <command> --help for more information.
 Running zinn without a command shows this help.`);

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@zinn-dev/cli",
-  "version": "0.6.0",
+  "version": "0.7.0",
   "description": "A kanban workflow in the terminal.",
   "license": "MIT",
   "bugs": {
@@ -42,6 +42,6 @@
     "access": "public"
   },
   "dependencies": {
-    "@zinn-dev/core": "0.5.0"
+    "@zinn-dev/core": "0.7.0"
   }
 }

package/src/routes/relation-router.ts

@@ -0,0 +1,113 @@
+import type { RouteDef } from "../types";
+
+import { parseArgs } from "node:util";
+import { project, relation, relationCreateSchema, task } from "@zinn-dev/core";
+import { quit } from "../lib";
+
+export function formatRelations(taskKey: string) {
+  const taskMatch = task.getByKey(taskKey);
+
+  return relation
+    .getAll(taskKey, { include: { tasks: true } })
+    .map((entry) => {
+      const isSource = entry.source_task_id === taskMatch.id;
+      const other = isSource ? entry.target : entry.source;
+      if (other == null) {
+        throw new Error("Connected task details were not included in the relation");
+      }
+
+      let label: string;
+      switch (entry.relation_type) {
+        case "related": {
+          label = "Related to";
+          break;
+        }
+        case "dependency": {
+          label = isSource ? "Depends on" : "Depended on by";
+          break;
+        }
+        case "duplicate": {
+          label = isSource ? "Duplicate of" : "Duplicated by";
+          break;
+        }
+      }
+
+      const archived = other.archived_at == null ? "" : " | Archived";
+      return `${label} | ${other.key} | ${other.title}${archived}`;
+    })
+    .join("\n");
+}
+
+export const relationRouter = {
+  create: {
+    run: (args) => {
+      const { values, positionals, tokens } = parseArgs({
+        args,
+        options: { type: { type: "string" } },
+        allowPositionals: true,
+        strict: true,
+        tokens: true,
+      });
+
+      if (positionals.length !== 2) {
+        quit("Provide exactly two task keys: source and target");
+      }
+
+      if (tokens.filter((token) => token.kind === "option").length > 1) {
+        quit('Option "--type" can only be specified once');
+      }
+
+      const typeResult = relationCreateSchema.shape.relation_type.safeParse(values.type);
+      if (!typeResult.success) {
+        quit("Provide --type with one of: related, dependency, duplicate");
+      }
+      const sourceTaskKey = positionals[0]!;
+      const targetTaskKey = positionals[1]!;
+
+      relation.create({ sourceTaskKey, targetTaskKey, relation_type: typeResult.data });
+
+      const source = task.getByKey(sourceTaskKey);
+      const target = task.getByKey(targetTaskKey);
+
+      const sourceKey = `${project.getById(source.project_id)!.key}-${source.number}`;
+      const targetKey = `${project.getById(target.project_id)!.key}-${target.number}`;
+
+      const label = {
+        related: "related to",
+        dependency: "depends on",
+        duplicate: "is a duplicate of",
+      }[typeResult.data];
+      console.info(`${sourceKey} ${label} ${targetKey}`);
+    },
+    help: `Usage: zinn task relation create <source-task-key> <target-task-key> --type <type>
+
+Types:
+  related     Connect two tasks, with any order provided to indicate relation.
+  dependency  Source depends on target.
+  duplicate   Source is a duplicate of target.
+
+Relations do not have any side effects. They are purely for information.
+Tasks from separate projects can be related to each other. Tasks can also be related to archived tasks.
+
+Example: zinn task relation create APP-1 APP-2 --type dependency`,
+  },
+  list: {
+    run: (args) => {
+      const { positionals } = parseArgs({ args, allowPositionals: true, strict: true });
+      if (positionals.length !== 1) {
+        quit("Provide exactly one task key");
+      }
+      const output = formatRelations(positionals[0]!);
+      if (output.length > 0) {
+        console.info(output);
+      }
+    },
+    help: `Usage: zinn task relation list <task-key>
+
+Show incoming and outgoing relations with connected task keys and titles.
+Archived connected tasks are included and marked Archived.
+An empty list prints nothing.
+
+Example: zinn task relation list APP-1`,
+  },
+} satisfies RouteDef;

package/src/routes/task-router.ts

@@ -1,9 +1,10 @@
 import type { RouteDef } from "../types";
 
 import { parseArgs } from "node:util";
-
 import { task, project, column } from "@zinn-dev/core";
+
 import { quit } from "../lib";
+import { formatRelations, relationRouter } from "./relation-router";
 
 function formatTask(
   taskMatch: ReturnType<typeof task.getByKey>,
@@ -21,6 +22,7 @@ function formatTask(
 }
 
 export const taskRouter = {
+  relation: relationRouter,
   edit: {
     run: (args) => {
       const { values, positionals, tokens } = parseArgs({
@@ -189,10 +191,15 @@ Example: zinn task list MDR --all`,
 
       const taskMatch = task.getByKey(taskKey);
       console.info(formatTask(taskMatch));
+
+      const relations = formatRelations(taskKey);
+      if (relations.length > 0) {
+        console.info(`\nRelations:\n${relations}`);
+      }
     },
     help: `Usage: zinn task view <task-key>
 
-Show a task with its current column and description.
+Show a task with its current column, description, and relations.
 
 Example: zinn task view MDR-1`,
   },