opencode-memoir 1.0.0 → 1.0.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.

Potentially problematic release.


This version of opencode-memoir might be problematic. Click here for more details.

Files changed (2) hide show
  1. package/README.md +12 -35
  2. package/package.json +1 -1
package/README.md CHANGED
@@ -6,25 +6,7 @@ The OpenCode counterpart to the Claude Code and Codex Memoir plugins. Derives a
6
6
 
7
7
  ## Install
8
8
 
9
- Add to your OpenCode config (`~/.config/opencode/opencode.jsonc`):
10
-
11
- ```jsonc
12
- {
13
- "plugin": [
14
- "npm:opencode-memoir"
15
- ]
16
- }
17
- ```
18
-
19
- OpenCode resolves the package via npm automatically; no manual download needed.
20
-
21
- ### Alternative: global install
22
-
23
- ```bash
24
- npm install -g opencode-memoir
25
- ```
26
-
27
- Then reference it by path in your config:
9
+ Add the package name to your OpenCode config (`~/.config/opencode/opencode.jsonc`):
28
10
 
29
11
  ```jsonc
30
12
  {
@@ -34,7 +16,9 @@ Then reference it by path in your config:
34
16
  }
35
17
  ```
36
18
 
37
- The plugin auto-resolves the `memoir` CLI: first from `PATH`, then via `uvx --from memoir-ai==<pin> memoir` (no separate install needed).
19
+ OpenCode downloads and resolves the package from npm automatically; no manual install or `npm:` prefix needed. To pin a version, append it: `"opencode-memoir@1.0.0"`.
20
+
21
+ The `memoir` CLI is resolved automatically with no separate install — see [Memoir CLI resolution](#memoir-cli-resolution).
38
22
 
39
23
  ## Quick start
40
24
 
@@ -57,7 +41,7 @@ Example when loading through `plugin[]`:
57
41
  ```jsonc
58
42
  {
59
43
  "plugin": [
60
- ["npm:opencode-memoir", { "store": "/custom/store/path" }]
44
+ ["opencode-memoir", { "store": "/custom/store/path" }]
61
45
  ]
62
46
  }
63
47
  ```
@@ -134,7 +118,7 @@ Every command passes an explicit `-s <store>` to keep the project git and Memoir
134
118
  ```bash
135
119
  npm install
136
120
  npm run build # typecheck + emit dist
137
- npm test # run the test suite (69 tests)
121
+ npm test # run the test suite
138
122
  ```
139
123
 
140
124
  ### Source layout
@@ -149,26 +133,19 @@ npm test # run the test suite (69 tests)
149
133
 
150
134
  ### Tests
151
135
 
152
- ```bash
153
- npm test
154
- ```
155
-
156
- 69 tests across 5 files. Run with `tsx --test` (handles `.js` → `.ts` resolution under NodeNext).
136
+ The suite runs with `tsx --test` (handles `.js` → `.ts` resolution under NodeNext).
157
137
 
158
138
  To debug hooks locally, run OpenCode with `MEMOIR_DEBUG=1` and watch stderr for `[memoir]` lines.
159
139
 
160
140
  ## Publishing
161
141
 
162
- ```bash
163
- # Log in to npm (one-time)
164
- npm login
142
+ Releases are fully automated — no manual `npm version` or `npm publish`.
165
143
 
166
- # Bump version, build, test, publish
167
- npm version patch # minor | major
168
- npm publish
169
- ```
144
+ 1. Land changes on `main` via PR using [Conventional Commits](https://www.conventionalcommits.org/) (`feat:`, `fix:`, `chore:`, etc.). The commit type determines the version bump.
145
+ 2. On push to `main`, `.github/workflows/semantic.yaml` runs [semantic-release](https://semantic-release.gitbook.io/): it computes the next version, updates the changelog, commits `chore(release): x.y.z`, and pushes a matching `vx.y.z` git tag.
146
+ 3. The new tag triggers `.github/workflows/publish-npm.yaml`, which builds and runs `npm publish --provenance` to npm via [Trusted Publishing](https://docs.npmjs.com/trusted-publishers) (OIDC — no tokens stored).
170
147
 
171
- The `prepublishOnly` script runs `build` + `test` automatically. Published files are limited to `dist/` and `README.md` (see `files` in `package.json`).
148
+ Published files are limited to `dist/` and `README.md` (see `files` in `package.json`); the `prepublishOnly` script runs `build` + `test` as a safety net.
172
149
 
173
150
  ## License
174
151
 
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "opencode-memoir",
3
- "version": "1.0.0",
3
+ "version": "1.0.3",
4
4
  "description": "Memoir memory plugin for OpenCode — Git-versioned, taxonomy-structured AI memory.",
5
5
  "type": "module",
6
6
  "main": "dist/index.js",