@zinn-dev/cli 0.8.0 → 0.9.0

package/README.md

@@ -84,6 +84,9 @@ Tasks from separate projects can be related to each other. Tasks can also be rel
 
 `task view` a task's existing relations.
 
+Remove a relation with `zinn task relation delete MDR-1 MDR-2 --type dependency`, using its original direction for `dependency` and `duplicate`. For `related`, order does not matter.
+Note that a deletion happens _without_ confirmation.
+
 Use `task relation create --help` to discover types.
 
 ## Edit tasks

package/package.json

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

package/src/routes/relation-router.ts

@@ -38,33 +38,68 @@ export function formatRelations(taskKey: string) {
     .join("\n");
 }
 
+function parseRelationArgs(args: string[]) {
+  const { values, positionals, tokens } = parseArgs({
+    args,
+    options: { type: { type: "string" } },
+    allowPositionals: true,
+    strict: true,
+    tokens: true,
+  });
+
+  if (positionals.length !== 2) {
+    quit("Exactly two task keys are required: source, target");
+  }
+
+  const optionCount = tokens.filter((token) => token.kind === "option").length;
+
+  if (optionCount > 1) {
+    // TODO: maybe a reusable option validator can be given expected option keys, and it can spit out unsupported options as well as help for what options are supported
+    quit('Option "--type" can only be specified once');
+  }
+
+  const typeResult = relationCreateSchema.shape.relation_type.safeParse(values.type);
+
+  if (!typeResult.success) {
+    quit("--type must be one of these: related, dependency, duplicate");
+  }
+  const sourceTaskKey = positionals[0]!;
+  const targetTaskKey = positionals[1]!;
+
+  return { sourceTaskKey, targetTaskKey, relation_type: typeResult.data };
+}
+
 export const relationRouter = {
-  create: {
+  delete: {
     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");
-      }
+      const props = parseRelationArgs(args);
+      relation.delete(props);
 
-      if (tokens.filter((token) => token.kind === "option").length > 1) {
-        quit('Option "--type" can only be specified once');
-      }
+      const source = task.getByKey(props.sourceTaskKey);
+      const target = task.getByKey(props.targetTaskKey);
+      console.info(`Deleted ${props.relation_type} relation from ${source.key} to ${target.key}`);
+    },
+    help: `Usage: zinn task relation delete <source-task-key> <target-task-key> --type <type>
 
-      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]!;
+Remove only the specified relation. No confirmation is required.
+
+Types: related, dependency, duplicate.
+
+For related, either task order works.
+For dependency and duplicate, use the creation direction:
+  source depends on target, or source is a duplicate of target.
+
+Archived and cross-project tasks are supported.
+A missing relation is an error.
+
+Example: zinn task relation delete APP-1 APP-2 --type dependency`,
+  },
+  create: {
+    run: (args) => {
+      const props = parseRelationArgs(args);
+      const { sourceTaskKey, targetTaskKey } = props;
 
-      relation.create({ sourceTaskKey, targetTaskKey, relation_type: typeResult.data });
+      relation.create(props);
 
       const source = task.getByKey(sourceTaskKey);
       const target = task.getByKey(targetTaskKey);
@@ -73,7 +108,7 @@ export const relationRouter = {
         related: "related to",
         dependency: "depends on",
         duplicate: "is a duplicate of",
-      }[typeResult.data];
+      }[props.relation_type];
 
       console.info(`${source.key} ${label} ${target.key}`);
     },