opencode-commit-guard 1.0.0

package/index.ts

@@ -0,0 +1 @@
+export { default } from "./src/plugin.js"

package/package.json

@@ -0,0 +1,45 @@
+{
+  "name": "opencode-commit-guard",
+  "version": "1.0.0",
+  "description": "OpenCode V2 plugin enforcing git commit format rules",
+  "type": "module",
+  "main": "./dist/index.js",
+  "exports": {
+    ".": "./dist/index.js",
+    "./source": "./index.ts"
+  },
+  "files": [
+    "dist",
+    "index.ts",
+    "src"
+  ],
+  "scripts": {
+    "lint": "oxlint .",
+    "test": "bun test",
+    "typecheck": "tsc --noEmit",
+    "build": "bun build index.ts --outdir dist --target bun --format esm --external @opencode/plugin",
+    "prepack": "bun run build"
+  },
+  "dependencies": {
+    "@opencode/plugin": "2.0.2"
+  },
+  "devDependencies": {
+    "@oxlint/plugins": "1.80.0",
+    "@types/bun": "latest",
+    "oxlint": "1.80.0",
+    "typescript": "latest"
+  },
+  "engines": {
+    "bun": ">=1.2.0"
+  },
+  "license": "MIT",
+  "author": {
+    "name": "Omkar Chandorkar",
+    "email": "gotenksIN@aospa.co"
+  },
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/gotenksIN/opencode-commit-guard.git"
+  },
+  "homepage": "https://github.com/gotenksIN/opencode-commit-guard"
+}

package/src/config.ts

@@ -0,0 +1,80 @@
+import {
+  defaultConfig,
+  isJSONBoolean,
+  isJSONNumber,
+  isJSONString,
+  isRecord,
+} from "./types.js"
+import type { CommitGuardConfig, JsonValue } from "./types.js"
+
+export function parseConfig(options: JsonValue | undefined): CommitGuardConfig {
+  if (options === undefined) {
+    return defaultConfig
+  }
+
+  if (!isRecord(options)) {
+    throw new Error("Invalid plugin options; expected an object.")
+  }
+
+  const rawRequireScope = options["requireScope"]
+  let requireScope = defaultConfig.requireScope
+
+  if (rawRequireScope !== undefined) {
+    if (!isJSONBoolean(rawRequireScope)) {
+      throw new Error("Invalid plugin option requireScope; expected a boolean.")
+    }
+
+    requireScope = rawRequireScope
+  }
+
+  const rawAllowedScopes = options["allowedScopes"]
+  let allowedScopes: readonly string[] | undefined = defaultConfig.allowedScopes
+
+  if (rawAllowedScopes !== undefined) {
+    if (!Array.isArray(rawAllowedScopes)) {
+      throw new Error("Invalid plugin option allowedScopes; expected an array of non-empty strings.")
+    }
+
+    const scopes: string[] = []
+
+    for (const item of rawAllowedScopes) {
+      if (!isJSONString(item) || item.trim().length === 0) {
+        throw new Error("Invalid plugin option allowedScopes; expected an array of non-empty strings.")
+      }
+
+      scopes.push(item.trim())
+    }
+
+    allowedScopes = scopes.length > 0 ? scopes : undefined
+  }
+
+  const rawMaxLineLength = options["maxLineLength"]
+  let maxLineLength = defaultConfig.maxLineLength
+
+  if (rawMaxLineLength !== undefined) {
+    if (!isJSONNumber(rawMaxLineLength) || !Number.isSafeInteger(rawMaxLineLength) || rawMaxLineLength < 0) {
+      throw new Error("Invalid plugin option maxLineLength; expected an integer greater than or equal to 0.")
+    }
+
+    // SAFETY: isJSONNumber and Number.isSafeInteger verify rawMaxLineLength is an integer number.
+    maxLineLength = rawMaxLineLength as number
+  }
+
+  const rawRequireSignoff = options["requireSignoff"]
+  let requireSignoff = defaultConfig.requireSignoff
+
+  if (rawRequireSignoff !== undefined) {
+    if (!isJSONBoolean(rawRequireSignoff)) {
+      throw new Error("Invalid plugin option requireSignoff; expected a boolean.")
+    }
+
+    requireSignoff = rawRequireSignoff
+  }
+
+  return {
+    requireScope,
+    allowedScopes,
+    maxLineLength,
+    requireSignoff,
+  }
+}

package/src/plugin.ts

@@ -0,0 +1,50 @@
+import { Plugin } from "@opencode/plugin"
+import { parseConfig } from "./config.js"
+import { extractGitCommits } from "./shell.js"
+import { isJSONString, isRecord } from "./types.js"
+import type { JsonValue } from "./types.js"
+import { validateGitCommits } from "./validator.js"
+
+export const plugin = Plugin.define({
+  id: "opencode-commit-guard",
+  setup: async (ctx) => {
+    // SAFETY: OpenCode plugin options are passed through ctx.options as JsonValue or undefined.
+    const config = parseConfig(ctx.options as JsonValue | undefined)
+    const sessionDirectory = ctx.location.directory
+
+    await ctx.tool.hook("execute.before", async (event) => {
+      if (event.tool !== "shell" && event.tool !== "bash") {
+        return
+      }
+
+      // SAFETY: event.input is an unvalidated tool input payload from OpenCode runtime.
+      const rawInput = event.input as JsonValue | undefined
+
+      if (!isRecord(rawInput)) {
+        return
+      }
+
+      const command = rawInput["command"]
+
+      if (!isJSONString(command)) {
+        return
+      }
+
+      const invocations = extractGitCommits(command)
+
+      if (invocations.length === 0) {
+        return
+      }
+
+      const workdir = rawInput["workdir"]
+      validateGitCommits(
+        invocations,
+        config,
+        command,
+        isJSONString(workdir) ? workdir : sessionDirectory,
+      )
+    })
+  },
+})
+
+export default plugin