@howaboua/opencode-roadmap-plugin 0.1.4 → 0.1.6

package/dist/src/tools/readroadmap.js

@@ -1,7 +1,10 @@
+/**
+ * Tool for reading roadmap state, progress, and details.
+ * Supports filtering by feature or action number.
+ */
 import { tool } from "@opencode-ai/plugin";
 import { FileStorage, RoadmapValidator } from "../storage.js";
 import { loadDescription } from "../descriptions/index.js";
-import { getErrorMessage } from "../errors/loader.js";
 export async function createReadRoadmapTool(directory) {
     const description = await loadDescription("readroadmap.txt");
     return tool({
@@ -19,17 +22,17 @@ export async function createReadRoadmapTool(directory) {
         async execute(args) {
             const storage = new FileStorage(directory);
             if (!(await storage.exists())) {
-                throw new Error(await getErrorMessage("roadmap_not_found"));
+                throw new Error("Roadmap not found. Use CreateRoadmap to create one.");
             }
             const roadmap = await storage.read();
             if (!roadmap) {
-                throw new Error(await getErrorMessage("roadmap_corrupted"));
+                throw new Error("Roadmap file is corrupted. Please fix manually.");
             }
             if (args.actionNumber && args.featureNumber) {
                 throw new Error("Cannot specify both actionNumber and featureNumber. Use one or the other, or neither for full roadmap.");
             }
             if (args.actionNumber) {
-                const actionNumberError = await RoadmapValidator.validateActionNumber(args.actionNumber);
+                const actionNumberError = RoadmapValidator.validateActionNumber(args.actionNumber);
                 if (actionNumberError) {
                     throw new Error(`${actionNumberError.message} Use ReadRoadmap to see valid action numbers.`);
                 }
@@ -46,7 +49,7 @@ export async function createReadRoadmapTool(directory) {
                 throw new Error(`Action "${args.actionNumber}" not found. Use ReadRoadmap with no arguments to see all available actions.`);
             }
             if (args.featureNumber) {
-                const featureNumberError = await RoadmapValidator.validateFeatureNumber(args.featureNumber);
+                const featureNumberError = RoadmapValidator.validateFeatureNumber(args.featureNumber);
                 if (featureNumberError) {
                     throw new Error(`${featureNumberError.message} Use ReadRoadmap to see valid feature numbers.`);
                 }

package/dist/src/tools/updateroadmap.d.ts

@@ -1,2 +1,6 @@
+/**
+ * Tool for updating action status and descriptions in a roadmap.
+ * Enforces forward-only status progression and archives when complete.
+ */
 import { type ToolDefinition } from "@opencode-ai/plugin";
 export declare function createUpdateRoadmapTool(directory: string): Promise<ToolDefinition>;

package/dist/src/tools/updateroadmap.js

@@ -1,7 +1,10 @@
+/**
+ * Tool for updating action status and descriptions in a roadmap.
+ * Enforces forward-only status progression and archives when complete.
+ */
 import { tool } from "@opencode-ai/plugin";
 import { FileStorage, RoadmapValidator } from "../storage.js";
 import { loadDescription } from "../descriptions/index.js";
-import { getErrorMessage } from "../errors/loader.js";
 export async function createUpdateRoadmapTool(directory) {
     const description = await loadDescription("updateroadmap.txt");
     return tool({
@@ -13,20 +16,20 @@ export async function createUpdateRoadmapTool(directory) {
                 .optional()
                 .describe("New action description (full overwrite). If not provided, only status is updated."),
             status: tool.schema
-                .enum(["pending", "in_progress", "completed"])
+                .enum(["pending", "in_progress", "completed", "cancelled"])
                 .optional()
-                .describe("New action status - optional if only updating description"),
+                .describe("New action status. Flexible transitions allowed except from cancelled."),
         },
         async execute(args) {
             const storage = new FileStorage(directory);
             if (!(await storage.exists())) {
-                throw new Error(await getErrorMessage("roadmap_not_found"));
+                throw new Error("Roadmap not found. Use CreateRoadmap to create one.");
             }
             const roadmap = await storage.read();
             if (!roadmap) {
-                throw new Error(await getErrorMessage("roadmap_corrupted"));
+                throw new Error("Roadmap file is corrupted. Please fix manually.");
             }
-            const actionNumberError = await RoadmapValidator.validateActionNumber(args.actionNumber);
+            const actionNumberError = RoadmapValidator.validateActionNumber(args.actionNumber);
             if (actionNumberError) {
                 throw new Error(`${actionNumberError.message} Use ReadRoadmap to see valid action numbers.`);
             }
@@ -43,17 +46,21 @@ export async function createUpdateRoadmapTool(directory) {
                 }
             }
             if (!actionFound) {
-                throw new Error(await getErrorMessage("action_not_found", { id: args.actionNumber }));
+                throw new Error(`Action "${args.actionNumber}" not found. Use ReadRoadmap to see valid action numbers.`);
+            }
+            // TypeScript: we know targetAction and targetFeature are not null here
+            if (!targetAction || !targetFeature) {
+                throw new Error("Internal error: target action not found.");
             }
             // Validate that at least one field is being updated
             if (args.description === undefined && args.status === undefined) {
-                throw new Error(await getErrorMessage("no_changes_specified"));
+                throw new Error("No changes specified. Please provide description and/or status.");
             }
             const oldStatus = targetAction.status;
             const oldDescription = targetAction.description;
             // Validate description if provided
             if (args.description !== undefined) {
-                const descError = await RoadmapValidator.validateDescription(args.description, "action");
+                const descError = RoadmapValidator.validateDescription(args.description, "action");
                 if (descError) {
                     throw new Error(`${descError.message}`);
                 }
@@ -61,7 +68,7 @@ export async function createUpdateRoadmapTool(directory) {
             }
             // Validate and update status if provided
             if (args.status !== undefined) {
-                const statusTransitionError = await RoadmapValidator.validateStatusProgression(targetAction.status, args.status);
+                const statusTransitionError = RoadmapValidator.validateStatusProgression(targetAction.status, args.status);
                 if (statusTransitionError) {
                     throw new Error(`${statusTransitionError.message} Current status: "${targetAction.status}", requested: "${args.status}"`);
                 }
@@ -75,6 +82,9 @@ export async function createUpdateRoadmapTool(directory) {
             if (args.status !== undefined && oldStatus !== args.status) {
                 changes.push(`status: "${oldStatus}" → "${args.status}"`);
             }
+            if (changes.length === 0) {
+                return `Action ${args.actionNumber} unchanged. Provided values match current state.`;
+            }
             // Check if all actions are completed
             let allCompleted = true;
             for (const feature of roadmap.features) {

package/dist/src/types.d.ts

@@ -1,17 +1,17 @@
 import { z } from "zod";
-export declare const ActionStatus: z.ZodEnum<["pending", "in_progress", "completed"]>;
+export declare const ActionStatus: z.ZodEnum<["pending", "in_progress", "completed", "cancelled"]>;
 export type ActionStatus = z.infer<typeof ActionStatus>;
 export declare const Action: z.ZodObject<{
     number: z.ZodString;
     description: z.ZodString;
-    status: z.ZodEnum<["pending", "in_progress", "completed"]>;
+    status: z.ZodEnum<["pending", "in_progress", "completed", "cancelled"]>;
 }, "strip", z.ZodTypeAny, {
     number: string;
-    status: "pending" | "in_progress" | "completed";
+    status: "pending" | "in_progress" | "completed" | "cancelled";
     description: string;
 }, {
     number: string;
-    status: "pending" | "in_progress" | "completed";
+    status: "pending" | "in_progress" | "completed" | "cancelled";
     description: string;
 }>;
 export type Action = z.infer<typeof Action>;
@@ -22,14 +22,14 @@ export declare const Feature: z.ZodObject<{
     actions: z.ZodArray<z.ZodObject<{
         number: z.ZodString;
         description: z.ZodString;
-        status: z.ZodEnum<["pending", "in_progress", "completed"]>;
+        status: z.ZodEnum<["pending", "in_progress", "completed", "cancelled"]>;
     }, "strip", z.ZodTypeAny, {
         number: string;
-        status: "pending" | "in_progress" | "completed";
+        status: "pending" | "in_progress" | "completed" | "cancelled";
         description: string;
     }, {
         number: string;
-        status: "pending" | "in_progress" | "completed";
+        status: "pending" | "in_progress" | "completed" | "cancelled";
         description: string;
     }>, "many">;
 }, "strip", z.ZodTypeAny, {
@@ -38,7 +38,7 @@ export declare const Feature: z.ZodObject<{
     title: string;
     actions: {
         number: string;
-        status: "pending" | "in_progress" | "completed";
+        status: "pending" | "in_progress" | "completed" | "cancelled";
         description: string;
     }[];
 }, {
@@ -47,7 +47,7 @@ export declare const Feature: z.ZodObject<{
     title: string;
     actions: {
         number: string;
-        status: "pending" | "in_progress" | "completed";
+        status: "pending" | "in_progress" | "completed" | "cancelled";
         description: string;
     }[];
 }>;
@@ -60,14 +60,14 @@ export declare const Roadmap: z.ZodObject<{
         actions: z.ZodArray<z.ZodObject<{
             number: z.ZodString;
             description: z.ZodString;
-            status: z.ZodEnum<["pending", "in_progress", "completed"]>;
+            status: z.ZodEnum<["pending", "in_progress", "completed", "cancelled"]>;
         }, "strip", z.ZodTypeAny, {
             number: string;
-            status: "pending" | "in_progress" | "completed";
+            status: "pending" | "in_progress" | "completed" | "cancelled";
             description: string;
         }, {
             number: string;
-            status: "pending" | "in_progress" | "completed";
+            status: "pending" | "in_progress" | "completed" | "cancelled";
             description: string;
         }>, "many">;
     }, "strip", z.ZodTypeAny, {
@@ -76,7 +76,7 @@ export declare const Roadmap: z.ZodObject<{
         title: string;
         actions: {
             number: string;
-            status: "pending" | "in_progress" | "completed";
+            status: "pending" | "in_progress" | "completed" | "cancelled";
             description: string;
         }[];
     }, {
@@ -85,7 +85,7 @@ export declare const Roadmap: z.ZodObject<{
         title: string;
         actions: {
             number: string;
-            status: "pending" | "in_progress" | "completed";
+            status: "pending" | "in_progress" | "completed" | "cancelled";
             description: string;
         }[];
     }>, "many">;
@@ -96,7 +96,7 @@ export declare const Roadmap: z.ZodObject<{
         title: string;
         actions: {
             number: string;
-            status: "pending" | "in_progress" | "completed";
+            status: "pending" | "in_progress" | "completed" | "cancelled";
             description: string;
         }[];
     }[];
@@ -107,7 +107,7 @@ export declare const Roadmap: z.ZodObject<{
         title: string;
         actions: {
             number: string;
-            status: "pending" | "in_progress" | "completed";
+            status: "pending" | "in_progress" | "completed" | "cancelled";
             description: string;
         }[];
     }[];
@@ -129,21 +129,21 @@ export interface ValidationResult {
     errors: ValidationError[];
 }
 export interface CreateRoadmapInput {
-    features: Array<{
+    features: {
         number: string;
         title: string;
         description: string;
-        actions: Array<{
+        actions: {
             number: string;
             description: string;
             status: "pending";
-        }>;
-    }>;
+        }[];
+    }[];
 }
 export interface UpdateRoadmapInput {
     actionNumber: string;
     description?: string;
-    status: ActionStatus;
+    status?: ActionStatus;
 }
 export interface ReadRoadmapInput {
     actionNumber?: string;

package/dist/src/types.js

@@ -1,5 +1,5 @@
 import { z } from "zod";
-export const ActionStatus = z.enum(["pending", "in_progress", "completed"]);
+export const ActionStatus = z.enum(["pending", "in_progress", "completed", "cancelled"]);
 export const Action = z.object({
     number: z
         .string()

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@howaboua/opencode-roadmap-plugin",
-  "version": "0.1.4",
+  "version": "0.1.6",
   "description": "Strategic roadmap planning and multi-agent coordination for OpenCode",
   "type": "module",
   "main": "./dist/index.js",
@@ -25,18 +25,24 @@
   "devDependencies": {
     "@opencode-ai/plugin": "^1.0.0",
     "@types/node": "^20.0.0",
+    "@typescript-eslint/eslint-plugin": "^8.48.1",
+    "@typescript-eslint/parser": "^8.48.1",
+    "eslint": "^9.39.1",
+    "eslint-config-prettier": "^10.1.8",
     "typescript": "^5.0.0"
   },
   "dependencies": {
-    "zod": "^3.22.0",
-    "typescript": "^5.0.0"
+    "zod": "^3.22.0"
   },
-
   "scripts": {
     "build": "tsc -p tsconfig.json && npm run copy-assets",
     "copy-assets": "mkdir -p dist/src/descriptions dist/src/errors && cp src/descriptions/*.txt dist/src/descriptions/ && cp src/errors/*.txt dist/src/errors/",
+    "lint": "eslint . --ext .ts",
     "prepublishOnly": "npm run build"
   },
+  "publishConfig": {
+    "access": "public"
+  },
   "opencode": {
     "type": "plugin",
     "tools": [

package/dist/descriptions/index.d.ts

@@ -1 +0,0 @@
-export { loadDescription } from "./loader";

package/dist/descriptions/index.js

@@ -1 +0,0 @@
-export { loadDescription } from "./loader.js";

package/dist/descriptions/loader.d.ts

@@ -1 +0,0 @@
-export declare function loadDescription(filename: string): Promise<string>;

package/dist/descriptions/loader.js

@@ -1,17 +0,0 @@
-import { promises as fs } from "fs";
-import { join } from "path";
-export async function loadDescription(filename) {
-    // In the compiled output, __dirname is .../dist/descriptions, but the assets are in .../src/descriptions.
-    // This path adjustment ensures the assets are found regardless of the build process.
-    const descriptionsDir = join(__dirname, "..", "..", "src", "descriptions");
-    const filePath = join(descriptionsDir, filename);
-    try {
-        return await fs.readFile(filePath, "utf-8");
-    }
-    catch (error) {
-        if (error.code === "ENOENT") {
-            throw new Error(`Description file not found: ${filename}. Looked in: ${filePath}. Please ensure asset files are correctly located.`);
-        }
-        throw error;
-    }
-}

package/dist/errors/loader.d.ts

@@ -1,2 +0,0 @@
-export declare function loadErrorTemplate(filename: string): Promise<string>;
-export declare function getErrorMessage(filename: string, params?: Record<string, string>): Promise<string>;

package/dist/errors/loader.js

@@ -1,24 +0,0 @@
-import { promises as fs } from "fs";
-import { join } from "path";
-const ERROR_CACHE = {};
-export async function loadErrorTemplate(filename) {
-    if (ERROR_CACHE[filename])
-        return ERROR_CACHE[filename];
-    const errorsDir = join(__dirname, "..", "..", "src", "errors");
-    const filePath = join(errorsDir, filename + ".txt");
-    try {
-        const content = await fs.readFile(filePath, "utf-8");
-        ERROR_CACHE[filename] = content.trim();
-        return ERROR_CACHE[filename];
-    }
-    catch (error) {
-        if (error.code === "ENOENT") {
-            throw new Error(`Error template not found: ${filename} at ${filePath}`);
-        }
-        throw error;
-    }
-}
-export async function getErrorMessage(filename, params = {}) {
-    const template = await loadErrorTemplate(filename);
-    return template.replace(/\{(\w+)\}/g, (_, key) => params[key] || `{${key}}`);
-}

package/dist/storage.d.ts

@@ -1,25 +0,0 @@
-import type { Roadmap, RoadmapStorage, ValidationError } from "./types";
-export declare class FileStorage implements RoadmapStorage {
-    private directory;
-    constructor(directory: string);
-    exists(): Promise<boolean>;
-    read(): Promise<Roadmap | null>;
-    write(roadmap: Roadmap): Promise<void>;
-    archive(): Promise<string>;
-}
-export declare class RoadmapValidator {
-    static validateFeatureNumber(number: string): Promise<ValidationError | null>;
-    static validateActionNumber(number: string): Promise<ValidationError | null>;
-    static validateActionSequence(actions: Array<{
-        number: string;
-    }>, globalSeenNumbers?: Set<string>, featureNumber?: string): Promise<ValidationError[]>;
-    static validateFeatureSequence(features: Array<{
-        number: string;
-        actions: Array<{
-            number: string;
-        }>;
-    }>): Promise<ValidationError[]>;
-    static validateTitle(title: string, fieldType: "feature" | "action"): Promise<ValidationError | null>;
-    static validateDescription(description: string, fieldType: "feature" | "action"): Promise<ValidationError | null>;
-    static validateStatusProgression(currentStatus: string, newStatus: string): Promise<ValidationError | null>;
-}

package/dist/storage.js

@@ -1,214 +0,0 @@
-import { promises as fs } from "fs";
-import { join } from "path";
-import { getErrorMessage } from "./errors/loader.js";
-const ROADMAP_FILE = "roadmap.json";
-export class FileStorage {
-    directory;
-    constructor(directory) {
-        this.directory = directory;
-    }
-    async exists() {
-        try {
-            await fs.access(join(this.directory, ROADMAP_FILE));
-            return true;
-        }
-        catch {
-            return false;
-        }
-    }
-    async read() {
-        try {
-            const filePath = join(this.directory, ROADMAP_FILE);
-            const data = await fs.readFile(filePath, "utf-8");
-            if (!data.trim()) {
-                return null;
-            }
-            const parsed = JSON.parse(data);
-            if (!parsed || typeof parsed !== "object") {
-                throw new Error("Invalid roadmap format: not an object");
-            }
-            if (!Array.isArray(parsed.features)) {
-                throw new Error("Invalid roadmap format: missing or invalid features array");
-            }
-            return parsed;
-        }
-        catch (error) {
-            if (error instanceof SyntaxError) {
-                throw new Error("Roadmap file contains invalid JSON. File may be corrupted.");
-            }
-            if (error instanceof Error && error.message.includes("ENOENT")) {
-                return null;
-            }
-            throw error;
-        }
-    }
-    async write(roadmap) {
-        const filePath = join(this.directory, ROADMAP_FILE);
-        const tempPath = join(this.directory, `${ROADMAP_FILE}.tmp.${Date.now()}`);
-        try {
-            const data = JSON.stringify(roadmap, null, 2);
-            await fs.writeFile(tempPath, data, "utf-8");
-            await fs.rename(tempPath, filePath);
-        }
-        catch (error) {
-            try {
-                await fs.unlink(tempPath);
-            }
-            catch {
-                // Ignore cleanup errors
-            }
-            throw error;
-        }
-    }
-    async archive() {
-        const filePath = join(this.directory, ROADMAP_FILE);
-        const timestamp = new Date().toISOString().replace(/[:.]/g, "-");
-        const archiveFilename = `roadmap.archive.${timestamp}.json`;
-        const archivePath = join(this.directory, archiveFilename);
-        await fs.rename(filePath, archivePath);
-        return archiveFilename;
-    }
-}
-export class RoadmapValidator {
-    static async validateFeatureNumber(number) {
-        if (!number || typeof number !== "string") {
-            return {
-                code: "INVALID_FEATURE_NUMBER",
-                message: await getErrorMessage("invalid_feature_id", { id: "undefined" }),
-            };
-        }
-        if (!/^\d+$/.test(number)) {
-            return {
-                code: "INVALID_FEATURE_NUMBER_FORMAT",
-                message: await getErrorMessage("invalid_feature_id", { id: number }),
-            };
-        }
-        return null;
-    }
-    static async validateActionNumber(number) {
-        if (!number || typeof number !== "string") {
-            return {
-                code: "INVALID_ACTION_NUMBER",
-                message: await getErrorMessage("invalid_action_id", { id: "undefined" }),
-            };
-        }
-        if (!/^\d+\.\d{2}$/.test(number)) {
-            return {
-                code: "INVALID_ACTION_NUMBER_FORMAT",
-                message: await getErrorMessage("invalid_action_id", { id: number }),
-            };
-        }
-        return null;
-    }
-    static async validateActionSequence(actions, globalSeenNumbers, featureNumber) {
-        const errors = [];
-        const seenNumbers = new Set();
-        for (let i = 0; i < actions.length; i++) {
-            const action = actions[i];
-            const numberError = await this.validateActionNumber(action.number);
-            if (numberError) {
-                errors.push(numberError);
-                continue;
-            }
-            // Check action-feature mismatch
-            if (featureNumber) {
-                const actionFeaturePrefix = action.number.split('.')[0];
-                if (actionFeaturePrefix !== featureNumber) {
-                    errors.push({
-                        code: "ACTION_FEATURE_MISMATCH",
-                        message: await getErrorMessage("action_mismatch", { action: action.number, feature: featureNumber }),
-                    });
-                }
-            }
-            // Check for duplicates within this feature
-            if (seenNumbers.has(action.number)) {
-                errors.push({
-                    code: "DUPLICATE_ACTION_NUMBER",
-                    message: `Duplicate action ID "${action.number}".`,
-                });
-            }
-            // Check for global duplicates
-            if (globalSeenNumbers?.has(action.number)) {
-                errors.push({
-                    code: "DUPLICATE_ACTION_NUMBER_GLOBAL",
-                    message: `Duplicate action ID "${action.number}" (exists in another feature).`,
-                });
-            }
-            seenNumbers.add(action.number);
-            globalSeenNumbers?.add(action.number);
-        }
-        return errors;
-    }
-    static async validateFeatureSequence(features) {
-        const errors = [];
-        const seenNumbers = new Set();
-        const seenActionNumbers = new Set();
-        for (let i = 0; i < features.length; i++) {
-            const feature = features[i];
-            const numberError = await this.validateFeatureNumber(feature.number);
-            if (numberError) {
-                errors.push(numberError);
-                continue;
-            }
-            if (seenNumbers.has(feature.number)) {
-                errors.push({
-                    code: "DUPLICATE_FEATURE_NUMBER",
-                    message: `Duplicate feature ID "${feature.number}".`,
-                });
-            }
-            seenNumbers.add(feature.number);
-            const actionErrors = await this.validateActionSequence(feature.actions, seenActionNumbers, feature.number);
-            errors.push(...actionErrors);
-        }
-        return errors;
-    }
-    static async validateTitle(title, fieldType) {
-        if (!title || typeof title !== "string") {
-            return {
-                code: "INVALID_TITLE",
-                message: `Invalid ${fieldType} title. Must be non-empty string.`,
-            };
-        }
-        if (title.trim() === "") {
-            return {
-                code: "EMPTY_TITLE",
-                message: `${fieldType.charAt(0).toUpperCase() + fieldType.slice(1)} title cannot be empty.`,
-            };
-        }
-        return null;
-    }
-    static async validateDescription(description, fieldType) {
-        if (!description || typeof description !== "string") {
-            return {
-                code: "INVALID_DESCRIPTION",
-                message: `Invalid ${fieldType} description. Must be non-empty string.`,
-            };
-        }
-        if (description.trim() === "") {
-            return {
-                code: "EMPTY_DESCRIPTION",
-                message: `${fieldType.charAt(0).toUpperCase() + fieldType.slice(1)} description cannot be empty.`,
-            };
-        }
-        return null;
-    }
-    static async validateStatusProgression(currentStatus, newStatus) {
-        const statusFlow = {
-            pending: ["in_progress", "completed"],
-            in_progress: ["completed"],
-            completed: [],
-        };
-        const allowedTransitions = statusFlow[currentStatus] || [];
-        if (!allowedTransitions.includes(newStatus)) {
-            return {
-                code: "INVALID_STATUS_TRANSITION",
-                message: await getErrorMessage("invalid_transition", {
-                    from: currentStatus,
-                    to: newStatus,
-                    allowed: allowedTransitions.length > 0 ? allowedTransitions.join(", ") : "None (terminal state)"
-                }),
-            };
-        }
-        return null;
-    }
-}

package/dist/tools/createroadmap.d.ts

@@ -1,2 +0,0 @@
-import { type ToolDefinition } from "@opencode-ai/plugin";
-export declare function createCreateRoadmapTool(directory: string): Promise<ToolDefinition>;