escriba-lisp 0.1.11

Tatara-Lisp authoring bridge for escriba — declarative keybindings, options, themes, hooks, commands
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173

//! `defhook` — Lisp-authored editor event hook.
//!
//! Events mirror Neovim's autocmd taxonomy so users coming from nvim
//! know what to reach for:
//!
//! - `BufReadPre` / `BufReadPost` — around a buffer load.
//! - `BufWritePre` / `BufWritePost` — around a buffer write.
//! - `ModeChanged` — on modal transitions (optional `:from` / `:to`).
//! - `CursorMoved` — cursor position changed.
//! - `BufEnter` / `BufLeave` — focus moving between buffers.
//! - `VimEnter` / `VimLeave` — startup / shutdown.
//!
//! The command string is the name of a command registered via
//! `defcmd` (or a built-in command); the registry resolves it at
//! dispatch time.
//!
//! ```lisp
//! (defhook :event "BufWritePost" :command "run-formatter")
//! (defhook :event "ModeChanged"  :to "insert"
//!          :command "highlight-cursor-line")
//! ```

use serde::{Deserialize, Serialize};
use tatara_lisp::DeriveTataraDomain;

#[derive(DeriveTataraDomain, Serialize, Deserialize, Debug, Clone, PartialEq, Eq)]
#[serde(rename_all = "camelCase")]
#[tatara(keyword = "defhook")]
pub struct HookSpec {
    /// The autocmd-style event name.
    pub event: String,
    /// The command (registered name) to invoke when the hook fires.
    pub command: String,
    /// Optional `ModeChanged :from` qualifier.
    #[serde(default)]
    pub from: String,
    /// Optional `ModeChanged :to` qualifier.
    #[serde(default)]
    pub to: String,
    /// Optional buffer pattern qualifier (e.g., `"*.rs"` for BufReadPost).
    #[serde(default)]
    pub pattern: String,
}

/// The canonical event list — unknown events in a spec are rejected.
///
/// Mirrors neovim's autocmd event vocabulary so every blnvim /
/// nvim user recipe ports across directly. Events are alphabetised
/// within category bands so additions stay easy to review.
pub const KNOWN_EVENTS: &[&str] = &[
    // ── Buffer lifecycle ─────────────────────────────────────────
    "BufAdd",
    "BufDelete",
    "BufEnter",
    "BufFilePre",
    "BufFilePost",
    "BufHidden",
    "BufLeave",
    "BufModifiedSet",
    "BufNew",
    "BufNewFile",
    "BufReadCmd",
    "BufReadPost",
    "BufReadPre",
    "BufUnload",
    "BufWinEnter",
    "BufWinLeave",
    "BufWipeout",
    "BufWriteCmd",
    "BufWritePost",
    "BufWritePre",
    // ── Cursor / edit state ──────────────────────────────────────
    "CursorHold",
    "CursorHoldI",
    "CursorMoved",
    "CursorMovedI",
    "InsertChange",
    "InsertCharPre",
    "InsertEnter",
    "InsertLeave",
    "InsertLeavePre",
    "ModeChanged",
    "TextChanged",
    "TextChangedI",
    "TextYankPost",
    // ── Window / UI ──────────────────────────────────────────────
    "ColorScheme",
    "ColorSchemePre",
    "FocusGained",
    "FocusLost",
    "WinClosed",
    "WinEnter",
    "WinLeave",
    "WinNew",
    "WinResized",
    "WinScrolled",
    "TabEnter",
    "TabLeave",
    "TabClosed",
    "TabNew",
    "TabNewEntered",
    "VimEnter",
    "VimLeave",
    "VimLeavePre",
    "VimResized",
    "VimResume",
    "VimSuspend",
    // ── LSP / diagnostic ─────────────────────────────────────────
    "DiagnosticChanged",
    "LspAttach",
    "LspDetach",
    "LspNotify",
    "LspProgress",
    "LspRequest",
    "LspTokenUpdate",
    // ── Filesystem / search ──────────────────────────────────────
    "FileAppendCmd",
    "FileAppendPost",
    "FileAppendPre",
    "FileReadCmd",
    "FileReadPost",
    "FileReadPre",
    "FileType",
    "FileWriteCmd",
    "FileWritePost",
    "FileWritePre",
    "QuickFixCmdPost",
    "QuickFixCmdPre",
    "ShellCmdPost",
    "ShellFilterPost",
    "SignalUSR1",
    // ── Terminal ─────────────────────────────────────────────────
    "TermClose",
    "TermEnter",
    "TermLeave",
    "TermOpen",
    "TermRequest",
    "TermResponse",
    // ── Command-line / misc ──────────────────────────────────────
    "CmdlineChanged",
    "CmdlineEnter",
    "CmdlineLeave",
    "CmdUndefined",
    "CmdwinEnter",
    "CmdwinLeave",
    "CompleteChanged",
    "CompleteDone",
    "CompleteDonePre",
    "MenuPopup",
    "OptionSet",
    "RecordingEnter",
    "RecordingLeave",
    "SearchWrapped",
    "SessionLoadPost",
    "SessionWritePost",
    "Signal",
    "SourceCmd",
    "SourcePost",
    "SourcePre",
    "SpellFileMissing",
    "StdinReadPost",
    "StdinReadPre",
    "SwapExists",
    "Syntax",
    "UIEnter",
    "UILeave",
    "User",
];

#[must_use]
pub fn is_known_event(name: &str) -> bool {
    KNOWN_EVENTS.iter().any(|e| *e == name)
}