@coldsmirk/inkstone-redis 0.22.0

package/README.md

@@ -0,0 +1,49 @@
+# @coldsmirk/inkstone-redis
+
+Redis command-line editing intelligence for Monaco: the command table of Redis 7.2 (every command's name, syntax, arity and summary, as the server itself states them), redis-cli's own line splitting, completion / hover / signature help, line markers, and a drop-in React `<RedisEditor>`.
+
+Part of [inkstone](https://github.com/coldsmirk/inkstone). Built for the [**polyglot**](https://github.com/coldsmirk/polyglot) sidecar's Redis engine, which takes one command line and splits it exactly as this package reads it.
+
+## Entries
+
+- **`@coldsmirk/inkstone-redis`** — the framework-free core: the table, the line reader, the assist, the markers. Zero editor dependencies.
+- **`@coldsmirk/inkstone-redis/monaco`** — `defineRedisLanguage(monaco)` (the `redis` id with its Monarch grammar, once per monaco module), `registerRedisLanguage(monaco, modelPath, hooks)` (completion, hover and signature help for one model), `setRedisMarkers` (the markers as Monaco's own). Peer: `monaco-editor`.
+- **`@coldsmirk/inkstone-redis/react`** — `<RedisEditor>`: a controlled command editor built on `@coldsmirk/inkstone-react`'s `<MonacoEditor>`, with a run key (Ctrl/Cmd-Enter handing over the live caret), caret tracking, an insert handle for key trees, and each line's markers refreshed on every change. Peers: `monaco-editor`, `react`.
+
+## The shape
+
+```ts
+import { createRedisAssist, lineMarkers, runnableLine } from "@coldsmirk/inkstone-redis";
+
+const assist = createRedisAssist();          // over the built-in table; takes a vocabulary of your own
+
+// What one run should send: the selection where there is one, else the caret's line.
+const runnable = runnableLine(text, from, to);
+
+if (runnable.kind === "one") {
+  send(runnable.text);
+}
+
+// A code per line fault — the host owns the wording.
+for (const marker of lineMarkers(text)) {
+  console.log(marker.code, marker.severity, marker.from, marker.to);
+}
+```
+
+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.
+
+## The mirror invariant
+
+`splitLine` mirrors the polyglot sidecar's `RedisLine` word for word — bare words on blanks, double quotes with `\xHH` and the C escapes, single quotes with `\'` alone, a closing quote that must be followed by a blank — and refuses exactly what the engine refuses, as a code (`"unbalanced-double-quote"`, `"unbalanced-single-quote"`, `"quote-not-followed-by-blank"`). A change to the engine's splitter requires a matching release of this package; `line.test.ts` carries the engine's own cases.
+
+## 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.
+
+## Install
+
+```bash
+pnpm add @coldsmirk/inkstone-redis monaco-editor
+```
+
+Every peer is optional, because the root entry needs none of them: `/monaco` needs `monaco-editor`, and `/react` additionally needs `react` (>= 19) and `@coldsmirk/inkstone-react`. Never import `monaco-editor` statically — take the module from `onMount` / `ensureMonacoHost()`; type-only imports erase and are fine.