feat: migrate to new event system (v1.0.223) and improve stability #10

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open

ramarivera wants to merge 38 commits into mohak34:main from ramarivera:fix/permission-asked-session-status__v1.0.223

README.md

-Original file line number
+Diff line change
@@ Expand Up @@
     ## Configuration
-    To customize the plugin, create `~/.config/opencode/opencode-notifier.json`:
+    To customize the plugin, create `~/.config/opencode/opencode-notifier.json`. The file supports standard JSON and JSON with comments (JSONC).
     ```json
     {
@@ Expand Down Expand Up / @@ -124,6 +124,47 @@ Use your own sound files: @@
     If a custom sound file path is provided but the file doesn't exist, the plugin will fall back to the bundled sound.
+    ## Debugging
+    To enable debug logging and see which events are being received:
+    ```bash
+    export OPENCODE_NOTIFIER_DEBUG=true
+    opencode
+    ```
+    This will create `.opencode_notifier_logs.jsonl` in your current directory with detailed logs:
+    - Plugin initialization with full config
+    - Every event received
+    - Each notification/sound triggered with config values
+    **Example log output**:
+    ```jsonl
+    {"timestamp":"2026-01-03T19:30:00.000Z","action":"pluginInit","configLoaded":true,"config":{"events":{"permission":{"sound":true,"notification":true},...}}}
+    {"timestamp":"2026-01-03T19:30:05.000Z","action":"eventReceived","eventType":"session.status",...}
+    {"timestamp":"2026-01-03T19:30:05.001Z","action":"handleEvent","eventType":"complete","message":"OpenCode has finished","sessionTitle":"My Project",...}
+    ```
+    **Note**: Logging only occurs when `OPENCODE_NOTIFIER_DEBUG=true`. No log file is created in normal use.
+    ## Technical Notes
+    ### Event System Migration (v0.1.8+)
+    Version 0.1.8 migrates to OpenCode's new event system:
+    | Event Type | Old Event (deprecated) | New Event (v0.1.8+) |
+    |------------|------------------------|---------------------|
+    | Permission requests | `permission.updated` | `permission.asked` |
+    | Session completion | `session.idle` | `session.status` (with `type: "idle"`) |
+    | Errors | `session.error` | `session.error` (unchanged) |
+    **Why this matters**: The old events (`permission.updated`, `session.idle`) are deprecated in OpenCode core and may not fire reliably. If you're experiencing notification issues, ensure you're using v0.1.8 or later.
+    **Source verification**: Event structure documented from OpenCode core:
+    - `permission.asked`: `packages/opencode/src/permission/next.ts`
+    - `session.status`: `packages/opencode/src/session/status.ts`
     ## License
     MIT

__mocks__/confbox.ts

-Original file line number
+Diff line change
@@ -0,0 +1,17 @@
+    export function parseJSONC(content: string): unknown {
+      // Simple JSONC parser for tests - strips comments and parses JSON
+      const stripped = content
+        .replace(/\/\*[\s\S]*?\*\//g, '') // Remove block comments
+        .replace(/\/\/.*$/gm, '')          // Remove line comments
+        .replace(/,(\s*[}\]])/g, '$1');    // Remove trailing commas
+      try {
+        return JSON.parse(stripped);
+      } catch {
+        return {};
+      }
+    }
+    export function stringifyJSONC(value: unknown): string {
+      return JSON.stringify(value, null, 2);
+    }

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

feat: migrate to new event system (v1.0.223) and improve stability #10

Uh oh!

Diff view

Diff view

There are no files selected for viewing

Uh oh!

feat: migrate to new event system (v1.0.223) and improve stability #10

Are you sure you want to change the base?

Uh oh!

feat: migrate to new event system (v1.0.223) and improve stability #10

Uh oh!

Uh oh!

Diff view

Diff view

There are no files selected for viewing

Uh oh!