mirror of
https://github.com/esm7/obsidian-vimrc-support.git
synced 2026-07-22 05:00:25 +00:00
0b1168b2ae
- CodeMirror.Editor is globally available as a type (and already used in other files), so lets just stick consistently to using that
32 lines
829 B
TypeScript
32 lines
829 B
TypeScript
/**
|
|
* Partial representation of the CodeMirror Vim API that we use to define motions, commands, etc.
|
|
*
|
|
* References:
|
|
* https://github.com/replit/codemirror-vim/blob/master/src/vim.js
|
|
* https://libvoyant.ucr.edu/resources/codemirror/doc/manual.html
|
|
*/
|
|
|
|
import { EditorPosition } from "obsidian";
|
|
|
|
export type MotionFn = (
|
|
cm: CodeMirror.Editor,
|
|
cursorPosition: EditorPosition, // called `head` in the API
|
|
motionArgs: { repeat: number }
|
|
) => EditorPosition;
|
|
|
|
export type ActionFn = (
|
|
cm: CodeMirror.Editor,
|
|
actionArgs: { repeat: number },
|
|
) => void;
|
|
|
|
export type VimApi = {
|
|
defineMotion: (name: string, fn: MotionFn) => void;
|
|
defineAction: (name: string, fn: ActionFn) => void;
|
|
mapCommand: (
|
|
keys: string,
|
|
type: string,
|
|
name: string,
|
|
args: any,
|
|
extra: { [x: string]: any }
|
|
) => void;
|
|
};
|