opencode-effect-enforcer 0.2.1 → 0.2.3

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (2) hide show
  1. package/README.md +29 -9
  2. package/package.json +1 -1
package/README.md CHANGED
@@ -21,7 +21,7 @@ That is the complete installation. OpenCode resolves published package entries
21
21
  for you; there is no separate `npm install` step. Use the global config at
22
22
  `~/.config/opencode/opencode.jsonc` to enable it everywhere, or a project config
23
23
  to enable it only for that project. You can also pin a release, for example
24
- `"opencode-effect-enforcer@0.2.1"`.
24
+ `"opencode-effect-enforcer@0.2.3"`.
25
25
 
26
26
  Start a new OpenCode session, then verify the plugin if needed:
27
27
 
@@ -29,6 +29,32 @@ Start a new OpenCode session, then verify the plugin if needed:
29
29
  opencode2 api get /api/plugin
30
30
  ```
31
31
 
32
+ ### Local Checkout
33
+
34
+ When loading this repository directly, configure its `src` directory:
35
+
36
+ ```jsonc
37
+ {
38
+ "$schema": "https://opencode.ai/config.json",
39
+ "plugins": ["/absolute/path/opencode-effect-enforcer/src"],
40
+ }
41
+ ```
42
+
43
+ OpenCode `v0.0.0-beta-19157` resolves local directories by looking for `server`
44
+ or `index` directly inside them, rather than using `package.json` exports.
45
+ Pointing at the repository root silently skips the plugin; pointing at the
46
+ `src/index.ts` file is rejected because configured local paths must be directories.
47
+
48
+ Verify activation for the session's actual working directory, replacing the
49
+ example path below:
50
+
51
+ ```sh
52
+ opencode2 api post '/api/plugin/await-activation?location[directory]=/path/to/project'
53
+ opencode2 api get '/api/plugin?location[directory]=/path/to/project'
54
+ ```
55
+
56
+ Look for `opencode.effect-enforcer` with `state.status` set to `active`.
57
+
32
58
  ## What You Get
33
59
 
34
60
  - **54 focused skills** registered in OpenCode's native skill catalog, covering
@@ -55,8 +81,7 @@ available.
55
81
  - [Effect, and the Near-Inexpressible Majesty of Layers](guidance/post__effect-and-the-near-inexpressible-majesty-of-layers.md): Explains services, Layers, typed dependencies, and testable implementations.
56
82
  - [Parse, don't validate](guidance/post__parse-dont-validate.md): Shows how refined types preserve validation knowledge and make illegal states unrepresentable.
57
83
 
58
- <details>
59
- <summary><strong>Skills (54)</strong></summary>
84
+ ### Skills (54)
60
85
 
61
86
  #### Modeling And Core APIs
62
87
 
@@ -133,10 +158,7 @@ available.
133
158
  - [`effect-concurrency-testing`](skills/effect-concurrency-testing/SKILL.md): Test fibers, PubSub, Deferred, Latch, SubscriptionRef, and concurrent streams.
134
159
  - [`effect-incremental-migration`](skills/effect-incremental-migration/SKILL.md): Migrate Promise-based modules incrementally while preserving required compatibility.
135
160
 
136
- </details>
137
-
138
- <details>
139
- <summary><strong>Patterns (46)</strong></summary>
161
+ ### Patterns (46)
140
162
 
141
163
  #### Types, Modeling, And Collections
142
164
 
@@ -199,8 +221,6 @@ available.
199
221
  - [`vm-in-wrong-file`](patterns/vm-in-wrong-file.md): Enforces dedicated `.vm.ts` files for View Model definitions.
200
222
  - [`avoid-expect-in-if`](patterns/avoid-expect-in-if.md): Prevents conditional assertions that allow tests to pass without checking behavior.
201
223
 
202
- </details>
203
-
204
224
  ## Per-Agent Opt-Out
205
225
 
206
226
  Set `opencode-effect-enforcer: false` in an agent's `request.body` when that
package/package.json CHANGED
@@ -1,7 +1,7 @@
1
1
  {
2
2
  "$schema": "https://www.schemastore.org/package.json",
3
3
  "name": "opencode-effect-enforcer",
4
- "version": "0.2.1",
4
+ "version": "0.2.3",
5
5
  "description": "OpenCode V2 plugin for Effect v4 skills, guidance, and pattern enforcement",
6
6
  "keywords": [
7
7
  "opencode",