opencode-logger 0.1.4 → 0.2.1

package/README.md

@@ -24,4 +24,33 @@ and add:
 }
 ```
 
+## Configuration
+
+You can customize the log directory and filename using environment variables.
+
+| Variable | Description | Default |
+|----------|-------------|---------|
+| `OPENCODE_LOGGER_DIR` | The directory where logs are stored. Can be absolute or relative to project root. | `logs/opencode` |
+| `OPENCODE_LOGGER_FILENAME` | The filename for the log file. | `log.jsonl` |
+
+
+
+### Setting via CLI
+
+You can set them when starting the Opencode client:
+
+```bash
+OPENCODE_LOGGER_DIR=/tmp/my-logs opencode
+```
+
+### Setting by exporting ENV variables
+
+Or export them, for example in your `~/.bashrc`
+
+```bash
+export OPENCODE_LOGGER_DIR=/tmp/my-logs
+export OPENCODE_LOGGER_FILENAME=custom-name.jsonl
+```
+
+
 

package/dist/constants.d.ts

@@ -1,11 +1,11 @@
 /**
  * Directory where logs will be stored relative to the project root.
  */
-export declare const LOG_DIRECTORY = "logs/opencode";
+export declare const DEFAULT_LOG_DIRECTORY = "logs/opencode";
 /**
  * Filename for the log file.
  */
-export declare const LOG_FILENAME = "log.jsonl";
+export declare const DEFAULT_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.

package/dist/constants.d.ts.map

@@ -1 +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"}
+{"version":3,"file":"constants.d.ts","sourceRoot":"","sources":["../src/constants.ts"],"names":[],"mappings":"AAAA;;GAEG;AACH,eAAO,MAAM,qBAAqB,kBAAkB,CAAC;AAErD;;GAEG;AACH,eAAO,MAAM,oBAAoB,cAAc,CAAC;AAEhD;;;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

@@ -1,11 +1,11 @@
 /**
  * Directory where logs will be stored relative to the project root.
  */
-export const LOG_DIRECTORY = "logs/opencode";
+export const DEFAULT_LOG_DIRECTORY = "logs/opencode";
 /**
  * Filename for the log file.
  */
-export const LOG_FILENAME = "log.jsonl";
+export const DEFAULT_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.

package/dist/file-logger.d.ts

@@ -1,3 +1,4 @@
+import type { PluginInput } from "@opencode-ai/plugin";
 /**
  * Interface representing a single log entry in the log file.
  */
@@ -14,14 +15,18 @@ export interface LogEntry {
  */
 export declare class FileLogger {
     private logFilePath;
+    private pluginInput;
     /**
      * Creates a new instance of FileLogger.
      * @param projectRoot - The absolute path to the root of the project.
+     * @param pluginInput - Opencode plugin input
      */
-    constructor(projectRoot: string);
+    constructor(projectRoot: string, pluginInput: PluginInput);
+    private resolveLogDirectory;
+    private getLogFilename;
     /**
      * Initializes the logger by ensuring the log directory exists.
-     * This method should be called before attempting to log any events.
+     * This method must be called before attempting to log any events.
      */
     init(): Promise<void>;
     /**

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

@@ -1 +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"}
+{"version":3,"file":"file-logger.d.ts","sourceRoot":"","sources":["../src/file-logger.ts"],"names":[],"mappings":"AAEA,OAAO,KAAK,EAAE,WAAW,EAAE,MAAM,qBAAqB,CAAC;AAGvD;;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;IAC5B,OAAO,CAAC,WAAW,CAAc;IAEjC;;;;OAIG;gBACS,WAAW,EAAE,MAAM,EAAE,WAAW,EAAE,WAAW;IAQzD,OAAO,CAAC,mBAAmB;IAY3B,OAAO,CAAC,cAAc;IAKtB;;;OAGG;IACG,IAAI;IA8BV;;;;OAIG;IACG,GAAG,CAAC,SAAS,EAAE,MAAM,EAAE,OAAO,EAAE,OAAO;CAwB7C"}

package/dist/file-logger.js

@@ -1,29 +1,68 @@
 import { appendFile, mkdir } from "node:fs/promises";
-import { join } from "node:path";
-import { LOG_DIRECTORY, LOG_FILENAME } from "./constants.js";
+import { isAbsolute, join, resolve } from "node:path";
+import { DEFAULT_LOG_DIRECTORY, DEFAULT_LOG_FILENAME } from "./constants.js";
 /**
  * Handles initialization of the log directory and writing log entries to the file system.
  */
 export class FileLogger {
     logFilePath;
+    pluginInput;
     /**
      * Creates a new instance of FileLogger.
      * @param projectRoot - The absolute path to the root of the project.
+     * @param pluginInput - Opencode plugin input
      */
-    constructor(projectRoot) {
-        this.logFilePath = join(projectRoot, LOG_DIRECTORY, LOG_FILENAME);
+    constructor(projectRoot, pluginInput) {
+        const logDir = this.resolveLogDirectory(projectRoot);
+        const logFilename = this.getLogFilename();
+        this.logFilePath = join(logDir, logFilename);
+        this.pluginInput = pluginInput;
+    }
+    resolveLogDirectory(projectRoot) {
+        const logDir = 
+        // biome-ignore lint/complexity/useLiteralKeys: process.env access
+        process.env["OPENCODE_LOGGER_DIR"] ||
+            join(projectRoot, DEFAULT_LOG_DIRECTORY);
+        // If logDir is absolute, use it directly. Otherwise, resolve it relative to projectRoot
+        // Note: The default join(projectRoot, DEFAULT_LOG_DIRECTORY) above already handles the relative default case,
+        // but we check isAbsolute here specifically for the ENV var case if the user passed a relative path.
+        return isAbsolute(logDir) ? logDir : resolve(projectRoot, logDir);
+    }
+    getLogFilename() {
+        // biome-ignore lint/complexity/useLiteralKeys: process.env access
+        return process.env["OPENCODE_LOGGER_FILENAME"] || DEFAULT_LOG_FILENAME;
     }
     /**
      * Initializes the logger by ensuring the log directory exists.
-     * This method should be called before attempting to log any events.
+     * This method must be called before attempting to log any events.
      */
     async init() {
         try {
             const dirPath = join(this.logFilePath, "..");
             await mkdir(dirPath, { recursive: true });
+            // NOTE: this opencode log call causes
+            // the application to hang on start.
+            // Did not see anything in the internal logs,
+            // so this is disabled for the moment
+            /* await this.pluginInput.client.app.log({
+                body: {
+                    service: "opencode-logger",
+                    level: "info",
+                    message: "Plugin initialized!",
+                },
+            }); */
         }
         catch (error) {
-            console.error(`[Opencode Logger] Failed to create log directory: ${error}`);
+            await this.pluginInput.client.app.log({
+                body: {
+                    service: "opencode-logger",
+                    level: "error",
+                    message: "Failed to create log directory.",
+                    extra: {
+                        error,
+                    },
+                },
+            });
         }
     }
     /**
@@ -42,7 +81,16 @@ export class FileLogger {
             await appendFile(this.logFilePath, line, "utf-8");
         }
         catch (error) {
-            console.error(`[Opencode Logger] Failed to write to log file: ${error}`);
+            await this.pluginInput.client.app.log({
+                body: {
+                    service: "opencode-logger",
+                    level: "error",
+                    message: "Failed to write to log file.",
+                    extra: {
+                        error,
+                    },
+                },
+            });
         }
     }
 }

package/dist/index.js

@@ -11,7 +11,7 @@ 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);
+    const logger = new FileLogger(ctx.directory, ctx);
     await logger.init();
     console.log("[Opencode Logger] Plugin initialized!");
     const hooks = {

package/package.json

@@ -2,7 +2,7 @@
 	"name": "opencode-logger",
 	"main": "dist/index.js",
 	"types": "dist/index.d.ts",
-	"version": "0.1.4",
+	"version": "0.2.1",
 	"repository": {
 		"url": "https://github.com/radekBednarik/opencode-logger.git"
 	},