@t1mmen/srtd
Version:
Supabase Repeatable Template Definitions (srtd): 🪄 Live-reloading SQL templates for Supabase DX. Make your database changes reviewable and migrations maintainable! 🚀
39 lines (38 loc) • 1.19 kB
TypeScript
/**
* A keyboard shortcut definition for the watch footer.
*/
export interface WatchFooterShortcut {
/** The key to press (e.g., 'q') */
key: string;
/** The label describing the action (e.g., 'quit') */
label: string;
}
/**
* Options for rendering the watch footer.
*/
export interface WatchFooterOptions {
/** Custom shortcuts to display, or use DEFAULT_WATCH_SHORTCUTS if not provided */
shortcuts?: WatchFooterShortcut[];
/** Optional destination path to display above shortcuts */
destination?: string;
}
/**
* Default keyboard shortcuts for watch mode.
* - q: quit watch mode
* - u: toggle showing unchanged templates in header
* - b: trigger build for all pending templates
*/
export declare const DEFAULT_WATCH_SHORTCUTS: WatchFooterShortcut[];
/**
* Renders the watch mode footer with keyboard shortcuts.
*
* Output format:
* ```
* dest: supabase/migrations
* q quit u toggle unchanged b build all
* ```
*
* Keys are rendered dim, labels in normal text, separated by double-space.
* Uses a blank line for spacing instead of a separator line.
*/
export declare function renderWatchFooter(options?: WatchFooterOptions): void;