opencode-logger 0.1.0

package/README.md

@@ -0,0 +1,27 @@
+# opencode-logger
+
+This small package is intended to be used as [Opencode](https://opencode.ai) plugin.
+
+See [plugins documentation](https://opencode.ai/docs/plugins/).
+
+This plugin handles logging of all supported [events](https://opencode.ai/docs/plugins/#events).
+
+Events are logged as [jsonl](https://jsonlines.org/) to the
+
+```bash
+<project-root>/logs/opencode/log.jsonl
+```
+
+## Usage
+
+In your project open (or set) your `opencode.json` or `opencode.jsonc` file
+and add:
+
+```jsonc
+{
+  "$schema": "https://opencode.ai/config.json",
+  "plugin": ["opencode-logger"]
+}
+```
+
+

package/bunfig.toml

@@ -0,0 +1,3 @@
+[test]
+
+root = "./src/__tests__"

package/dist/constants.d.ts

@@ -0,0 +1,18 @@
+/**
+ * Directory where logs will be stored relative to the project root.
+ */
+export declare const LOG_DIRECTORY = "logs/opencode";
+/**
+ * Filename for the log file.
+ */
+export declare const LOG_FILENAME = "log.jsonl";
+/**
+ * List of event types supported by the logger plugin.
+ * These events correspond to various lifecycle hooks and actions within the Opencode environment.
+ */
+export declare const SUPPORTED_EVENTS: readonly ["command.executed", "file.edited", "file.watcher.updated", "installation.updated", "lsp.client.diagnostics", "lsp.updated", "message.part.removed", "message.part.updated", "message.removed", "message.updated", "permission.replied", "permission.updated", "server.connected", "session.created", "session.compacted", "session.deleted", "session.diff", "session.error", "session.idle", "session.status", "session.updated", "todo.updated", "tool.execute.after", "tool.execute.before", "tui.prompt.append", "tui.command.execute", "tui.toast.show"];
+/**
+ * Type definition derived from the supported events constant.
+ */
+export type SupportedEvent = (typeof SUPPORTED_EVENTS)[number];
+//# sourceMappingURL=constants.d.ts.map

package/dist/constants.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"constants.d.ts","sourceRoot":"","sources":["../src/constants.ts"],"names":[],"mappings":"AAAA;;GAEG;AACH,eAAO,MAAM,aAAa,kBAAkB,CAAC;AAE7C;;GAEG;AACH,eAAO,MAAM,YAAY,cAAc,CAAC;AAExC;;;GAGG;AACH,eAAO,MAAM,gBAAgB,yiBA4BnB,CAAC;AAEX;;GAEG;AACH,MAAM,MAAM,cAAc,GAAG,CAAC,OAAO,gBAAgB,CAAC,CAAC,MAAM,CAAC,CAAC"}

package/dist/constants.js

@@ -0,0 +1,41 @@
+/**
+ * Directory where logs will be stored relative to the project root.
+ */
+export const LOG_DIRECTORY = "logs/opencode";
+/**
+ * Filename for the log file.
+ */
+export const LOG_FILENAME = "log.jsonl";
+/**
+ * List of event types supported by the logger plugin.
+ * These events correspond to various lifecycle hooks and actions within the Opencode environment.
+ */
+export const SUPPORTED_EVENTS = [
+    "command.executed",
+    "file.edited",
+    "file.watcher.updated",
+    "installation.updated",
+    "lsp.client.diagnostics",
+    "lsp.updated",
+    "message.part.removed",
+    "message.part.updated",
+    "message.removed",
+    "message.updated",
+    "permission.replied",
+    "permission.updated",
+    "server.connected",
+    "session.created",
+    "session.compacted",
+    "session.deleted",
+    "session.diff",
+    "session.error",
+    "session.idle",
+    "session.status",
+    "session.updated",
+    "todo.updated",
+    "tool.execute.after",
+    "tool.execute.before",
+    "tui.prompt.append",
+    "tui.command.execute",
+    "tui.toast.show",
+];

package/dist/file-logger.d.ts

@@ -0,0 +1,34 @@
+/**
+ * Interface representing a single log entry in the log file.
+ */
+export interface LogEntry {
+    /** ISO 8601 timestamp of when the event occurred. */
+    timestamp: string;
+    /** The type of event being logged (e.g., "session.created", "tool.execute.before"). */
+    eventType: string;
+    /** The data payload associated with the event. */
+    payload: unknown;
+}
+/**
+ * Handles initialization of the log directory and writing log entries to the file system.
+ */
+export declare class FileLogger {
+    private logFilePath;
+    /**
+     * Creates a new instance of FileLogger.
+     * @param projectRoot - The absolute path to the root of the project.
+     */
+    constructor(projectRoot: string);
+    /**
+     * Initializes the logger by ensuring the log directory exists.
+     * This method should be called before attempting to log any events.
+     */
+    init(): Promise<void>;
+    /**
+     * Logs an event and its payload to the log file in JSONL format.
+     * @param eventType - The type of event to log.
+     * @param payload - The data associated with the event.
+     */
+    log(eventType: string, payload: unknown): Promise<void>;
+}
+//# sourceMappingURL=file-logger.d.ts.map

package/dist/file-logger.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"file-logger.d.ts","sourceRoot":"","sources":["../src/file-logger.ts"],"names":[],"mappings":"AAIA;;GAEG;AACH,MAAM,WAAW,QAAQ;IACxB,qDAAqD;IACrD,SAAS,EAAE,MAAM,CAAC;IAClB,uFAAuF;IACvF,SAAS,EAAE,MAAM,CAAC;IAClB,kDAAkD;IAClD,OAAO,EAAE,OAAO,CAAC;CACjB;AAED;;GAEG;AACH,qBAAa,UAAU;IACtB,OAAO,CAAC,WAAW,CAAS;IAE5B;;;OAGG;gBACS,WAAW,EAAE,MAAM;IAI/B;;;OAGG;IACG,IAAI;IAWV;;;;OAIG;IACG,GAAG,CAAC,SAAS,EAAE,MAAM,EAAE,OAAO,EAAE,OAAO;CAe7C"}

package/dist/file-logger.js

@@ -0,0 +1,48 @@
+import { appendFile, mkdir } from "node:fs/promises";
+import { join } from "node:path";
+import { LOG_DIRECTORY, LOG_FILENAME } from "./constants.js";
+/**
+ * Handles initialization of the log directory and writing log entries to the file system.
+ */
+export class FileLogger {
+    logFilePath;
+    /**
+     * Creates a new instance of FileLogger.
+     * @param projectRoot - The absolute path to the root of the project.
+     */
+    constructor(projectRoot) {
+        this.logFilePath = join(projectRoot, LOG_DIRECTORY, LOG_FILENAME);
+    }
+    /**
+     * Initializes the logger by ensuring the log directory exists.
+     * This method should be called before attempting to log any events.
+     */
+    async init() {
+        try {
+            const dirPath = join(this.logFilePath, "..");
+            await mkdir(dirPath, { recursive: true });
+        }
+        catch (error) {
+            console.error(`[Opencode Logger] Failed to create log directory: ${error}`);
+        }
+    }
+    /**
+     * Logs an event and its payload to the log file in JSONL format.
+     * @param eventType - The type of event to log.
+     * @param payload - The data associated with the event.
+     */
+    async log(eventType, payload) {
+        const entry = {
+            timestamp: new Date().toISOString(),
+            eventType,
+            payload,
+        };
+        const line = `${JSON.stringify(entry)}\n`;
+        try {
+            await appendFile(this.logFilePath, line, "utf-8");
+        }
+        catch (error) {
+            console.error(`[Opencode Logger] Failed to write to log file: ${error}`);
+        }
+    }
+}

package/dist/index.d.ts

@@ -0,0 +1,10 @@
+import type { Plugin } from "@opencode-ai/plugin";
+/**
+ * The main Opencode Logger plugin entry point.
+ * Initializes the file logger and registers hooks for supported events.
+ *
+ * @param ctx - The plugin context provided by Opencode, containing project details.
+ * @returns A promise that resolves to the plugin hooks configuration.
+ */
+export declare const loggerPlugin: Plugin;
+//# sourceMappingURL=index.d.ts.map

package/dist/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,MAAM,EAAS,MAAM,qBAAqB,CAAC;AAIzD;;;;;;GAMG;AACH,eAAO,MAAM,YAAY,EAAE,MAwB1B,CAAC"}

package/dist/index.js

@@ -0,0 +1,31 @@
+import { SUPPORTED_EVENTS } from "./constants.js";
+import { FileLogger } from "./file-logger.js";
+/**
+ * The main Opencode Logger plugin entry point.
+ * Initializes the file logger and registers hooks for supported events.
+ *
+ * @param ctx - The plugin context provided by Opencode, containing project details.
+ * @returns A promise that resolves to the plugin hooks configuration.
+ */
+export const loggerPlugin = async (ctx) => {
+    // ctx.directory is the project root in the context of the running plugin usually,
+    // but let's be safe and check if we need to resolve it.
+    // Based on the docs: directory: The current working directory.
+    const logger = new FileLogger(ctx.directory);
+    await logger.init();
+    console.log("Opencode Logger Plugin initialized!");
+    const hooks = {
+        event: async ({ event }) => {
+            if (SUPPORTED_EVENTS.includes(event.type)) {
+                await logger.log(event.type, event);
+            }
+        },
+        "tool.execute.before": async (input, output) => {
+            await logger.log("tool.execute.before", { input, output });
+        },
+        "tool.execute.after": async (input, output) => {
+            await logger.log("tool.execute.after", { input, output });
+        },
+    };
+    return hooks;
+};

package/package.json

@@ -0,0 +1,36 @@
+{
+	"name": "opencode-logger",
+	"main": "dist/index.js",
+	"types": "dist/index.d.ts",
+  "version": "0.1.0",
+	"devDependencies": {
+		"@biomejs/biome": "2.3.11",
+		"@types/bun": "latest",
+		"husky": "^9.1.7",
+		"lint-staged": "^16.2.7"
+	},
+	"peerDependencies": {
+		"typescript": "^5"
+	},
+	"private": false,
+	"scripts": {
+		"build-dist": "bunx tsc",
+		"lint": "bunx biome lint --write ./src",
+		"format": "bunx biome format --write",
+		"forlint": "bun lint && bun format",
+		"typecheck": "tsc --noEmit --pretty",
+		"prepare": "husky"
+	},
+	"type": "module",
+	"lint-staged": {
+		"*.{js, ts}": [
+			"bun forlint"
+		],
+		"*.{ts,json}": [
+			"bun format"
+		]
+	},
+	"dependencies": {
+		"@opencode-ai/plugin": "^1.1.25"
+	}
+}

package/tsconfig.json

@@ -0,0 +1,30 @@
+{
+	"compilerOptions": {
+		"lib": ["ESNext"],
+		"target": "ESNext",
+		"module": "NodeNext",
+		"moduleDetection": "auto",
+		"moduleResolution": "nodenext",
+		"verbatimModuleSyntax": true,
+
+		"strict": true,
+		"skipLibCheck": true,
+		"noFallthroughCasesInSwitch": true,
+		"noUncheckedIndexedAccess": true,
+		"noImplicitOverride": true,
+
+		"noUnusedLocals": true,
+		"noUnusedParameters": true,
+		"noPropertyAccessFromIndexSignature": true,
+
+		"outDir": "./dist",
+    "rootDir": "./src",
+    "baseUrl": ".",
+		"paths": {
+			"@/*": ["src/*"]
+		},
+    "declaration": true,
+    "declarationMap": true
+	},
+	"include": ["src/**/*.ts"]
+}