@coldsmirk/inkstone-redis 0.23.0 → 0.24.0

package/README.md

@@ -15,7 +15,9 @@ Part of [inkstone](https://github.com/coldsmirk/inkstone). Built for the [**poly
 ```ts
 import { createRedisAssist, lineMarkers, runnableLine } from "@coldsmirk/inkstone-redis";
 
-const assist = createRedisAssist();          // over the built-in table; takes a vocabulary of your own
+// Over the built-in table; the keyspace is the host's to list — a cache-backed read (the key
+// tree's own list), never a fresh one, since completion asks on every keystroke in a key.
+const assist = createRedisAssist({ keys: () => [{ name: "user:1", type: "hash" }] });
 
 // What one run should send: the selection where there is one, else the caret's line.
 const runnable = runnableLine(text, from, to);
@@ -30,7 +32,9 @@ for (const marker of lineMarkers(text)) {
 }
 ```
 
-Completion offers every command at a line's start, a container's subcommands after it (`CLIENT` → `LIST`, `KILL` …) and the command's own fixed words among its arguments (`NX`, `EX`, `WITHSCORES`); hover describes the command under its name; signature help follows the caret across the syntax line. Everything reads the line through one splitter, so the three can never disagree about which word the caret is on.
+Completion offers every command at a line's start, a container's subcommands after it (`CLIENT` → `LIST`, `KILL` …), the keyspace at every word the command keys and the command's own fixed words among its arguments (`NX`, `EX`, `WITHSCORES`); hover describes the command under its name; signature help follows the caret across the syntax line. Everything reads the line through one splitter, so the three can never disagree about which word the caret is on.
+
+Which words are keys is the server's own word, not a guess at the syntax: each command carries the key spec `COMMAND` states for it — the first key's word, the last's (negative counts back from the call's end) and the step between them — so `GET key` keys one word, `DEL key [key ...]` every word after the name, and `MSET key value [key value ...]` every other one. A command whose keys only its own arguments can name (`EVAL`'s `numkeys`, `GEORADIUS`'s `STORE`) states none and is offered none. A key the reader could not read back bare is inserted quoted (`spellWord`, the splitter's own inverse).
 
 ## The mirror invariant
 
@@ -38,7 +42,7 @@ Completion offers every command at a line's start, a container's subcommands aft
 
 ## The table
 
-`src/commands.ts` is generated by `scripts/commands.ts` from the `COMMAND DOCS` and `COMMAND` replies of a running Redis 7.2 — the last BSD-3-Clause release, whose command documentation ships inside the server. The script's header says how to regenerate it. A command the table does not know (a module's, a newer server's) is a hint, never an error: the engine runs it all the same.
+`src/commands.ts` is generated by `scripts/commands.ts` from the `COMMAND DOCS` and `COMMAND` replies of a running Redis 7.2 (the argument tree and the summaries from the first, the arity and the key spec from the second) — the last BSD-3-Clause release, whose command documentation ships inside the server. The script's header says how to regenerate it. A command the table does not know (a module's, a newer server's) is a hint, never an error: the engine runs it all the same.
 
 ## Install