@ship-cli/opencode 0.0.4 → 0.1.0

package/README.md

@@ -0,0 +1,112 @@
+# @ship-cli/opencode
+
+[![npm version](https://img.shields.io/npm/v/@ship-cli/opencode)](https://www.npmjs.com/package/@ship-cli/opencode)
+[![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](../../LICENSE)
+
+OpenCode plugin for [Ship](https://github.com/EduSantosBrito/ship-cli) - Linear task management and stacked changes for AI coding agents.
+
+## Installation
+
+Add to your `opencode.json`:
+
+```json
+{
+  "plugins": ["@ship-cli/opencode"]
+}
+```
+
+## Prerequisites
+
+- [Ship CLI](https://www.npmjs.com/package/@ship-cli/core) installed and configured (`ship init`)
+- [jj](https://martinvonz.github.io/jj) for VCS operations
+- [Linear](https://linear.app) account
+
+## What It Provides
+
+This plugin exposes the `ship` tool to OpenCode, enabling AI agents to:
+
+### Task Management
+
+| Action | Description |
+|--------|-------------|
+| `ready` | Find tasks with no blockers |
+| `list` | List all tasks with optional filters |
+| `blocked` | List tasks waiting on dependencies |
+| `show` | View task details |
+| `start` | Mark task as in progress |
+| `done` | Mark task as complete |
+| `create` | Create new tasks |
+| `update` | Modify task properties |
+| `block` | Add task dependency |
+| `unblock` | Remove task dependency |
+| `relate` | Link related tasks |
+| `status` | Check ship configuration status |
+
+### Stacked Changes (jj)
+
+| Action | Description |
+|--------|-------------|
+| `stack-create` | Create isolated workspace for a task |
+| `stack-describe` | Update commit message (use `title` + `description` params for multi-line) |
+| `stack-sync` | Fetch and rebase onto trunk |
+| `stack-restack` | Rebase stack onto trunk (no fetch) |
+| `stack-submit` | Push and create/update PR |
+| `stack-status` | View current change info |
+| `stack-log` | View stack of changes |
+| `stack-squash` | Squash change into parent |
+| `stack-abandon` | Abandon a change |
+| `stack-up` | Navigate to parent change |
+| `stack-down` | Navigate to child change |
+| `stack-undo` | Undo last jj operation |
+| `stack-update-stale` | Fix stale working copy |
+| `stack-bookmark` | Create or move bookmark |
+| `stack-workspaces` | List all workspaces |
+| `stack-remove-workspace` | Remove a workspace |
+
+### PR Reviews
+
+| Action | Description |
+|--------|-------------|
+| `pr-reviews` | Fetch PR reviews in AI-friendly format |
+
+### Webhooks
+
+| Action | Description |
+|--------|-------------|
+| `webhook-daemon-status` | Check webhook daemon status |
+| `webhook-subscribe` | Subscribe to PR events |
+| `webhook-unsubscribe` | Unsubscribe from events |
+| `webhook-cleanup` | Remove stale subscriptions |
+
+### Milestones
+
+| Action | Description |
+|--------|-------------|
+| `milestone-list` | List project milestones |
+| `milestone-show` | View milestone details |
+| `milestone-create` | Create new milestone |
+| `milestone-update` | Modify milestone |
+| `milestone-delete` | Delete milestone |
+| `task-set-milestone` | Assign task to milestone |
+| `task-unset-milestone` | Remove task from milestone |
+
+## Skill Integration
+
+For best results, pair this plugin with the ship-cli skill which provides workflow guidance:
+
+```
+.opencode/skill/ship-cli/SKILL.md
+```
+
+The skill teaches the agent the proper workflow:
+1. Find ready tasks
+2. Create isolated workspaces
+3. Make changes and sync
+4. Submit PRs with proper context
+
+## Links
+
+- [Ship CLI Documentation](https://github.com/EduSantosBrito/ship-cli#readme)
+- [OpenCode](https://opencode.ai)
+- [Linear](https://linear.app)
+- [jj (Jujutsu)](https://martinvonz.github.io/jj)

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@ship-cli/opencode",
-  "version": "0.0.4",
+  "version": "0.1.0",
   "type": "module",
   "description": "OpenCode plugin for Ship - Linear task management integration",
   "license": "MIT",
@@ -19,25 +19,42 @@
   ],
   "repository": {
     "type": "git",
-    "url": "https://github.com/user/ship",
+    "url": "https://github.com/EduSantosBrito/ship-cli.git",
     "directory": "packages/opencode-plugin"
   },
+  "homepage": "https://github.com/EduSantosBrito/ship-cli#readme",
+  "bugs": {
+    "url": "https://github.com/EduSantosBrito/ship-cli/issues"
+  },
+  "author": "Eduardo Santos de Brito",
   "publishConfig": {
     "access": "public"
   },
+  "scripts": {
+    "check": "tsc --noEmit",
+    "lint": "oxlint",
+    "format": "oxfmt --write src/",
+    "format:check": "oxfmt src/",
+    "test": "vitest run",
+    "test:watch": "vitest",
+    "prepare": "effect-language-service patch --module typescript"
+  },
   "dependencies": {
-    "@opencode-ai/plugin": "^1.0.143",
-    "@opencode-ai/sdk": "^1.0.143"
+    "@opencode-ai/plugin": "^1.0.208",
+    "@opencode-ai/sdk": "^1.0.208",
+    "effect": "^3.19.13"
   },
   "devDependencies": {
+    "@effect/language-service": "^0.62.4",
+    "@effect/vitest": "^0.25.1",
     "@types/bun": "latest",
-    "@types/node": "^22.0.0",
-    "typescript": "~5.6.2"
+    "@types/node": "^25.0.3",
+    "oxfmt": "^0.21.0",
+    "oxlint": "^1.36.0",
+    "typescript": "~5.9.3",
+    "vitest": "^4.0.16"
   },
   "engines": {
     "bun": ">=1.0.0"
-  },
-  "scripts": {
-    "typecheck": "tsc --noEmit"
   }
-}
+}

package/src/compaction.ts

@@ -0,0 +1,78 @@
+/**
+ * Compaction context preservation module.
+ *
+ * This module provides utilities for tracking task state across sessions
+ * and preserving context during OpenCode session compaction.
+ */
+
+import * as Option from "effect/Option";
+import * as Schema from "effect/Schema";
+
+// =============================================================================
+// Types
+// =============================================================================
+
+/**
+ * Session task state for compaction context preservation.
+ */
+export interface SessionTaskState {
+  taskId: string;
+  workdir?: string;
+}
+
+// =============================================================================
+// State Management
+// =============================================================================
+
+/**
+ * Module-level state for tracking the current task per session.
+ *
+ * This is populated when tasks are started via the ship tool (action=start)
+ * and updated when workspaces are created (action=stack-create).
+ * Used during compaction to preserve task context.
+ */
+export const sessionTaskMap = new Map<string, SessionTaskState>();
+
+/**
+ * Track when a task is started or updated for a session.
+ */
+export const trackTask = (sessionId: string, state: Partial<SessionTaskState>): void => {
+  const existing = sessionTaskMap.get(sessionId);
+  if (existing) {
+    // Update existing state
+    sessionTaskMap.set(sessionId, { ...existing, ...state });
+  } else if (state.taskId) {
+    // New task started
+    sessionTaskMap.set(sessionId, { taskId: state.taskId, workdir: state.workdir });
+  }
+};
+
+/**
+ * Get the tracked task for a session.
+ */
+export const getTrackedTask = (sessionId: string): Option.Option<SessionTaskState> => {
+  const task = sessionTaskMap.get(sessionId);
+  return task ? Option.some(task) : Option.none();
+};
+
+/**
+ * Clear tracked task for a session. Used for cleanup or when task is completed.
+ */
+export const clearTrackedTask = (sessionId: string): void => {
+  sessionTaskMap.delete(sessionId);
+};
+
+// =============================================================================
+// Schema Validation
+// =============================================================================
+
+/**
+ * Schema for parsing ship tool args from metadata.
+ * Only includes fields needed for task tracking.
+ */
+export const ShipToolArgsSchema = Schema.Struct({
+  action: Schema.String,
+  taskId: Schema.optional(Schema.String),
+});
+
+export const decodeShipToolArgs = Schema.decodeUnknownOption(ShipToolArgsSchema);