@sigil-dev/plugin-namepool 0.9.0 → 0.9.1

package/README.md

@@ -1 +1,55 @@
-# Sigil plugin for having uniueqe instance names
+# @sigil-dev/plugin-namepool
+
+Assigns human-readable names to Grimoire workers instead of the default `mode-index` identifiers like `api-0`, `ws-1`.
+
+## Installation
+
+```sh
+bun add @sigil-dev/plugin-namepool
+```
+
+## Usage
+
+```ts
+import { defineConfig } from "@sigil-dev/grimoire";
+import { namepool } from "@sigil-dev/plugin-namepool";
+
+export default defineConfig({
+    plugins: [
+        namepool({ names: ["Rei", "Asuka", "Misato", "Kaworu", "Ritsuko"] }),
+    ],
+    dev: true,
+});
+```
+
+Workers are assigned names by `globalIndex` — the first worker across all modes gets `names[0]`, the second gets `names[1]`, and so on. If there are more workers than names, the remainder fall back to `mode-index`.
+
+## Options
+
+```ts
+interface NamepoolOptions {
+  names: string[];
+}
+```
+
+| Option | Type | Description |
+|---|---|---|
+| `names` | `string[]` | Ordered list of names to assign to workers by global index. |
+
+## Integration with plugin-health
+
+When both plugins are registered, `plugin-health` automatically picks up the name pool and uses it to report `reserved` workers — names in the pool that have no live worker assigned. No manual wiring needed.
+
+```ts
+import { namepool } from "@sigil-dev/plugin-namepool";
+import { healthPlugin } from "@sigil-dev/plugin-health";
+
+export default defineConfig({
+  plugins: [
+    namepool({ names: ["Rei", "Asuka", "Shinji"] }),
+    healthPlugin(), // finds namepool automatically via onPluginsResolved
+  ],
+});
+```
+
+The `/health` endpoint will include all three names in the cluster array, marking any without a live worker as `"reserved"`.

package/package.json

@@ -1,7 +1,8 @@
 {
   "name": "@sigil-dev/plugin-namepool",
+  "description": "Automatic worker names for Sigil",
   "module": "index.ts",
-  "version": "0.9.0",
+  "version": "0.9.1",
   "type": "module",
   "private": false,
   "devDependencies": {
@@ -9,6 +10,6 @@
   },
   "peerDependencies": {
     "typescript": "^5",
-    "@sigil-dev/grimoire": "0.9.0"
+    "@sigil-dev/grimoire": "0.9.1"
   }
 }