Skip to main content

vvv_engine/protocol/
command.rs

1//! Stable command identity and descriptors shared by discovery and clients.
2use serde::{Deserialize, Serialize};
3
4#[derive(Debug, Clone, Copy, PartialEq, Eq, PartialOrd, Ord, Hash, Serialize, Deserialize)]
5#[cfg_attr(feature = "schema", derive(schemars::JsonSchema))]
6#[serde(rename_all = "snake_case")]
7pub enum Command {
8    DiscardPlan,
9    ApplyPlan,
10    ValidatePlan,
11    InspectPlan,
12    PrepareRename,
13    PrepareRewrite,
14    PrepareMove,
15    PrepareMoveSymbol,
16    SymbolMoveCandidates,
17    ReviewPlan,
18    #[cfg(feature = "schema")]
19    Schema,
20    SearchPage,
21    ContextPage,
22    Continue,
23    Expand,
24    Discover,
25    Context,
26    Navigate,
27    Relationships,
28    Resolve,
29    Search,
30    Outline,
31    References,
32    Where,
33    Deps,
34    Explain,
35    Surface,
36    Impact,
37    Dead,
38    Imports,
39    WorkspaceFiles,
40    File,
41    Rewrite,
42    Rename,
43    Move,
44    MoveSymbol,
45    Batch,
46    History,
47    Undo,
48}
49
50impl Command {
51    pub const ALL: &[Self] = &[
52        Self::DiscardPlan,
53        Self::ApplyPlan,
54        Self::ValidatePlan,
55        Self::InspectPlan,
56        Self::PrepareRename,
57        Self::PrepareRewrite,
58        Self::PrepareMove,
59        Self::PrepareMoveSymbol,
60        Self::SymbolMoveCandidates,
61        Self::ReviewPlan,
62        #[cfg(feature = "schema")]
63        Self::Schema,
64        Self::SearchPage,
65        Self::ContextPage,
66        Self::Continue,
67        Self::Expand,
68        Self::Discover,
69        Self::Context,
70        Self::Navigate,
71        Self::Relationships,
72        Self::Resolve,
73        Self::Search,
74        Self::Outline,
75        Self::References,
76        Self::Where,
77        Self::Deps,
78        Self::Explain,
79        Self::Surface,
80        Self::Impact,
81        Self::Dead,
82        Self::Imports,
83        Self::WorkspaceFiles,
84        Self::File,
85        Self::Rewrite,
86        Self::Rename,
87        Self::Move,
88        Self::MoveSymbol,
89        Self::Batch,
90        Self::History,
91        Self::Undo,
92    ];
93
94    pub fn as_str(self) -> &'static str {
95        match self {
96            Self::DiscardPlan => "discard_plan",
97            Self::ApplyPlan => "apply_plan",
98            Self::ValidatePlan => "validate_plan",
99            Self::InspectPlan => "inspect_plan",
100            Self::PrepareRename => "prepare_rename",
101            Self::PrepareRewrite => "prepare_rewrite",
102            Self::PrepareMove => "prepare_move",
103            Self::PrepareMoveSymbol => "prepare_move_symbol",
104            Self::SymbolMoveCandidates => "symbol_move_candidates",
105            Self::ReviewPlan => "review_plan",
106            #[cfg(feature = "schema")]
107            Self::Schema => "schema",
108            Self::SearchPage => "search_page",
109            Self::ContextPage => "context_page",
110            Self::Continue => "continue",
111            Self::Expand => "expand",
112            Self::Discover => "discover",
113            Self::Context => "context",
114            Self::Navigate => "navigate",
115            Self::Relationships => "relationships",
116            Self::Resolve => "resolve",
117            Self::Search => "search",
118            Self::Outline => "outline",
119            Self::References => "references",
120            Self::Where => "where",
121            Self::Deps => "deps",
122            Self::Explain => "explain",
123            Self::Surface => "surface",
124            Self::Impact => "impact",
125            Self::Dead => "dead",
126            Self::Imports => "imports",
127            Self::WorkspaceFiles => "workspace_files",
128            Self::File => "file",
129            Self::Rewrite => "rewrite",
130            Self::Rename => "rename",
131            Self::Move => "move",
132            Self::MoveSymbol => "move_symbol",
133            Self::Batch => "batch",
134            Self::History => "history",
135            Self::Undo => "undo",
136        }
137    }
138
139    pub fn parameters(self) -> &'static [&'static str] {
140        match self {
141            Self::DiscardPlan => &["plan_id"],
142            Self::ApplyPlan => &["plan_id"],
143            Self::ValidatePlan => &["plan_id", "checks", "extra_inputs", "budget"],
144            Self::InspectPlan => &["plan_id", "max_bytes", "page"],
145            Self::PrepareRename
146            | Self::PrepareRewrite
147            | Self::PrepareMove
148            | Self::PrepareMoveSymbol => &["intent", "max_bytes", "page"],
149            Self::ReviewPlan => &["cursor", "page"],
150            Self::SymbolMoveCandidates => &["name", "from"],
151            #[cfg(feature = "schema")]
152            Self::Schema => &["for_command", "contract"],
153            Self::SearchPage => &["query", "scope", "page"],
154            Self::ContextPage => &[
155                "origin",
156                "selection",
157                "references",
158                "include_enclosing",
159                "detail",
160                "page",
161                "work",
162            ],
163            Self::Continue => &["cursor", "page", "work"],
164            Self::Expand => &["cursor", "max_bytes"],
165            Self::Discover => &[],
166            Self::Context => &[
167                "origin",
168                "selection",
169                "budget",
170                "references",
171                "include_enclosing",
172                "detail",
173            ],
174            Self::Relationships => &["origin", "selection", "kind", "scope", "budget"],
175            Self::Navigate | Self::Resolve => &["origin", "selection"],
176            Self::Search => &["pattern", "kind", "symbol", "name", "language", "scope"],
177            Self::Outline => &["path"],
178            Self::References => &["name", "symbol", "language", "declared_in"],
179            Self::Where => &["name", "from"],
180            Self::Deps => &["path"],
181            Self::Explain => &["path", "position"],
182            Self::Surface => &["package"],
183            Self::Impact => &["name", "declared_in"],
184            Self::Dead => &["language"],
185            Self::Imports => &["path"],
186            Self::WorkspaceFiles => &[],
187            Self::File => &["path"],
188            Self::Rewrite => &["query", "template", "selection", "apply"],
189            Self::Rename => &[
190                "name",
191                "to",
192                "symbol",
193                "language",
194                "declared_in",
195                "selection",
196                "apply",
197            ],
198            Self::Move => &["from", "to", "apply"],
199            Self::MoveSymbol => &[
200                "name",
201                "from",
202                "to",
203                "selection",
204                "expected_content",
205                "apply",
206            ],
207            Self::Batch => &["intents", "apply"],
208            Self::History => &[],
209            Self::Undo => &[],
210        }
211    }
212
213    pub fn is_read_only(self) -> bool {
214        match self {
215            Self::DiscardPlan => true,
216            Self::ApplyPlan | Self::ValidatePlan => false,
217            Self::InspectPlan => true,
218            Self::PrepareRename
219            | Self::PrepareRewrite
220            | Self::PrepareMove
221            | Self::PrepareMoveSymbol
222            | Self::SymbolMoveCandidates
223            | Self::ReviewPlan => true,
224            #[cfg(feature = "schema")]
225            Self::Schema => true,
226            Self::SearchPage => true,
227            Self::ContextPage => true,
228            Self::Continue => true,
229            Self::Expand => true,
230            Self::Discover => true,
231            Self::Context => true,
232            Self::Relationships => true,
233            Self::Navigate | Self::Resolve => true,
234            Self::Search => true,
235            Self::Outline => true,
236            Self::References => true,
237            Self::Where => true,
238            Self::Deps => true,
239            Self::Explain => true,
240            Self::Surface => true,
241            Self::Impact => true,
242            Self::Dead => true,
243            Self::Imports => true,
244            Self::WorkspaceFiles => true,
245            Self::File => true,
246            Self::Rewrite => false,
247            Self::Rename => false,
248            Self::Move => false,
249            Self::MoveSymbol => false,
250            Self::Batch => false,
251            Self::History => true,
252            Self::Undo => false,
253        }
254    }
255}
256
257impl std::str::FromStr for Command {
258    type Err = serde_json::Error;
259    fn from_str(value: &str) -> Result<Self, Self::Err> {
260        serde_json::from_value(serde_json::Value::String(value.into()))
261    }
262}