@andre-barbosa/opencode-commit 0.1.1 → 0.1.3

package/LICENSE

@@ -1,21 +1,21 @@
-MIT License
-
-Copyright (c) 2026 André Barbosa
-
-Permission is hereby granted, free of charge, to any person obtaining a copy
-of this software and associated documentation files (the "Software"), to deal
-in the Software without restriction, including without limitation the rights
-to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
-copies of the Software, and to permit persons to whom the Software is
-furnished to do so, subject to the following conditions:
-
-The above copyright notice and this permission notice shall be included in all
-copies or substantial portions of the Software.
-
-THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
-IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
-FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
-AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
-LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
-OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
-SOFTWARE.
+MIT License
+
+Copyright (c) 2026 André Barbosa
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/README.md

@@ -1,127 +1,112 @@
-# @andre-barbosa/opencode-commit
-
-OpenCode plugin that generates **Conventional Commits** messages from staged git changes using a dedicated sub-agent on a model you choose.
-
-Run `/commit` in the OpenCode TUI to get a suggested message like `feat(auth): add oauth login flow` — copy it and commit manually.
-
-## Features
-
-- `/commit` slash command (display only, no auto-commit)
-- Dedicated hidden `commit-writer` sub-agent with its own model
-- Conventional Commits format enforced (`feat(scope): ...`, `fix(scope): ...`, etc.)
-- Optional hint: `/commit emphasize breaking API change`
-- Uses staged diff, branch name, and recent commit subjects for context
-
-## Requirements
-
-- [OpenCode](https://opencode.ai/) with plugin support
-- A git repository with staged changes
-
-## Installation
-
-### 1. Copy agent and command templates
-
-```bash
-mkdir -p .opencode/agents .opencode/commands
-cp agents/commit-writer.md .opencode/agents/commit-writer.md
-cp commands/commit.md .opencode/commands/commit.md
-```
-
-### 2. Configure the plugin
-
-**Local development** (this repo):
-
-```json
-{
-  "$schema": "https://opencode.ai/config.json",
-  "plugin": [
-    [
-      "file:///C:/absolute/path/to/opencode-commit/src/index.ts",
-      {
-        "agent": "commit-writer",
-        "maxDiffChars": 12000
-      }
-    ]
-  ],
-  "agent": {
-    "commit-writer": {
-      "model": "opencode-go/deepseek-v4-flash"
-    }
-  }
-}
-```
-
-**From npm:**
-
-```json
-{
-  "plugin": [
-    ["@andre-barbosa/opencode-commit", { "agent": "commit-writer" }]
-  ],
-  "agent": {
-    "commit-writer": {
-      "model": "opencode-go/deepseek-v4-flash"
-    }
-  }
-}
-```
-
-See [opencode.example.json](opencode.example.json) for a full example.
-
-### 3. Set your model
-
-Edit the model on the `commit-writer` agent in `opencode.json` or in `.opencode/agents/commit-writer.md`:
-
-```yaml
-model: opencode-go/deepseek-v4-flash
-```
-
-Run `opencode models` to list available models.
-
-## Usage
-
-1. Stage your changes: `git add ...`
-2. Open OpenCode in the project
-3. Run `/commit`
-4. Copy the suggested message and commit: `git commit -m "feat(scope): ..."`
-
-Optional extra instruction:
-
-```text
-/commit focus on test coverage improvements
-```
-
-## Plugin options
-
-When loading the plugin as a tuple `[name, options]`:
-
-| Option | Default | Description |
-| --- | --- | --- |
-| `agent` | `commit-writer` | Sub-agent name to invoke |
-| `maxDiffChars` | `12000` | Max staged diff characters sent to the sub-agent |
-
-## Commit message format
-
-Generated messages follow [Conventional Commits](https://www.conventionalcommits.org/):
-
-```
-type(scope): short imperative description
-
-- optional bullet body
-```
-
-Allowed types: `feat`, `fix`, `docs`, `style`, `refactor`, `perf`, `test`, `build`, `ci`, `chore`.
-
-## Project layout
-
-```
-opencode-commit/
-├── src/                  # plugin source
-├── agents/               # commit-writer sub-agent template
-├── commands/             # /commit command stub
-└── opencode.example.json
-```
-
-## License
-
-MIT
+# @andre-barbosa/opencode-commit
+
+OpenCode plugin that generates **Conventional Commits** messages from uncommitted git changes using a model you choose.
+
+Run `/commit` in the OpenCode TUI to get a suggested message like `feat(auth): add oauth login flow` — copy it and commit manually.
+
+## Features
+
+- `/commit` slash command (display only, no auto-commit)
+- Dedicated model for commit message generation
+- Conventional Commits format enforced (`feat(scope): ...`, `fix(scope): ...`, etc.)
+- Optional hint: `/commit emphasize breaking API change`
+- Uses staged diffs, unstaged diffs, non-ignored untracked filenames, branch name, and recent commit subjects for context
+
+## Requirements
+
+- [OpenCode](https://opencode.ai/) with plugin support
+- A git repository with uncommitted changes
+
+## Installation
+
+### Configure the plugin
+
+**Local development** (this repo):
+
+```json
+{
+  "$schema": "https://opencode.ai/config.json",
+  "plugin": [
+    [
+      "file:///C:/absolute/path/to/opencode-commit/src/index.ts",
+      {
+        "model": "opencode-go/deepseek-v4-flash",
+        "maxDiffChars": 12000
+      }
+    ]
+  ]
+}
+```
+
+**From npm:**
+
+```json
+{
+  "$schema": "https://opencode.ai/config.json",
+  "plugin": [
+    ["@andre-barbosa/opencode-commit", { "model": "opencode-go/deepseek-v4-flash" }]
+  ]
+}
+```
+
+See [opencode.example.json](opencode.example.json) for a full example.
+
+Run `opencode models` to list available models.
+Restart OpenCode after editing config.
+
+## Usage
+
+1. Make changes in a git repository. Staging is optional.
+2. Open OpenCode in the project.
+3. Run `/commit`.
+4. Copy the suggested message and commit: `git commit -m "feat(scope): ..."`.
+
+Optional extra instruction:
+
+```text
+/commit focus on test coverage improvements
+```
+
+## Plugin options
+
+When loading the plugin as a tuple `[name, options]`:
+
+| Option | Default | Description |
+| --- | --- | --- |
+| `model` | required | Model to use in `provider/model-id` format |
+| `maxDiffChars` | `12000` | Max tracked diff characters sent across staged and unstaged diffs |
+
+## Change scope
+
+`/commit` analyzes:
+
+- Staged tracked changes from `git diff --staged`
+- Unstaged tracked changes from `git diff`
+- Non-ignored untracked filenames from `git ls-files --others --exclude-standard`
+
+It does not read untracked file contents and does not ask Git for ignored files.
+
+## Commit message format
+
+Generated messages follow [Conventional Commits](https://www.conventionalcommits.org/):
+
+```
+type(scope): short imperative description
+
+- optional bullet body
+```
+
+Allowed types: `feat`, `fix`, `docs`, `style`, `refactor`, `perf`, `test`, `build`, `ci`, `chore`.
+
+## Project layout
+
+```
+opencode-commit/
+├── src/                  # plugin source
+├── commands/             # optional /commit command stub
+└── opencode.example.json
+```
+
+## License
+
+MIT

package/commands/commit.md

@@ -1,5 +1,5 @@
----
-description: Generate a commit message from staged changes
----
-
-Handled by the opencode-commit plugin.
+---
+description: Generate a commit message from uncommitted changes
+---
+
+Handled by the opencode-commit plugin.

package/opencode.example.json

@@ -1,17 +1,12 @@
-{
-  "$schema": "https://opencode.ai/config.json",
-  "plugin": [
-    [
-      "@andre-barbosa/opencode-commit",
-      {
-        "agent": "commit-writer",
-        "maxDiffChars": 12000
-      }
-    ]
-  ],
-  "agent": {
-    "commit-writer": {
-      "model": "opencode-go/deepseek-v4-flash"
-    }
-  }
-}
+{
+  "$schema": "https://opencode.ai/config.json",
+  "plugin": [
+    [
+      "@andre-barbosa/opencode-commit",
+      {
+        "model": "your-provider/your-model",
+        "maxDiffChars": 12000
+      }
+    ]
+  ]
+}

package/package.json

@@ -1,51 +1,50 @@
-{
-  "name": "@andre-barbosa/opencode-commit",
-  "version": "0.1.1",
-  "description": "OpenCode plugin that generates Conventional Commit messages via a dedicated sub-agent",
-  "type": "module",
-  "main": "src/index.ts",
-  "exports": {
-    ".": "./src/index.ts"
-  },
-  "files": [
-    "src",
-    "agents",
-    "commands",
-    "opencode.example.json",
-    "README.md",
-    "LICENSE"
-  ],
-  "scripts": {
-    "typecheck": "tsc --noEmit",
-    "prepublishOnly": "npm run typecheck"
-  },
-  "keywords": [
-    "opencode",
-    "opencode-plugin",
-    "git",
-    "commit",
-    "conventional-commits"
-  ],
-  "license": "MIT",
-  "repository": {
-    "type": "git",
-    "url": "https://github.com/AndreB10/opencode-commit.git"
-  },
-  "bugs": {
-    "url": "https://github.com/AndreB10/opencode-commit/issues"
-  },
-  "homepage": "https://github.com/AndreB10/opencode-commit#readme",
-  "publishConfig": {
-    "access": "public"
-  },
-  "dependencies": {
-    "@opencode-ai/plugin": "^1.3.3"
-  },
-  "devDependencies": {
-    "@opencode-ai/sdk": "^1.3.3",
-    "typescript": "^5.8.3"
-  },
-  "engines": {
-    "node": ">=18"
-  }
-}
+{
+  "name": "@andre-barbosa/opencode-commit",
+  "version": "0.1.3",
+  "description": "OpenCode plugin that generates Conventional Commit messages via /commit using a configured model",
+  "type": "module",
+  "main": "src/index.ts",
+  "exports": {
+    ".": "./src/index.ts"
+  },
+  "files": [
+    "src",
+    "commands",
+    "opencode.example.json",
+    "README.md",
+    "LICENSE"
+  ],
+  "scripts": {
+    "typecheck": "tsc --noEmit",
+    "prepublishOnly": "npm run typecheck"
+  },
+  "keywords": [
+    "opencode",
+    "opencode-plugin",
+    "git",
+    "commit",
+    "conventional-commits"
+  ],
+  "license": "MIT",
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/AndreB10/opencode-commit.git"
+  },
+  "bugs": {
+    "url": "https://github.com/AndreB10/opencode-commit/issues"
+  },
+  "homepage": "https://github.com/AndreB10/opencode-commit#readme",
+  "publishConfig": {
+    "access": "public"
+  },
+  "dependencies": {
+    "@opencode-ai/plugin": "^1.3.3"
+  },
+  "devDependencies": {
+    "@opencode-ai/sdk": "^1.3.3",
+    "typescript": "^5.8.3"
+  },
+  "engines": {
+    "node": ">=18"
+  }
+}

package/src/generate.ts

@@ -1,112 +1,89 @@
-import type { createOpencodeClient } from "@opencode-ai/sdk";
-import type { AgentInfo, ModelRef } from "./types.js";
-import { buildCommitPrompt, stripCodeFences } from "./prompt.js";
-import type { GitContext } from "./types.js";
-
-type Client = ReturnType<typeof createOpencodeClient>;
-
-function extractText(parts: Array<{ type?: string; text?: string }>): string {
-  return parts
-    .filter((part) => part.type === "text" && typeof part.text === "string")
-    .map((part) => part.text as string)
-    .join("")
-    .trim();
-}
-
-export function formatModelRef(model?: ModelRef): string {
-  if (!model) return "default";
-  return `${model.providerID}/${model.modelID}`;
-}
-
-export async function fetchAgent(
-  client: Client,
-  agentName: string,
-): Promise<AgentInfo | undefined> {
-  const { data, error } = await client.app.agents();
-  if (error || !Array.isArray(data)) return undefined;
-
-  const agent = data.find((entry) => entry.name === agentName);
-  if (!agent) return undefined;
-
-  return {
-    name: agent.name,
-    model: agent.model
-      ? {
-          providerID: agent.model.providerID,
-          modelID: agent.model.modelID,
-        }
-      : undefined,
-  };
-}
-
-async function createChildSession(
-  client: Client,
-  parentSessionID: string,
-): Promise<string> {
-  const { data: session, error } = await client.session.create({
-    body: {
-      title: "Commit message",
-      parentID: parentSessionID,
-    },
-  });
-
-  if (error || !session?.id) {
-    throw new Error(`Failed to create child session: ${String(error)}`);
-  }
-
-  return session.id;
-}
-
-export async function generateCommitMessage(input: {
-  client: Client;
-  parentSessionID: string;
-  agentName: string;
-  agent: AgentInfo;
-  context: GitContext;
-  userHint?: string;
-}): Promise<{ message: string; childSessionID: string; modelLabel: string }> {
-  const childSessionID = await createChildSession(
-    input.client,
-    input.parentSessionID,
-  );
-
-  const prompt = buildCommitPrompt(input.context, input.userHint);
-  const body: {
-    agent: string;
-    parts: Array<{ type: "text"; text: string }>;
-    model?: ModelRef;
-  } = {
-    agent: input.agentName,
-    parts: [{ type: "text", text: prompt }],
-  };
-
-  if (input.agent.model) {
-    body.model = input.agent.model;
-  }
-
-  const { data: result, error } = await input.client.session.prompt({
-    path: { id: childSessionID },
-    body,
-  });
-
-  if (error) {
-    throw new Error(`Sub-agent prompt failed: ${String(error)}`);
-  }
-
-  const parts =
-    (result as { parts?: Array<{ type?: string; text?: string }> } | undefined)
-      ?.parts ?? [];
-  const rawText = extractText(parts);
-
-  if (!rawText) {
-    throw new Error(
-      `Sub-agent returned no text. Child session: ${childSessionID}`,
-    );
-  }
-
-  return {
-    message: stripCodeFences(rawText),
-    childSessionID,
-    modelLabel: formatModelRef(input.agent.model),
-  };
-}
+import type { createOpencodeClient } from "@opencode-ai/sdk";
+import type { ModelRef } from "./types.js";
+import {
+  buildCommitPrompt,
+  COMMIT_SYSTEM_PROMPT,
+  stripCodeFences,
+} from "./prompt.js";
+import type { GitContext } from "./types.js";
+
+type Client = ReturnType<typeof createOpencodeClient>;
+const COMMIT_AGENT = "plan";
+
+function extractText(parts: Array<{ type?: string; text?: string }>): string {
+  return parts
+    .filter((part) => part.type === "text" && typeof part.text === "string")
+    .map((part) => part.text as string)
+    .join("")
+    .trim();
+}
+
+export function formatModelRef(model?: ModelRef): string {
+  if (!model) return "default";
+  return `${model.providerID}/${model.modelID}`;
+}
+
+async function createChildSession(
+  client: Client,
+  parentSessionID: string,
+): Promise<string> {
+  const { data: session, error } = await client.session.create({
+    body: {
+      title: "Commit message",
+      parentID: parentSessionID,
+    },
+  });
+
+  if (error || !session?.id) {
+    throw new Error(`Failed to create child session: ${String(error)}`);
+  }
+
+  return session.id;
+}
+
+export async function generateCommitMessage(input: {
+  client: Client;
+  parentSessionID: string;
+  model: ModelRef;
+  context: GitContext;
+  userHint?: string;
+}): Promise<{ message: string; childSessionID: string; modelLabel: string }> {
+  const childSessionID = await createChildSession(
+    input.client,
+    input.parentSessionID,
+  );
+
+  const prompt = buildCommitPrompt(input.context, input.userHint);
+  const body = {
+    agent: COMMIT_AGENT,
+    model: input.model,
+    system: COMMIT_SYSTEM_PROMPT,
+    parts: [{ type: "text" as const, text: prompt }],
+  };
+
+  const { data: result, error } = await input.client.session.prompt({
+    path: { id: childSessionID },
+    body,
+  });
+
+  if (error) {
+    throw new Error(`Commit prompt failed: ${String(error)}`);
+  }
+
+  const parts =
+    (result as { parts?: Array<{ type?: string; text?: string }> } | undefined)
+      ?.parts ?? [];
+  const rawText = extractText(parts);
+
+  if (!rawText) {
+    throw new Error(
+      `Commit model returned no text. Child session: ${childSessionID}`,
+    );
+  }
+
+  return {
+    message: stripCodeFences(rawText),
+    childSessionID,
+    modelLabel: formatModelRef(input.model),
+  };
+}