@thazhemadam/vim-state 0.1.0

package/README.md

@@ -0,0 +1,18 @@
+# vim-state
+
+Reusable Vim modal state and host-neutral editing semantics.
+
+`vim-state` provides the XState machine, editor host contract, motions, operators, selectors, register types, and linear undo/redo history used by host integrations.
+
+## Usage
+
+```ts
+import { createActor } from "xstate";
+import { vimMachine, type VimEditorApi } from "vim-state";
+
+const editor: VimEditorApi = createHostEditor();
+const vim = createActor(vimMachine, { input: { editor } }).start();
+vim.send({ type: "KEY", key: "escape" });
+```
+
+Host integrations must implement `VimEditorHost` or provide a `VimEditorApi`. This package does not depend on any host UI framework.

package/dist/context.d.ts

@@ -0,0 +1,10 @@
+import type { VimEditorApi, VimOperator, VimRegister, VimVisualSelection } from "./editor.js";
+/** Runtime dependencies and bounded parser data owned by the Vim machine. */
+export interface VimContext {
+    editor: VimEditorApi;
+    count?: number;
+    operator?: VimOperator;
+    register?: VimRegister;
+    visual?: VimVisualSelection;
+}
+export type VimInput = VimContext;

package/dist/context.js

@@ -0,0 +1 @@
+export {};

package/dist/editor/constants.d.ts

@@ -0,0 +1,13 @@
+import type { VimMotion, VimOperator } from "./types.js";
+/** Terminal/control key bytes forwarded to the host editor. */
+export declare const ARROW_LEFT = "\u001B[D";
+export declare const ARROW_DOWN = "\u001B[B";
+export declare const ARROW_UP = "\u001B[A";
+export declare const ARROW_RIGHT = "\u001B[C";
+export declare const LINE_START = "\u0001";
+export declare const LINE_END = "\u0005";
+export declare const NEWLINE = "\n";
+export declare const DELETE_FORWARD = "\u001B[3~";
+export declare const DELETE_BACKWARD = "";
+export declare const OPERATOR_KEY: Record<VimOperator["name"], string>;
+export declare const NOUN_BY_KEY: Record<string, VimMotion>;

package/dist/editor/constants.js

@@ -0,0 +1,31 @@
+/** Terminal/control key bytes forwarded to the host editor. */
+export const ARROW_LEFT = "\x1b[D";
+export const ARROW_DOWN = "\x1b[B";
+export const ARROW_UP = "\x1b[A";
+export const ARROW_RIGHT = "\x1b[C";
+export const LINE_START = "\x01"; // Ctrl-A
+export const LINE_END = "\x05"; // Ctrl-E
+export const NEWLINE = "\n";
+export const DELETE_FORWARD = "\x1b[3~"; // Delete
+export const DELETE_BACKWARD = "\x7f"; // Backspace
+export const OPERATOR_KEY = {
+    delete: "d",
+    change: "c",
+    yank: "y",
+};
+export const NOUN_BY_KEY = {
+    h: "left",
+    j: "down",
+    k: "up",
+    l: "right",
+    "0": "lineStart",
+    $: "lineEnd",
+    "^": "firstNonBlank",
+    _: "firstNonBlank",
+    w: "nextWord",
+    b: "previousWord",
+    e: "endOfWord",
+    W: "nextBigWord",
+    B: "previousBigWord",
+    E: "endOfBigWord",
+};

package/dist/editor/index.d.ts

@@ -0,0 +1,13 @@
+import type { Constructor, VimEditorApi, VimEditorConfiguration, VimEditorHost } from "./types.js";
+export type { VimCaseTransform, VimEditorApi, VimEditorConfiguration, VimEditorHost, VimEditorOptions, VimFindDirection, VimFindOperation, VimLineTarget, VimMotion, VimNoun, VimOperator, VimOperatorTarget, VimPosition, VimRegister, VimTextObject, VimVisualMode, VimVisualSelection, } from "./types.js";
+export { nounForKey } from "./utils.js";
+/** Editing and configuration operations exposed by a composed Vim editor. */
+export interface VimEditor extends VimEditorApi, VimEditorConfiguration {
+}
+/** Constructor for host editor instances that expose a composed Vim editor. */
+type VimEditorMixinConstructor = Constructor<{
+    /** Vim editor exposed by the composed host instance. */
+    readonly vimEditor: VimEditor;
+}>;
+/** Return a host editor subclass with reusable Vim editing operations. */
+export declare function VimEditor<TBase extends Constructor<VimEditorHost>>(Base: TBase): TBase & VimEditorMixinConstructor;