project-roadmap-tracking 0.1.0

package/dist/util/types.d.ts

@@ -0,0 +1,66 @@
+export type Config = {
+    $schema: string;
+    metadata: {
+        description: string;
+        name: string;
+    };
+    path: string;
+};
+export type Roadmap = {
+    $schema: string;
+    metadata: {
+        createdAt: string;
+        createdBy: string;
+        description: string;
+        name: string;
+    };
+    tasks: Array<Task>;
+};
+export type Tag = string;
+export declare enum PRIORITY {
+    High = "high",
+    Low = "low",
+    Medium = "medium"
+}
+export declare enum STATUS {
+    Completed = "completed",
+    InProgress = "in-progress",
+    NotStarted = "not-started"
+}
+export declare enum TASK_TYPE {
+    Bug = "bug",
+    Feature = "feature",
+    Improvement = "improvement",
+    Planning = "planning",
+    Research = "research"
+}
+export declare enum TASK_TYPE_LETTER {
+    Bug = "B",
+    Feature = "F",
+    Improvement = "I",
+    Planning = "P",
+    Research = "R"
+}
+export declare const TASK_TYPE_MAP: Map<TASK_TYPE, TASK_TYPE_LETTER>;
+export type SingleDigit = `${0 | 1 | 2 | 3 | 4 | 5 | 6 | 7 | 8 | 9}`;
+export type TaskID = `${TASK_TYPE_LETTER}-${SingleDigit}${SingleDigit}${SingleDigit}`;
+export declare const TASK_ID_REGEX: RegExp;
+export type Task = {
+    assignedTo?: null | string;
+    blocks: Array<Task['id']>;
+    createdAt?: null | string;
+    'depends-on': Array<Task['id']>;
+    details: string;
+    dueDate?: null | string;
+    effort?: null | number;
+    'github-refs'?: Array<string>;
+    id: TaskID;
+    notes?: null | string;
+    'passes-tests': boolean;
+    priority: PRIORITY;
+    status: STATUS;
+    tags: Array<Tag>;
+    title: string;
+    type: TASK_TYPE;
+    updatedAt?: null | string;
+};

package/dist/util/types.js

@@ -0,0 +1,36 @@
+export var PRIORITY;
+(function (PRIORITY) {
+    PRIORITY["High"] = "high";
+    PRIORITY["Low"] = "low";
+    PRIORITY["Medium"] = "medium";
+})(PRIORITY || (PRIORITY = {}));
+export var STATUS;
+(function (STATUS) {
+    STATUS["Completed"] = "completed";
+    STATUS["InProgress"] = "in-progress";
+    STATUS["NotStarted"] = "not-started";
+})(STATUS || (STATUS = {}));
+export var TASK_TYPE;
+(function (TASK_TYPE) {
+    TASK_TYPE["Bug"] = "bug";
+    TASK_TYPE["Feature"] = "feature";
+    TASK_TYPE["Improvement"] = "improvement";
+    TASK_TYPE["Planning"] = "planning";
+    TASK_TYPE["Research"] = "research";
+})(TASK_TYPE || (TASK_TYPE = {}));
+export var TASK_TYPE_LETTER;
+(function (TASK_TYPE_LETTER) {
+    TASK_TYPE_LETTER["Bug"] = "B";
+    TASK_TYPE_LETTER["Feature"] = "F";
+    TASK_TYPE_LETTER["Improvement"] = "I";
+    TASK_TYPE_LETTER["Planning"] = "P";
+    TASK_TYPE_LETTER["Research"] = "R";
+})(TASK_TYPE_LETTER || (TASK_TYPE_LETTER = {}));
+export const TASK_TYPE_MAP = new Map([
+    [TASK_TYPE.Bug, TASK_TYPE_LETTER.Bug],
+    [TASK_TYPE.Feature, TASK_TYPE_LETTER.Feature],
+    [TASK_TYPE.Improvement, TASK_TYPE_LETTER.Improvement],
+    [TASK_TYPE.Planning, TASK_TYPE_LETTER.Planning],
+    [TASK_TYPE.Research, TASK_TYPE_LETTER.Research],
+]);
+export const TASK_ID_REGEX = /^(B|F|I|P|R)-[0-9]{3}$/;

package/dist/util/update-task.d.ts

@@ -0,0 +1,4 @@
+import { Roadmap } from './types.js';
+export declare function updateTaskInRoadmap(roadmap: Roadmap, taskId: string, updates: Partial<{
+    [K in keyof (typeof roadmap.tasks)[number]]: (typeof roadmap.tasks)[number][K];
+}>): Promise<Roadmap>;

package/dist/util/update-task.js

@@ -0,0 +1,16 @@
+export async function updateTaskInRoadmap(roadmap, taskId, updates) {
+    const taskIndex = roadmap.tasks.findIndex((task) => task.id === taskId);
+    if (taskIndex === -1) {
+        throw new Error(`Task with ID ${taskId} not found`);
+    }
+    const updatedTask = {
+        ...roadmap.tasks[taskIndex],
+        ...updates,
+        updatedAt: new Date().toISOString(),
+    };
+    const updatedRoadmap = {
+        ...roadmap,
+        tasks: [...roadmap.tasks.slice(0, taskIndex), updatedTask, ...roadmap.tasks.slice(taskIndex + 1)],
+    };
+    return updatedRoadmap;
+}

package/dist/util/validate-task-id.d.ts

@@ -0,0 +1,2 @@
+import { TaskID } from './types.js';
+export declare function validateTaskID(taskID: string): asserts taskID is TaskID;

package/dist/util/validate-task-id.js

@@ -0,0 +1,5 @@
+export function validateTaskID(taskID) {
+    if (!/^(B|F|I|P|R)-[0-9]{3}$/.test(taskID)) {
+        throw new Error(`task ID ${taskID} is not valid. Must match format: [B|F|I|P|R]-[000-999]`);
+    }
+}

package/dist/util/validate-task.d.ts

@@ -0,0 +1,4 @@
+import { Task } from './types.js';
+export declare function validateTask(task: Task, { skipID }?: {
+    skipID?: boolean;
+}): void;

package/dist/util/validate-task.js

@@ -0,0 +1,17 @@
+export function validateTask(task, { skipID } = {}) {
+    if (!skipID && !/^(B|F|I|P|R)-[0-9]{3}$/.test(task.id)) {
+        throw new Error(`task ID ${task.id} is not valid. Must match format: [B|F|I|P|R]-[000-999]`);
+    }
+    if (!['bug', 'feature', 'improvement', 'planning', 'research'].includes(task.type)) {
+        throw new Error(`task ${skipID ? '' : `ID ${task.id}`} has invalid type: ${task.type}`);
+    }
+    if (!['high', 'low', 'medium'].includes(task.priority)) {
+        throw new Error(`task ${skipID ? '' : `ID ${task.id}`} has invalid priority: ${task.priority}`);
+    }
+    if (!['completed', 'in-progress', 'not-started'].includes(task.status)) {
+        throw new Error(`task ${skipID ? '' : `ID ${task.id}`} has invalid status: ${task.status}`);
+    }
+    if (!task.details) {
+        throw new Error(`task ${skipID ? '' : `ID ${task.id}`} must have details`);
+    }
+}

package/dist/util/write-roadmap.d.ts

@@ -0,0 +1,2 @@
+import { Roadmap } from './types.js';
+export declare function writeRoadmapFile(path: string, roadmap: Roadmap): Promise<void>;

package/dist/util/write-roadmap.js

@@ -0,0 +1,5 @@
+import { writeFile } from 'node:fs/promises';
+export async function writeRoadmapFile(path, roadmap) {
+    const data = JSON.stringify(roadmap, null, 2);
+    await writeFile(path, data, 'utf8');
+}

package/oclif.manifest.json

@@ -0,0 +1,426 @@
+{
+  "commands": {
+    "add": {
+      "aliases": [],
+      "args": {
+        "title": {
+          "description": "title of the task to add",
+          "name": "title",
+          "required": true
+        }
+      },
+      "description": "add a new task to the roadmap",
+      "examples": [
+        "<%= config.bin %> <%= command.id %>"
+      ],
+      "flags": {
+        "details": {
+          "char": "d",
+          "description": "description of the task to add",
+          "name": "details",
+          "required": true,
+          "hasDynamicHelp": false,
+          "multiple": false,
+          "type": "option"
+        },
+        "priority": {
+          "char": "p",
+          "description": "priority of the task to add",
+          "name": "priority",
+          "required": false,
+          "default": "medium",
+          "hasDynamicHelp": false,
+          "multiple": false,
+          "options": [
+            "high",
+            "medium",
+            "low"
+          ],
+          "type": "option"
+        },
+        "status": {
+          "char": "s",
+          "description": "status of the task to add",
+          "name": "status",
+          "required": false,
+          "default": "not-started",
+          "hasDynamicHelp": false,
+          "multiple": false,
+          "options": [
+            "not-started",
+            "in-progress",
+            "completed"
+          ],
+          "type": "option"
+        },
+        "tags": {
+          "char": "g",
+          "description": "comma-separated list of tags to add to the task",
+          "name": "tags",
+          "required": false,
+          "hasDynamicHelp": false,
+          "multiple": false,
+          "type": "option"
+        },
+        "type": {
+          "char": "t",
+          "description": "type of the task to add",
+          "name": "type",
+          "required": true,
+          "hasDynamicHelp": false,
+          "multiple": false,
+          "options": [
+            "bug",
+            "feature",
+            "improvement",
+            "planning",
+            "research"
+          ],
+          "type": "option"
+        }
+      },
+      "hasDynamicHelp": false,
+      "hiddenAliases": [],
+      "id": "add",
+      "pluginAlias": "project-roadmap-tracking",
+      "pluginName": "project-roadmap-tracking",
+      "pluginType": "core",
+      "strict": true,
+      "enableJsonFlag": false,
+      "isESM": true,
+      "relativePath": [
+        "dist",
+        "commands",
+        "add.js"
+      ]
+    },
+    "complete": {
+      "aliases": [],
+      "args": {
+        "taskID": {
+          "description": "ID of the task to complete",
+          "name": "taskID",
+          "required": true
+        }
+      },
+      "description": "Mark a task as completed",
+      "examples": [
+        "<%= config.bin %> <%= command.id %> F-001 --tests"
+      ],
+      "flags": {
+        "tests": {
+          "char": "t",
+          "description": "mark task as passes-tests",
+          "name": "tests",
+          "allowNo": false,
+          "type": "boolean"
+        }
+      },
+      "hasDynamicHelp": false,
+      "hiddenAliases": [],
+      "id": "complete",
+      "pluginAlias": "project-roadmap-tracking",
+      "pluginName": "project-roadmap-tracking",
+      "pluginType": "core",
+      "strict": true,
+      "enableJsonFlag": false,
+      "isESM": true,
+      "relativePath": [
+        "dist",
+        "commands",
+        "complete.js"
+      ]
+    },
+    "init": {
+      "aliases": [],
+      "args": {
+        "folder": {
+          "description": "folder to initialize the project roadmap in",
+          "name": "folder"
+        }
+      },
+      "description": "initialize a new project roadmap (prt.json and prt.config.json)",
+      "examples": [
+        "<%= config.bin %> <%= command.id %> [path/to/directory]"
+      ],
+      "flags": {
+        "description": {
+          "char": "d",
+          "description": "description to print",
+          "name": "description",
+          "hasDynamicHelp": false,
+          "multiple": false,
+          "type": "option"
+        },
+        "force": {
+          "char": "f",
+          "description": "force initialization even if files already exist",
+          "name": "force",
+          "allowNo": false,
+          "type": "boolean"
+        },
+        "name": {
+          "char": "n",
+          "description": "name to print",
+          "name": "name",
+          "hasDynamicHelp": false,
+          "multiple": false,
+          "type": "option"
+        },
+        "withSampleTasks": {
+          "description": "include sample tasks in the initialized roadmap",
+          "name": "withSampleTasks",
+          "allowNo": false,
+          "type": "boolean"
+        }
+      },
+      "hasDynamicHelp": false,
+      "hiddenAliases": [],
+      "id": "init",
+      "pluginAlias": "project-roadmap-tracking",
+      "pluginName": "project-roadmap-tracking",
+      "pluginType": "core",
+      "strict": true,
+      "enableJsonFlag": false,
+      "isESM": true,
+      "relativePath": [
+        "dist",
+        "commands",
+        "init.js"
+      ]
+    },
+    "list": {
+      "aliases": [],
+      "args": {},
+      "description": "list tasks in the project roadmap",
+      "examples": [
+        "<%= config.bin %> <%= command.id %> -p=h --incomplete --sort=createdAt"
+      ],
+      "flags": {
+        "incomplete": {
+          "char": "i",
+          "description": "filter tasks to show in-progress and not-started only",
+          "name": "incomplete",
+          "allowNo": false,
+          "type": "boolean"
+        },
+        "priority": {
+          "char": "p",
+          "description": "filter tasks by priority (high, medium, low)",
+          "name": "priority",
+          "hasDynamicHelp": false,
+          "multiple": false,
+          "options": [
+            "high",
+            "medium",
+            "low",
+            "h",
+            "m",
+            "l"
+          ],
+          "type": "option"
+        },
+        "sort": {
+          "char": "o",
+          "description": "sort tasks by field (dueDate, priority, createdAt)",
+          "name": "sort",
+          "hasDynamicHelp": false,
+          "multiple": false,
+          "options": [
+            "dueDate",
+            "priority",
+            "createdAt"
+          ],
+          "type": "option"
+        },
+        "status": {
+          "char": "s",
+          "description": "filter tasks by status (completed, in-progress, not-started)",
+          "name": "status",
+          "hasDynamicHelp": false,
+          "multiple": false,
+          "options": [
+            "completed",
+            "in-progress",
+            "not-started"
+          ],
+          "type": "option"
+        }
+      },
+      "hasDynamicHelp": false,
+      "hiddenAliases": [],
+      "id": "list",
+      "pluginAlias": "project-roadmap-tracking",
+      "pluginName": "project-roadmap-tracking",
+      "pluginType": "core",
+      "strict": true,
+      "enableJsonFlag": false,
+      "isESM": true,
+      "relativePath": [
+        "dist",
+        "commands",
+        "list.js"
+      ]
+    },
+    "pass-test": {
+      "aliases": [],
+      "args": {
+        "taskID": {
+          "description": "ID of the task to mark as passing tests",
+          "name": "taskID",
+          "required": true
+        }
+      },
+      "description": "Mark a task as passes-tests",
+      "examples": [
+        "<%= config.bin %> <%= command.id %> F-001"
+      ],
+      "flags": {},
+      "hasDynamicHelp": false,
+      "hiddenAliases": [],
+      "id": "pass-test",
+      "pluginAlias": "project-roadmap-tracking",
+      "pluginName": "project-roadmap-tracking",
+      "pluginType": "core",
+      "strict": true,
+      "enableJsonFlag": false,
+      "isESM": true,
+      "relativePath": [
+        "dist",
+        "commands",
+        "pass-test.js"
+      ]
+    },
+    "show": {
+      "aliases": [],
+      "args": {
+        "task": {
+          "description": "task ID to show",
+          "name": "task",
+          "required": true
+        }
+      },
+      "description": "show details of a specific task in the project roadmap",
+      "examples": [
+        "<%= config.bin %> <%= command.id %> F-001"
+      ],
+      "flags": {},
+      "hasDynamicHelp": false,
+      "hiddenAliases": [],
+      "id": "show",
+      "pluginAlias": "project-roadmap-tracking",
+      "pluginName": "project-roadmap-tracking",
+      "pluginType": "core",
+      "strict": true,
+      "enableJsonFlag": false,
+      "isESM": true,
+      "relativePath": [
+        "dist",
+        "commands",
+        "show.js"
+      ]
+    },
+    "update": {
+      "aliases": [],
+      "args": {
+        "taskID": {
+          "description": "ID of the task to update",
+          "name": "taskID",
+          "required": true
+        }
+      },
+      "description": "Update a task in place",
+      "examples": [
+        "<%= config.bin %> <%= command.id %> F-001 --status=completed --tested=true --notes=\"Fixed all bugs\"",
+        "<%= config.bin %> <%= command.id %> F-002 --deps=\"F-001\" --clear-notes"
+      ],
+      "flags": {
+        "clear-notes": {
+          "description": "clear all notes from the task",
+          "name": "clear-notes",
+          "allowNo": false,
+          "type": "boolean"
+        },
+        "deps": {
+          "char": "d",
+          "description": "update the dependencies of the task (comma-separated list of task IDs)",
+          "name": "deps",
+          "hasDynamicHelp": false,
+          "multiple": false,
+          "type": "option"
+        },
+        "notes": {
+          "char": "n",
+          "description": "append notes to the task",
+          "name": "notes",
+          "hasDynamicHelp": false,
+          "multiple": false,
+          "type": "option"
+        },
+        "status": {
+          "char": "s",
+          "description": "set the status of the task (completed, in-progress, not-started)",
+          "name": "status",
+          "hasDynamicHelp": false,
+          "multiple": false,
+          "options": [
+            "completed",
+            "in-progress",
+            "not-started"
+          ],
+          "type": "option"
+        },
+        "tested": {
+          "char": "t",
+          "description": "update whether the task passes tests",
+          "name": "tested",
+          "hasDynamicHelp": false,
+          "multiple": false,
+          "options": [
+            "true",
+            "false"
+          ],
+          "type": "option"
+        }
+      },
+      "hasDynamicHelp": false,
+      "hiddenAliases": [],
+      "id": "update",
+      "pluginAlias": "project-roadmap-tracking",
+      "pluginName": "project-roadmap-tracking",
+      "pluginType": "core",
+      "strict": true,
+      "enableJsonFlag": false,
+      "isESM": true,
+      "relativePath": [
+        "dist",
+        "commands",
+        "update.js"
+      ]
+    },
+    "validate": {
+      "aliases": [],
+      "args": {},
+      "description": "describe the command here",
+      "examples": [
+        "<%= config.bin %> <%= command.id %>"
+      ],
+      "flags": {},
+      "hasDynamicHelp": false,
+      "hiddenAliases": [],
+      "id": "validate",
+      "pluginAlias": "project-roadmap-tracking",
+      "pluginName": "project-roadmap-tracking",
+      "pluginType": "core",
+      "strict": true,
+      "enableJsonFlag": false,
+      "isESM": true,
+      "relativePath": [
+        "dist",
+        "commands",
+        "validate.js"
+      ]
+    }
+  },
+  "version": "0.1.0"
+}

package/package.json

@@ -0,0 +1,73 @@
+{
+  "name": "project-roadmap-tracking",
+  "description": "CLI based project task tracking",
+  "version": "0.1.0",
+  "author": "ZacharyEggert",
+  "bin": {
+    "prt": "./bin/run.js"
+  },
+  "bugs": "https://github.com/ZacharyEggert/project-roadmap-tracking/issues",
+  "dependencies": {
+    "@oclif/core": "^4",
+    "@oclif/plugin-help": "^6",
+    "@oclif/plugin-plugins": "^5"
+  },
+  "devDependencies": {
+    "@eslint/compat": "^1",
+    "@oclif/prettier-config": "^0.2.1",
+    "@oclif/test": "^4",
+    "@types/chai": "^4",
+    "@types/mocha": "^10",
+    "@types/node": "^18",
+    "chai": "^4",
+    "eslint": "^9",
+    "eslint-config-oclif": "^6",
+    "eslint-config-prettier": "^10",
+    "mocha": "^10",
+    "oclif": "^4",
+    "shx": "^0.3.3",
+    "ts-node": "^10",
+    "typescript": "^5"
+  },
+  "engines": {
+    "node": ">=18.0.0"
+  },
+  "files": [
+    "./bin",
+    "./dist",
+    "./oclif.manifest.json"
+  ],
+  "homepage": "https://github.com/ZacharyEggert/project-roadmap-tracking",
+  "keywords": [
+    "oclif"
+  ],
+  "license": "MIT",
+  "main": "dist/index.js",
+  "type": "module",
+  "oclif": {
+    "bin": "prt",
+    "dirname": "prt",
+    "commands": "./dist/commands",
+    "plugins": [
+      "@oclif/plugin-help",
+      "@oclif/plugin-plugins"
+    ],
+    "topicSeparator": " ",
+    "topics": {
+      "hello": {
+        "description": "Say hello to the world and others"
+      }
+    }
+  },
+  "repository": "ZacharyEggert/project-roadmap-tracking",
+  "scripts": {
+    "build": "shx rm -rf dist && tsc",
+    "lint": "eslint",
+    "postpack": "shx rm -f oclif.manifest.json",
+    "posttest": "yarn lint",
+    "prepack": "oclif manifest && oclif readme",
+    "test": "mocha --forbid-only \"test/**/*.test.ts\"",
+    "version": "oclif readme && git add README.md"
+  },
+  "types": "dist/index.d.ts"
+}