@clack/core - npm Package Compare versions

Comparing version 0.3.5 to 0.4.0

CHANGELOG.md

 # @clack/core
 
+## 0.4.0
+
+### Minor Changes
+
+- a83d2f8: Adds a new `updateSettings()` function to support new global keybindings.
+
+  `updateSettings()` accepts an `aliases` object that maps custom keys to an action (`up | down | left | right | space | enter | cancel`).
+
+  ```ts
+  import { updateSettings } from "@clack/core";
+
+  // Support custom keybindings
+  updateSettings({
+    aliases: {
+      w: "up",
+      a: "left",
+      s: "down",
+      d: "right",
+    },
+  });
+  ```
+
+> [!WARNING]
+> In order to enforce consistent, user-friendly defaults across the ecosystem, `updateSettings` does not support disabling Clack's default keybindings.
+
+- 801246b: Adds a new `signal` option to support programmatic prompt cancellation with an [abort controller](https://kettanaito.com/blog/dont-sleep-on-abort-controller).
+
+
+- a83d2f8: Updates default keybindings to support Vim motion shortcuts and map the `escape` key to cancel (`ctrl+c`).
+
+  | alias | action |
+  | ----- | ------ |
+  | `k`   | up     |
+  | `l`   | right  |
+  | `j`   | down   |
+  | `h`   | left   |
+  | `esc` | cancel |
+
+### Patch Changes
+
+- 51e12bc: Improves types for events and interaction states.
+
 ## 0.3.5
@@ -4,0 +46,0 @@

dist/index.d.ts

 import { Readable, Writable } from 'node:stream';
 
-declare function isCancel(value: unknown): value is symbol;
+declare const actions: readonly ["up", "down", "left", "right", "space", "enter", "cancel"];
+type Action = (typeof actions)[number];
+interface ClackSettings {
+    /**
+     * Set custom global aliases for the default actions.
+     * This will not overwrite existing aliases, it will only add new ones!
+     *
+     * @param aliases - An object that maps aliases to actions
+     * @default { k: 'up', j: 'down', h: 'left', l: 'right', '\x03': 'cancel', 'escape': 'cancel' }
+     */
+    aliases: Record<string, Action>;
+}
+declare function updateSettings(updates: ClackSettings): void;
+
+/**
+ * The state of the prompt
+ */
+type ClackState = 'initial' | 'active' | 'cancel' | 'submit' | 'error';
+/**
+ * Typed event emitter for clack
+ */
+interface ClackEvents {
+    initial: (value?: any) => void;
+    active: (value?: any) => void;
+    cancel: (value?: any) => void;
+    submit: (value?: any) => void;
+    error: (value?: any) => void;
+    cursor: (key?: Action) => void;
+    key: (key?: string) => void;
+    value: (value?: string) => void;
+    confirm: (value?: boolean) => void;
+    finalize: () => void;
+}
+
 interface PromptOptions<Self extends Prompt> {
-    render(this: Omit<Self, 'prompt'>): string | void;
+    render(this: Omit<Self, 'prompt'>): string | undefined;
     placeholder?: string;
     initialValue?: any;
-    validate?: ((value: any) => string | void) | undefined;
+    validate?: ((value: any) => string | undefined) | undefined;
     input?: Readable;
     output?: Writable;
     debug?: boolean;
+    signal?: AbortSignal;
 }
-type State = 'initial' | 'active' | 'cancel' | 'submit' | 'error';
 declare class Prompt {
     protected input: Readable;
     protected output: Writable;
+    private _abortSignal?;
     private rl;
     private opts;
+    private _render;
     private _track;
-    private _render;
+    private _prevFrame;
+    private _subscribers;
     protected _cursor: number;
-    state: State;
+    state: ClackState;
+    error: string;
     value: any;
-    error: string;
-    constructor({ render, input, output, ...opts }: PromptOptions<Prompt>, trackValue?: boolean);
+    constructor(options: PromptOptions<Prompt>, trackValue?: boolean);
+    /**
+     * Unsubscribe all listeners
+     */
+    protected unsubscribe(): void;
+    /**
+     * Set a subscriber with opts
+     * @param event - The event name
+     */
+    private setSubscriber;
+    /**
+     * Subscribe to an event
+     * @param event - The event name
+     * @param cb - The callback
+     */
+    on<T extends keyof ClackEvents>(event: T, cb: ClackEvents[T]): void;
+    /**
+     * Subscribe to an event once
+     * @param event - The event name
+     * @param cb - The callback
+     */
+    once<T extends keyof ClackEvents>(event: T, cb: ClackEvents[T]): void;
+    /**
+     * Emit an event with data
+     * @param event - The event name
+     * @param data - The data to pass to the callback
+     */
+    emit<T extends keyof ClackEvents>(event: T, ...data: Parameters<ClackEvents[T]>): void;
     prompt(): Promise<string | symbol>;
-    private subscribers;
-    on(event: string, cb: (...args: any) => any): void;
-    once(event: string, cb: (...args: any) => any): void;
-    emit(event: string, ...data: any[]): void;
-    private unsubscribe;
     private onKeypress;
     protected close(): void;
     private restoreCursor;
-    private _prevFrame;
     private render;
@@ -140,2 +197,3 @@ }
 
+declare function isCancel(value: unknown): value is symbol;
 declare function block({ input, output, overwrite, hideCursor, }?: {
@@ -152,2 +210,2 @@ input?: (NodeJS.ReadStream & {
 
-export { ConfirmPrompt, GroupMultiSelectPrompt, MultiSelectPrompt, PasswordPrompt, Prompt, SelectKeyPrompt, SelectPrompt, type State, TextPrompt, block, isCancel };
+export { type ClackSettings, ConfirmPrompt, GroupMultiSelectPrompt, MultiSelectPrompt, PasswordPrompt, Prompt, SelectKeyPrompt, SelectPrompt, type ClackState as State, TextPrompt, block, isCancel, updateSettings };

package.json

 {
   "name": "@clack/core",
-  "version": "0.3.5",
+  "version": "0.4.0",
   "type": "module",
@@ -5,0 +5,0 @@ "main": "./dist/index.cjs",

No alert changes

Improved metrics

Total package byte prevSize

290962

6.44%

Lines of code

505

14.51%

No dependency changes