opencode-logger 0.2.2 → 0.3.0

package/README.md

@@ -26,12 +26,13 @@ and add:
 
 ## Configuration
 
-You can customize the log directory and filename using environment variables.
+You can customize the log directory, filename, and logging scope 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` |
+| `OPENCODE_LOGGER_SCOPE` | Comma-separated list of event types to log. Supports wildcards (e.g., `session.*`). | `*` (Log all events) |
 
 
 
@@ -52,5 +53,21 @@ export OPENCODE_LOGGER_DIR=/tmp/my-logs
 export OPENCODE_LOGGER_FILENAME=custom-name.jsonl
 ```
 
+### Logging Scope
+
+You can filter which events are logged using the `OPENCODE_LOGGER_SCOPE` environment variable.
+It accepts a comma-separated string of event types or patterns.
+
+- `*` (Default): Logs all events.
+- `session.*`: Logs all events starting with `session.` (e.g., `session.created`, `session.updated`).
+- `command.executed,file.edited`: Logs only these specific events.
+
+**Example:**
+
+```bash
+export OPENCODE_LOGGER_SCOPE="session.*,command.executed"
+```
+
+
 
 

package/dist/constants.d.ts

@@ -10,7 +10,7 @@ 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.
  */
-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"];
+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.asked", "permission.replied", "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.
  */

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,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"}
+{"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,uiBA4BnB,CAAC;AAEX;;GAEG;AACH,MAAM,MAAM,cAAc,GAAG,CAAC,OAAO,gBAAgB,CAAC,CAAC,MAAM,CAAC,CAAC"}

package/dist/constants.js

@@ -21,8 +21,8 @@ export const SUPPORTED_EVENTS = [
     "message.part.updated",
     "message.removed",
     "message.updated",
+    "permission.asked",
     "permission.replied",
-    "permission.updated",
     "server.connected",
     "session.created",
     "session.compacted",

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

@@ -1 +1 @@
-{"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"}
+{"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;IASV;;;;OAIG;IACG,GAAG,CAAC,SAAS,EAAE,MAAM,EAAE,OAAO,EAAE,OAAO;CAwB7C"}

package/dist/file-logger.js

@@ -40,29 +40,9 @@ export class FileLogger {
         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) {
-            await this.pluginInput.client.app.log({
-                body: {
-                    service: "opencode-logger",
-                    level: "error",
-                    message: "Failed to create log directory.",
-                    extra: {
-                        error,
-                    },
-                },
-            });
+            console.error(`[Opencode-logger]: Failed to initialize.\n${error}`);
         }
     }
     /**

package/dist/index.d.ts.map

@@ -1 +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,MAe1B,CAAC"}
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAS,MAAM,EAAE,MAAM,qBAAqB,CAAC;AAKzD;;;;;;GAMG;AACH,eAAO,MAAM,YAAY,EAAE,MAmB1B,CAAC"}

package/dist/index.js

@@ -1,5 +1,6 @@
 import { SUPPORTED_EVENTS } from "./constants.js";
 import { FileLogger } from "./file-logger.js";
+import { shouldLogEvent } from "./utils.js";
 /**
  * The main Opencode Logger plugin entry point.
  * Initializes the file logger and registers hooks for supported events.
@@ -13,7 +14,9 @@ export const loggerPlugin = async (ctx) => {
     console.log("[Opencode Logger] Plugin initialized!");
     const hooks = {
         event: async ({ event }) => {
-            if (SUPPORTED_EVENTS.includes(event.type)) {
+            if (SUPPORTED_EVENTS.includes(event.type) &&
+                // biome-ignore lint/complexity/useLiteralKeys: process.env access
+                shouldLogEvent(event.type, process.env["OPENCODE_LOGGER_SCOPE"])) {
                 await logger.log(event.type, event);
             }
         },

package/dist/utils.d.ts

@@ -0,0 +1,14 @@
+/**
+ * Determines if a specific event type should be logged based on the configured scope.
+ *
+ * The scope is a comma-separated string that can contain:
+ * 1. "*" to allow all events.
+ * 2. Specific event names (e.g., "session.created").
+ * 3. Group wildcards ending in ".*" (e.g., "session.*").
+ *
+ * @param eventType - The type of the event to check.
+ * @param scope - The configuration string defining allowed events.
+ * @returns True if the event should be logged, false otherwise.
+ */
+export declare function shouldLogEvent(eventType: string, scope?: string): boolean;
+//# sourceMappingURL=utils.d.ts.map

package/dist/utils.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"utils.d.ts","sourceRoot":"","sources":["../src/utils.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;GAWG;AACH,wBAAgB,cAAc,CAAC,SAAS,EAAE,MAAM,EAAE,KAAK,CAAC,EAAE,MAAM,GAAG,OAAO,CA0BzE"}

package/dist/utils.js

@@ -0,0 +1,34 @@
+/**
+ * Determines if a specific event type should be logged based on the configured scope.
+ *
+ * The scope is a comma-separated string that can contain:
+ * 1. "*" to allow all events.
+ * 2. Specific event names (e.g., "session.created").
+ * 3. Group wildcards ending in ".*" (e.g., "session.*").
+ *
+ * @param eventType - The type of the event to check.
+ * @param scope - The configuration string defining allowed events.
+ * @returns True if the event should be logged, false otherwise.
+ */
+export function shouldLogEvent(eventType, scope) {
+    if (!scope || scope === "*" || scope.trim() === "") {
+        return true;
+    }
+    const allowedPatterns = scope.split(",").map((s) => s.trim());
+    for (const pattern of allowedPatterns) {
+        if (pattern === "*") {
+            return true;
+        }
+        // Check for wildcard group (e.g., "session.*")
+        if (pattern.endsWith(".*")) {
+            const prefix = pattern.slice(0, -2);
+            if (eventType.startsWith(`${prefix}.`)) {
+                return true;
+            }
+        }
+        if (pattern === eventType) {
+            return true;
+        }
+    }
+    return false;
+}

package/package.json

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