@vasilvestre/opencode-plain-style 1.0.0 → 1.1.0

package/.opencode/plugins/plain-style.js

@@ -0,0 +1,46 @@
+// plain-style — OpenCode plugin, supports opencode v1.x and v2.x.
+//
+// Injects the plain-language rulebook (plain-style.md, beside this file) into
+// every chat's system prompt on every agent-loop LLM request, primary agent
+// and subagents alike.
+//
+// The default export is one object with both entrypoints (v2 migration guide:
+// https://opencode.ai/v2/docs/build/plugins/migrate-v1):
+// - v2 calls setup() and registers a "context" session hook; system parts are
+//   objects ({ type: "text", text }) there.
+// - v1 (object entrypoints need opencode >= 1.18.29) calls server() and gets
+//   the experimental.chat.system.transform hook; system entries there are
+//   plain strings. The hook must mutate output.system in place (push), because v1
+//   ignores a reassignment of output.system.
+//
+// Auto-discovered from .opencode/plugins/ in both versions, so no
+// opencode.json entry is needed. To register it by hand instead:
+// { "plugin": ["./.opencode/plugins/plain-style.js"] }  (opencode v1)
+// { "plugins": ["./.opencode/plugins/plain-style.js"] } (opencode v2)
+
+import fs from 'fs';
+import path from 'path';
+import { fileURLToPath } from 'url';
+
+// Read once at load; a missing file throws here so startup fails loud instead
+// of silently injecting nothing.
+const rulebook = fs.readFileSync(
+  path.join(path.dirname(fileURLToPath(import.meta.url)), 'plain-style.md'),
+  'utf8',
+);
+
+export default {
+  id: 'vasilvestre.opencode-plain-style',
+  async setup(ctx) {
+    await ctx.session.hook('context', (event) => {
+      event.system.push({ type: 'text', text: rulebook });
+    });
+  },
+  async server() {
+    return {
+      'experimental.chat.system.transform': async (_input, output) => {
+        output.system.push(rulebook);
+      },
+    };
+  },
+};

package/README.md

@@ -90,7 +90,13 @@ Rules state what to do, not what to avoid by name.
 ### Steps
 
 1. Open `~/.config/opencode/opencode.json`.
-2. Add the package name to the `plugin` array:
+2. Add the package name to the plugin array. opencode v2 uses the `plugins` key, opencode v1 uses `plugin`:
+
+   ```json
+   {
+     "plugins": ["@vasilvestre/opencode-plain-style"]
+   }
+   ```
 
    ```json
    {
@@ -119,28 +125,32 @@ Use this to test changes before publishing, or to run a fork.
 
    ```json
    {
-     "plugin": ["file:///absolute/path/to/opencode-plain-style/.opencode/plugins/plain-style.mjs"]
+     "plugins": ["file:///absolute/path/to/opencode-plain-style/.opencode/plugins/plain-style.js"]
    }
    ```
 
-   The path must be absolute and must point at the `.mjs` file, not the directory.
+   opencode v1 uses the same URL under the `plugin` key. The path must be absolute and must point at the `.js` file, not the directory.
 
 3. Restart opencode.
 
 ### Uninstall
 
-1. Remove the entry from the `plugin` array in `~/.config/opencode/opencode.json`.
+1. Remove the entry from the plugin array (`plugins` in opencode v2, `plugin` in v1) in `~/.config/opencode/opencode.json`.
 2. Restart opencode.
 
 ## How it works
 
-The plugin registers one hook: `experimental.chat.system.transform`.
-On each request it pushes the rulebook text into the system prompt array.
+The plugin exports one object with two entrypoints; opencode picks the one matching its version:
+
+- opencode v1 calls `server()`. It hooks `experimental.chat.system.transform` and pushes the rulebook text (a string) into the system prompt array on each request.
+- opencode v2 calls `setup()`. It registers a `context` session hook and appends a `{ type: "text" }` part to the system prompt.
+
 The rulebook is read from disk once at module load, so each request costs one array push and zero I/O.
-Total plugin code: about 25 lines, no dependencies.
+The plugin has no dependencies.
 
-Note: the hook is marked experimental in opencode.
-If opencode renames it, the plugin fails loudly at startup rather than injecting nothing.
+In opencode v1 the hook must mutate `output.system` in place: a reassignment is silently ignored.
+
+Note: v1 support needs opencode 1.18.29 or later (object-style plugin entrypoints).
 
 ## Example output
 
@@ -205,10 +215,12 @@ Fork the repo, edit the file, and point your config at the local copy:
 
 ```json
 {
-  "plugin": ["file:///path/to/your/fork/.opencode/plugins/plain-style.mjs"]
+  "plugins": ["file:///path/to/your/fork/.opencode/plugins/plain-style.js"]
 }
 ```
 
+opencode v1 uses the `plugin` key instead.
+
 ## Development
 
 The `bench/` directory holds the full benchmark suite: harness, scorer, aggregator, raw results.

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@vasilvestre/opencode-plain-style",
-  "version": "1.0.0",
+  "version": "1.1.0",
   "description": "Plain-language writing rules for opencode agents, injected into every system prompt. Enforces ISO 24495-1 principles on commits, comments, docs, and chat prose.",
   "keywords": [
     "opencode-plugin",
@@ -23,10 +23,10 @@
     "url": "https://github.com/vasilvestre/opencode-plain-style/issues"
   },
   "type": "module",
-  "main": "./.opencode/plugins/plain-style.mjs",
+  "main": "./.opencode/plugins/plain-style.js",
   "exports": {
-    ".": "./.opencode/plugins/plain-style.mjs",
-    "./plugin": "./.opencode/plugins/plain-style.mjs"
+    ".": "./.opencode/plugins/plain-style.js",
+    "./plugin": "./.opencode/plugins/plain-style.js"
   },
   "scripts": {
     "test": "node scripts/check-plugin.mjs"

package/.opencode/plugins/plain-style.mjs

@@ -1,25 +0,0 @@
-// plain-style — OpenCode plugin.
-//
-// Injects the plain-language rulebook (plain-style.md, beside this file) into
-// every chat's system prompt on every LLM request — primary agent and
-// subagents alike — so the rules survive context compaction. Pattern cloned
-// from the ponytail plugin (experimental.chat.system.transform).
-//
-// Registered in opencode.jsonc: { "plugin": [..., "./plugins/plain-style.mjs"] }
-
-import fs from 'fs';
-import path from 'path';
-import { fileURLToPath } from 'url';
-
-// Read once at load; a missing file throws here so startup fails loud instead
-// of silently injecting nothing.
-const rulebook = fs.readFileSync(
-  path.join(path.dirname(fileURLToPath(import.meta.url)), 'plain-style.md'),
-  'utf8',
-);
-
-export default async () => ({
-  'experimental.chat.system.transform': async (_input, output) => {
-    output.system.push(rulebook);
-  },
-});