lib.rs

  1use gpui::{Action, actions};
  2use schemars::JsonSchema;
  3use serde::{Deserialize, Serialize};
  4
  5// If the zed binary doesn't use anything in this crate, it will be optimized away
  6// and the actions won't initialize. So we just provide an empty initialization function
  7// to be called from main.
  8//
  9// These may provide relevant context:
 10// https://github.com/rust-lang/rust/issues/47384
 11// https://github.com/mmastrac/rust-ctor/issues/280
 12pub fn init() {}
 13
 14/// Opens a URL in the system's default web browser.
 15#[derive(Clone, PartialEq, Deserialize, JsonSchema, Action)]
 16#[action(namespace = zed)]
 17#[serde(deny_unknown_fields)]
 18pub struct OpenBrowser {
 19    pub url: String,
 20}
 21
 22/// Opens a zed:// URL within the application.
 23#[derive(Clone, PartialEq, Deserialize, JsonSchema, Action)]
 24#[action(namespace = zed)]
 25#[serde(deny_unknown_fields)]
 26pub struct OpenZedUrl {
 27    pub url: String,
 28}
 29
 30actions!(
 31    zed,
 32    [
 33        /// Opens the settings editor.
 34        OpenSettings,
 35        /// Opens the default keymap file.
 36        OpenDefaultKeymap,
 37        /// Opens account settings.
 38        OpenAccountSettings,
 39        /// Opens server settings.
 40        OpenServerSettings,
 41        /// Quits the application.
 42        Quit,
 43        /// Opens the user keymap file.
 44        OpenKeymap,
 45        /// Shows information about Zed.
 46        About,
 47        /// Opens the documentation website.
 48        OpenDocs,
 49        /// Views open source licenses.
 50        OpenLicenses,
 51        /// Opens the telemetry log.
 52        OpenTelemetryLog,
 53    ]
 54);
 55
 56#[derive(PartialEq, Clone, Copy, Debug, Deserialize, JsonSchema)]
 57#[serde(rename_all = "snake_case")]
 58pub enum ExtensionCategoryFilter {
 59    Themes,
 60    IconThemes,
 61    Languages,
 62    Grammars,
 63    LanguageServers,
 64    ContextServers,
 65    SlashCommands,
 66    IndexedDocsProviders,
 67    Snippets,
 68    DebugAdapters,
 69}
 70
 71/// Opens the extensions management interface.
 72#[derive(PartialEq, Clone, Default, Debug, Deserialize, JsonSchema, Action)]
 73#[action(namespace = zed)]
 74#[serde(deny_unknown_fields)]
 75pub struct Extensions {
 76    /// Filters the extensions page down to extensions that are in the specified category.
 77    #[serde(default)]
 78    pub category_filter: Option<ExtensionCategoryFilter>,
 79    /// Focuses just the extension with the specified ID.
 80    #[serde(default)]
 81    pub id: Option<String>,
 82}
 83
 84/// Decreases the font size in the editor buffer.
 85#[derive(PartialEq, Clone, Default, Debug, Deserialize, JsonSchema, Action)]
 86#[action(namespace = zed)]
 87#[serde(deny_unknown_fields)]
 88pub struct DecreaseBufferFontSize {
 89    #[serde(default)]
 90    pub persist: bool,
 91}
 92
 93/// Increases the font size in the editor buffer.
 94#[derive(PartialEq, Clone, Default, Debug, Deserialize, JsonSchema, Action)]
 95#[action(namespace = zed)]
 96#[serde(deny_unknown_fields)]
 97pub struct IncreaseBufferFontSize {
 98    #[serde(default)]
 99    pub persist: bool,
100}
101
102/// Resets the buffer font size to the default value.
103#[derive(PartialEq, Clone, Default, Debug, Deserialize, JsonSchema, Action)]
104#[action(namespace = zed)]
105#[serde(deny_unknown_fields)]
106pub struct ResetBufferFontSize {
107    #[serde(default)]
108    pub persist: bool,
109}
110
111/// Decreases the font size of the user interface.
112#[derive(PartialEq, Clone, Default, Debug, Deserialize, JsonSchema, Action)]
113#[action(namespace = zed)]
114#[serde(deny_unknown_fields)]
115pub struct DecreaseUiFontSize {
116    #[serde(default)]
117    pub persist: bool,
118}
119
120/// Increases the font size of the user interface.
121#[derive(PartialEq, Clone, Default, Debug, Deserialize, JsonSchema, Action)]
122#[action(namespace = zed)]
123#[serde(deny_unknown_fields)]
124pub struct IncreaseUiFontSize {
125    #[serde(default)]
126    pub persist: bool,
127}
128
129/// Resets the UI font size to the default value.
130#[derive(PartialEq, Clone, Default, Debug, Deserialize, JsonSchema, Action)]
131#[action(namespace = zed)]
132#[serde(deny_unknown_fields)]
133pub struct ResetUiFontSize {
134    #[serde(default)]
135    pub persist: bool,
136}
137
138pub mod dev {
139    use gpui::actions;
140
141    actions!(
142        dev,
143        [
144            /// Toggles the developer inspector for debugging UI elements.
145            ToggleInspector
146        ]
147    );
148}
149
150pub mod workspace {
151    use gpui::actions;
152
153    actions!(
154        workspace,
155        [
156            #[action(deprecated_aliases = ["editor::CopyPath", "outline_panel::CopyPath", "project_panel::CopyPath"])]
157            CopyPath,
158            #[action(deprecated_aliases = ["editor::CopyRelativePath", "outline_panel::CopyRelativePath", "project_panel::CopyRelativePath"])]
159            CopyRelativePath
160        ]
161    );
162}
163
164pub mod git {
165    use gpui::actions;
166
167    actions!(
168        git,
169        [
170            /// Checks out a different git branch.
171            CheckoutBranch,
172            /// Switches to a different git branch.
173            Switch,
174            /// Selects a different repository.
175            SelectRepo,
176            /// Opens the git branch selector.
177            #[action(deprecated_aliases = ["branches::OpenRecent"])]
178            Branch
179        ]
180    );
181}
182
183pub mod jj {
184    use gpui::actions;
185
186    actions!(
187        jj,
188        [
189            /// Opens the Jujutsu bookmark list.
190            BookmarkList
191        ]
192    );
193}
194
195pub mod toast {
196    use gpui::actions;
197
198    actions!(
199        toast,
200        [
201            /// Runs the action associated with a toast notification.
202            RunAction
203        ]
204    );
205}
206
207pub mod command_palette {
208    use gpui::actions;
209
210    actions!(
211        command_palette,
212        [
213            /// Toggles the command palette.
214            Toggle
215        ]
216    );
217}
218
219pub mod feedback {
220    use gpui::actions;
221
222    actions!(
223        feedback,
224        [
225            /// Opens the bug report form.
226            FileBugReport,
227            /// Opens the feedback form.
228            GiveFeedback
229        ]
230    );
231}
232
233pub mod theme_selector {
234    use gpui::Action;
235    use schemars::JsonSchema;
236    use serde::Deserialize;
237
238    /// Toggles the theme selector interface.
239    #[derive(PartialEq, Clone, Default, Debug, Deserialize, JsonSchema, Action)]
240    #[action(namespace = theme_selector)]
241    #[serde(deny_unknown_fields)]
242    pub struct Toggle {
243        /// A list of theme names to filter the theme selector down to.
244        pub themes_filter: Option<Vec<String>>,
245    }
246}
247
248pub mod icon_theme_selector {
249    use gpui::Action;
250    use schemars::JsonSchema;
251    use serde::Deserialize;
252
253    /// Toggles the icon theme selector interface.
254    #[derive(PartialEq, Clone, Default, Debug, Deserialize, JsonSchema, Action)]
255    #[action(namespace = icon_theme_selector)]
256    #[serde(deny_unknown_fields)]
257    pub struct Toggle {
258        /// A list of icon theme names to filter the theme selector down to.
259        pub themes_filter: Option<Vec<String>>,
260    }
261}
262
263pub mod agent {
264    use gpui::actions;
265
266    actions!(
267        agent,
268        [
269            /// Opens the agent settings panel.
270            #[action(deprecated_aliases = ["agent::OpenConfiguration"])]
271            OpenSettings,
272            /// Opens the agent onboarding modal.
273            OpenOnboardingModal,
274            /// Resets the agent onboarding state.
275            ResetOnboarding,
276            /// Starts a chat conversation with the agent.
277            Chat,
278            /// Displays the previous message in the history.
279            PreviousHistoryMessage,
280            /// Displays the next message in the history.
281            NextHistoryMessage,
282            /// Toggles the language model selector dropdown.
283            #[action(deprecated_aliases = ["assistant::ToggleModelSelector", "assistant2::ToggleModelSelector"])]
284            ToggleModelSelector
285        ]
286    );
287}
288
289pub mod assistant {
290    use gpui::{Action, actions};
291    use schemars::JsonSchema;
292    use serde::Deserialize;
293    use uuid::Uuid;
294
295    actions!(
296        agent,
297        [
298            #[action(deprecated_aliases = ["assistant::ToggleFocus"])]
299            ToggleFocus
300        ]
301    );
302
303    actions!(
304        assistant,
305        [
306            /// Shows the assistant configuration panel.
307            ShowConfiguration
308        ]
309    );
310
311    /// Opens the rules library for managing agent rules and prompts.
312    #[derive(PartialEq, Clone, Default, Debug, Deserialize, JsonSchema, Action)]
313    #[action(namespace = agent, deprecated_aliases = ["assistant::OpenRulesLibrary", "assistant::DeployPromptLibrary"])]
314    #[serde(deny_unknown_fields)]
315    pub struct OpenRulesLibrary {
316        #[serde(skip)]
317        pub prompt_to_select: Option<Uuid>,
318    }
319
320    /// Deploys the assistant interface with the specified configuration.
321    #[derive(Clone, Default, Deserialize, PartialEq, JsonSchema, Action)]
322    #[action(namespace = assistant)]
323    #[serde(deny_unknown_fields)]
324    pub struct InlineAssist {
325        pub prompt: Option<String>,
326    }
327}
328
329pub mod debugger {
330    use gpui::actions;
331
332    actions!(
333        debugger,
334        [
335            /// Opens the debugger onboarding modal.
336            OpenOnboardingModal,
337            /// Resets the debugger onboarding state.
338            ResetOnboarding
339        ]
340    );
341}
342
343/// Opens the recent projects interface.
344#[derive(PartialEq, Clone, Deserialize, Default, JsonSchema, Action)]
345#[action(namespace = projects)]
346#[serde(deny_unknown_fields)]
347pub struct OpenRecent {
348    #[serde(default)]
349    pub create_new_window: bool,
350}
351
352/// Creates a project from a selected template.
353#[derive(PartialEq, Clone, Deserialize, Default, JsonSchema, Action)]
354#[action(namespace = projects)]
355#[serde(deny_unknown_fields)]
356pub struct OpenRemote {
357    #[serde(default)]
358    pub from_existing_connection: bool,
359    #[serde(default)]
360    pub create_new_window: bool,
361}
362
363/// Where to spawn the task in the UI.
364#[derive(Default, Clone, Copy, Debug, PartialEq, Eq, Serialize, Deserialize, JsonSchema)]
365#[serde(rename_all = "snake_case")]
366pub enum RevealTarget {
367    /// In the central pane group, "main" editor area.
368    Center,
369    /// In the terminal dock, "regular" terminal items' place.
370    #[default]
371    Dock,
372}
373
374/// Spawns a task with name or opens tasks modal.
375#[derive(Debug, PartialEq, Clone, Deserialize, JsonSchema, Action)]
376#[action(namespace = task)]
377#[serde(untagged)]
378pub enum Spawn {
379    /// Spawns a task by the name given.
380    ByName {
381        task_name: String,
382        #[serde(default)]
383        reveal_target: Option<RevealTarget>,
384    },
385    /// Spawns a task by the name given.
386    ByTag {
387        task_tag: String,
388        #[serde(default)]
389        reveal_target: Option<RevealTarget>,
390    },
391    /// Spawns a task via modal's selection.
392    ViaModal {
393        /// Selected task's `reveal_target` property override.
394        #[serde(default)]
395        reveal_target: Option<RevealTarget>,
396    },
397}
398
399impl Spawn {
400    pub fn modal() -> Self {
401        Self::ViaModal {
402            reveal_target: None,
403        }
404    }
405}
406
407/// Reruns the last task.
408#[derive(PartialEq, Clone, Deserialize, Default, JsonSchema, Action)]
409#[action(namespace = task)]
410#[serde(deny_unknown_fields)]
411pub struct Rerun {
412    /// Controls whether the task context is reevaluated prior to execution of a task.
413    /// If it is not, environment variables such as ZED_COLUMN, ZED_FILE are gonna be the same as in the last execution of a task
414    /// If it is, these variables will be updated to reflect current state of editor at the time task::Rerun is executed.
415    /// default: false
416    #[serde(default)]
417    pub reevaluate_context: bool,
418    /// Overrides `allow_concurrent_runs` property of the task being reran.
419    /// Default: null
420    #[serde(default)]
421    pub allow_concurrent_runs: Option<bool>,
422    /// Overrides `use_new_terminal` property of the task being reran.
423    /// Default: null
424    #[serde(default)]
425    pub use_new_terminal: Option<bool>,
426
427    /// If present, rerun the task with this ID, otherwise rerun the last task.
428    #[serde(skip)]
429    pub task_id: Option<String>,
430}
431
432pub mod outline {
433    use std::sync::OnceLock;
434
435    use gpui::{AnyView, App, Window, actions};
436
437    actions!(
438        outline,
439        [
440            #[action(name = "Toggle")]
441            ToggleOutline
442        ]
443    );
444    /// A pointer to outline::toggle function, exposed here to sewer the breadcrumbs <-> outline dependency.
445    pub static TOGGLE_OUTLINE: OnceLock<fn(AnyView, &mut Window, &mut App)> = OnceLock::new();
446}
447
448actions!(
449    zed_predict_onboarding,
450    [
451        /// Opens the Zed Predict onboarding modal.
452        OpenZedPredictOnboarding
453    ]
454);
455actions!(
456    git_onboarding,
457    [
458        /// Opens the git integration onboarding modal.
459        OpenGitIntegrationOnboarding
460    ]
461);
462
463actions!(
464    debug_panel,
465    [
466        /// Toggles focus on the debug panel.
467        ToggleFocus
468    ]
469);
470actions!(
471    debugger,
472    [
473        /// Toggles the enabled state of a breakpoint.
474        ToggleEnableBreakpoint,
475        /// Removes a breakpoint.
476        UnsetBreakpoint,
477        /// Opens the project debug tasks configuration.
478        OpenProjectDebugTasks,
479    ]
480);