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
 30/// Opens the keymap to either add a keybinding or change an existing one
 31#[derive(PartialEq, Clone, Default, Action, JsonSchema, Serialize, Deserialize)]
 32#[action(namespace = zed, no_json, no_register)]
 33pub struct ChangeKeybinding {
 34    pub action: String,
 35}
 36
 37actions!(
 38    zed,
 39    [
 40        /// Opens the settings editor.
 41        #[action(deprecated_aliases = ["zed_actions::OpenSettingsEditor"])]
 42        OpenSettings,
 43        /// Opens the settings JSON file.
 44        #[action(deprecated_aliases = ["zed_actions::OpenSettings"])]
 45        OpenSettingsFile,
 46        /// Opens project-specific settings.
 47        #[action(deprecated_aliases = ["zed_actions::OpenProjectSettings"])]
 48        OpenProjectSettings,
 49        /// Opens the default keymap file.
 50        OpenDefaultKeymap,
 51        /// Opens the user keymap file.
 52        #[action(deprecated_aliases = ["zed_actions::OpenKeymap"])]
 53        OpenKeymapFile,
 54        /// Opens the keymap editor.
 55        #[action(deprecated_aliases = ["zed_actions::OpenKeymapEditor"])]
 56        OpenKeymap,
 57        /// Opens account settings.
 58        OpenAccountSettings,
 59        /// Opens server settings.
 60        OpenServerSettings,
 61        /// Quits the application.
 62        Quit,
 63        /// Shows information about Zed.
 64        About,
 65        /// Opens the documentation website.
 66        OpenDocs,
 67        /// Views open source licenses.
 68        OpenLicenses,
 69        /// Opens the telemetry log.
 70        OpenTelemetryLog,
 71        /// Opens the performance profiler.
 72        OpenPerformanceProfiler,
 73        /// Opens the onboarding view.
 74        OpenOnboarding,
 75    ]
 76);
 77
 78#[derive(PartialEq, Clone, Copy, Debug, Deserialize, JsonSchema)]
 79#[serde(rename_all = "snake_case")]
 80pub enum ExtensionCategoryFilter {
 81    Themes,
 82    IconThemes,
 83    Languages,
 84    Grammars,
 85    LanguageServers,
 86    ContextServers,
 87    AgentServers,
 88    SlashCommands,
 89    IndexedDocsProviders,
 90    Snippets,
 91    DebugAdapters,
 92}
 93
 94/// Opens the extensions management interface.
 95#[derive(PartialEq, Clone, Default, Debug, Deserialize, JsonSchema, Action)]
 96#[action(namespace = zed)]
 97#[serde(deny_unknown_fields)]
 98pub struct Extensions {
 99    /// Filters the extensions page down to extensions that are in the specified category.
100    #[serde(default)]
101    pub category_filter: Option<ExtensionCategoryFilter>,
102    /// Focuses just the extension with the specified ID.
103    #[serde(default)]
104    pub id: Option<String>,
105}
106
107/// Opens the ACP registry.
108#[derive(PartialEq, Clone, Default, Debug, Deserialize, JsonSchema, Action)]
109#[action(namespace = zed)]
110#[serde(deny_unknown_fields)]
111pub struct AcpRegistry;
112
113/// Decreases the font size in the editor buffer.
114#[derive(PartialEq, Clone, Default, Debug, Deserialize, JsonSchema, Action)]
115#[action(namespace = zed)]
116#[serde(deny_unknown_fields)]
117pub struct DecreaseBufferFontSize {
118    #[serde(default)]
119    pub persist: bool,
120}
121
122/// Increases the font size in the editor buffer.
123#[derive(PartialEq, Clone, Default, Debug, Deserialize, JsonSchema, Action)]
124#[action(namespace = zed)]
125#[serde(deny_unknown_fields)]
126pub struct IncreaseBufferFontSize {
127    #[serde(default)]
128    pub persist: bool,
129}
130
131/// Opens the settings editor at a specific path.
132#[derive(PartialEq, Clone, Debug, Deserialize, JsonSchema, Action)]
133#[action(namespace = zed)]
134#[serde(deny_unknown_fields)]
135pub struct OpenSettingsAt {
136    /// A path to a specific setting (e.g. `theme.mode`)
137    pub path: String,
138}
139
140/// Resets the buffer font size to the default value.
141#[derive(PartialEq, Clone, Default, Debug, Deserialize, JsonSchema, Action)]
142#[action(namespace = zed)]
143#[serde(deny_unknown_fields)]
144pub struct ResetBufferFontSize {
145    #[serde(default)]
146    pub persist: bool,
147}
148
149/// Decreases the font size of the user interface.
150#[derive(PartialEq, Clone, Default, Debug, Deserialize, JsonSchema, Action)]
151#[action(namespace = zed)]
152#[serde(deny_unknown_fields)]
153pub struct DecreaseUiFontSize {
154    #[serde(default)]
155    pub persist: bool,
156}
157
158/// Increases the font size of the user interface.
159#[derive(PartialEq, Clone, Default, Debug, Deserialize, JsonSchema, Action)]
160#[action(namespace = zed)]
161#[serde(deny_unknown_fields)]
162pub struct IncreaseUiFontSize {
163    #[serde(default)]
164    pub persist: bool,
165}
166
167/// Resets the UI font size to the default value.
168#[derive(PartialEq, Clone, Default, Debug, Deserialize, JsonSchema, Action)]
169#[action(namespace = zed)]
170#[serde(deny_unknown_fields)]
171pub struct ResetUiFontSize {
172    #[serde(default)]
173    pub persist: bool,
174}
175
176/// Resets all zoom levels (UI and buffer font sizes, including in the agent panel) to their default values.
177#[derive(PartialEq, Clone, Default, Debug, Deserialize, JsonSchema, Action)]
178#[action(namespace = zed)]
179#[serde(deny_unknown_fields)]
180pub struct ResetAllZoom {
181    #[serde(default)]
182    pub persist: bool,
183}
184
185pub mod editor {
186    use gpui::actions;
187    actions!(
188        editor,
189        [
190            /// Moves cursor up.
191            MoveUp,
192            /// Moves cursor down.
193            MoveDown,
194        ]
195    );
196}
197
198pub mod dev {
199    use gpui::actions;
200
201    actions!(
202        dev,
203        [
204            /// Toggles the developer inspector for debugging UI elements.
205            ToggleInspector
206        ]
207    );
208}
209
210pub mod remote_debug {
211    use gpui::actions;
212
213    actions!(
214        remote_debug,
215        [
216            /// Simulates a disconnection from the remote server for testing purposes.
217            /// This will trigger the reconnection logic.
218            SimulateDisconnect,
219            /// Simulates a timeout/slow connection to the remote server for testing purposes.
220            /// This will cause heartbeat failures and trigger reconnection.
221            SimulateTimeout,
222            /// Simulates a timeout/slow connection to the remote server for testing purposes.
223            /// This will cause heartbeat failures and attempting a reconnection while having exhausted all attempts.
224            SimulateTimeoutExhausted,
225        ]
226    );
227}
228
229pub mod workspace {
230    use gpui::actions;
231
232    actions!(
233        workspace,
234        [
235            #[action(deprecated_aliases = ["editor::CopyPath", "outline_panel::CopyPath", "project_panel::CopyPath"])]
236            CopyPath,
237            #[action(deprecated_aliases = ["editor::CopyRelativePath", "outline_panel::CopyRelativePath", "project_panel::CopyRelativePath"])]
238            CopyRelativePath,
239            /// Opens the selected file with the system's default application.
240            #[action(deprecated_aliases = ["project_panel::OpenWithSystem"])]
241            OpenWithSystem,
242        ]
243    );
244}
245
246pub mod git {
247    use gpui::actions;
248
249    actions!(
250        git,
251        [
252            /// Checks out a different git branch.
253            CheckoutBranch,
254            /// Switches to a different git branch.
255            Switch,
256            /// Selects a different repository.
257            SelectRepo,
258            /// Filter remotes.
259            FilterRemotes,
260            /// Create a git remote.
261            CreateRemote,
262            /// Opens the git branch selector.
263            #[action(deprecated_aliases = ["branches::OpenRecent"])]
264            Branch,
265            /// Opens the git stash selector.
266            ViewStash,
267            /// Opens the git worktree selector.
268            Worktree,
269            /// Creates a pull request for the current branch.
270            CreatePullRequest
271        ]
272    );
273}
274
275pub mod toast {
276    use gpui::actions;
277
278    actions!(
279        toast,
280        [
281            /// Runs the action associated with a toast notification.
282            RunAction
283        ]
284    );
285}
286
287pub mod command_palette {
288    use gpui::actions;
289
290    actions!(
291        command_palette,
292        [
293            /// Toggles the command palette.
294            Toggle,
295        ]
296    );
297}
298
299pub mod project_panel {
300    use gpui::actions;
301
302    actions!(
303        project_panel,
304        [
305            /// Toggles the project panel.
306            Toggle,
307            /// Toggles focus on the project panel.
308            ToggleFocus
309        ]
310    );
311}
312pub mod feedback {
313    use gpui::actions;
314
315    actions!(
316        feedback,
317        [
318            /// Opens email client to send feedback to Zed support.
319            EmailZed,
320            /// Opens the bug report form.
321            FileBugReport,
322            /// Opens the feature request form.
323            RequestFeature
324        ]
325    );
326}
327
328pub mod theme_selector {
329    use gpui::Action;
330    use schemars::JsonSchema;
331    use serde::Deserialize;
332
333    /// Toggles the theme selector interface.
334    #[derive(PartialEq, Clone, Default, Debug, Deserialize, JsonSchema, Action)]
335    #[action(namespace = theme_selector)]
336    #[serde(deny_unknown_fields)]
337    pub struct Toggle {
338        /// A list of theme names to filter the theme selector down to.
339        pub themes_filter: Option<Vec<String>>,
340    }
341}
342
343pub mod icon_theme_selector {
344    use gpui::Action;
345    use schemars::JsonSchema;
346    use serde::Deserialize;
347
348    /// Toggles the icon theme selector interface.
349    #[derive(PartialEq, Clone, Default, Debug, Deserialize, JsonSchema, Action)]
350    #[action(namespace = icon_theme_selector)]
351    #[serde(deny_unknown_fields)]
352    pub struct Toggle {
353        /// A list of icon theme names to filter the theme selector down to.
354        pub themes_filter: Option<Vec<String>>,
355    }
356}
357
358pub mod search {
359    use gpui::actions;
360    actions!(
361        search,
362        [
363            /// Toggles searching in ignored files.
364            ToggleIncludeIgnored
365        ]
366    );
367}
368pub mod buffer_search {
369    use gpui::{Action, actions};
370    use schemars::JsonSchema;
371    use serde::Deserialize;
372
373    /// Opens the buffer search interface with the specified configuration.
374    #[derive(PartialEq, Clone, Deserialize, JsonSchema, Action)]
375    #[action(namespace = buffer_search)]
376    #[serde(deny_unknown_fields)]
377    pub struct Deploy {
378        #[serde(default = "util::serde::default_true")]
379        pub focus: bool,
380        #[serde(default)]
381        pub replace_enabled: bool,
382        #[serde(default)]
383        pub selection_search_enabled: bool,
384    }
385
386    impl Deploy {
387        pub fn find() -> Self {
388            Self {
389                focus: true,
390                replace_enabled: false,
391                selection_search_enabled: false,
392            }
393        }
394
395        pub fn replace() -> Self {
396            Self {
397                focus: true,
398                replace_enabled: true,
399                selection_search_enabled: false,
400            }
401        }
402    }
403
404    actions!(
405        buffer_search,
406        [
407            /// Deploys the search and replace interface.
408            DeployReplace,
409            /// Dismisses the search bar.
410            Dismiss,
411            /// Focuses back on the editor.
412            FocusEditor
413        ]
414    );
415}
416pub mod settings_profile_selector {
417    use gpui::Action;
418    use schemars::JsonSchema;
419    use serde::Deserialize;
420
421    #[derive(PartialEq, Clone, Default, Debug, Deserialize, JsonSchema, Action)]
422    #[action(namespace = settings_profile_selector)]
423    pub struct Toggle;
424}
425
426pub mod agent {
427    use gpui::{Action, SharedString, actions};
428    use schemars::JsonSchema;
429    use serde::Deserialize;
430
431    actions!(
432        agent,
433        [
434            /// Opens the agent settings panel.
435            #[action(deprecated_aliases = ["agent::OpenConfiguration"])]
436            OpenSettings,
437            /// Opens the agent onboarding modal.
438            OpenOnboardingModal,
439            /// Opens the ACP onboarding modal.
440            OpenAcpOnboardingModal,
441            /// Opens the Claude Agent onboarding modal.
442            OpenClaudeAgentOnboardingModal,
443            /// Resets the agent onboarding state.
444            ResetOnboarding,
445            /// Starts a chat conversation with the agent.
446            Chat,
447            /// Toggles the language model selector dropdown.
448            #[action(deprecated_aliases = ["assistant::ToggleModelSelector", "assistant2::ToggleModelSelector"])]
449            ToggleModelSelector,
450            /// Triggers re-authentication on Gemini
451            ReauthenticateAgent,
452            /// Add the current selection as context for threads in the agent panel.
453            #[action(deprecated_aliases = ["assistant::QuoteSelection", "agent::QuoteSelection"])]
454            AddSelectionToThread,
455            /// Resets the agent panel zoom levels (agent UI and buffer font sizes).
456            ResetAgentZoom,
457            /// Pastes clipboard content without any formatting.
458            PasteRaw,
459            /// Toggles the agent singleton mode for the current window.
460            ToggleAgentMode,
461        ]
462    );
463
464    /// Opens a new agent thread with the provided branch diff for review.
465    #[derive(Clone, PartialEq, Deserialize, JsonSchema, Action)]
466    #[action(namespace = agent)]
467    #[serde(deny_unknown_fields)]
468    pub struct ReviewBranchDiff {
469        /// The full text of the diff to review.
470        pub diff_text: SharedString,
471        /// The base ref that the diff was computed against (e.g. "main").
472        pub base_ref: SharedString,
473    }
474}
475
476pub mod assistant {
477    use gpui::{Action, actions};
478    use schemars::JsonSchema;
479    use serde::Deserialize;
480    use uuid::Uuid;
481
482    actions!(
483        agent,
484        [
485            /// Toggles the agent panel.
486            Toggle,
487            #[action(deprecated_aliases = ["assistant::ToggleFocus"])]
488            ToggleFocus
489        ]
490    );
491
492    actions!(
493        assistant,
494        [
495            /// Shows the assistant configuration panel.
496            ShowConfiguration
497        ]
498    );
499
500    /// Opens the rules library for managing agent rules and prompts.
501    #[derive(PartialEq, Clone, Default, Debug, Deserialize, JsonSchema, Action)]
502    #[action(namespace = agent, deprecated_aliases = ["assistant::OpenRulesLibrary", "assistant::DeployPromptLibrary"])]
503    #[serde(deny_unknown_fields)]
504    pub struct OpenRulesLibrary {
505        #[serde(skip)]
506        pub prompt_to_select: Option<Uuid>,
507    }
508
509    /// Deploys the assistant interface with the specified configuration.
510    #[derive(Clone, Default, Deserialize, PartialEq, JsonSchema, Action)]
511    #[action(namespace = assistant)]
512    #[serde(deny_unknown_fields)]
513    pub struct InlineAssist {
514        pub prompt: Option<String>,
515    }
516}
517
518/// Opens the recent projects interface.
519#[derive(PartialEq, Clone, Deserialize, Default, JsonSchema, Action)]
520#[action(namespace = projects)]
521#[serde(deny_unknown_fields)]
522pub struct OpenRecent {
523    #[serde(default)]
524    pub create_new_window: bool,
525}
526
527/// Creates a project from a selected template.
528#[derive(PartialEq, Clone, Deserialize, Default, JsonSchema, Action)]
529#[action(namespace = projects)]
530#[serde(deny_unknown_fields)]
531pub struct OpenRemote {
532    #[serde(default)]
533    pub from_existing_connection: bool,
534    #[serde(default)]
535    pub create_new_window: bool,
536}
537
538/// Opens the dev container connection modal.
539#[derive(PartialEq, Clone, Deserialize, Default, JsonSchema, Action)]
540#[action(namespace = projects)]
541#[serde(deny_unknown_fields)]
542pub struct OpenDevContainer;
543
544/// Where to spawn the task in the UI.
545#[derive(Default, Clone, Copy, Debug, PartialEq, Eq, Serialize, Deserialize, JsonSchema)]
546#[serde(rename_all = "snake_case")]
547pub enum RevealTarget {
548    /// In the central pane group, "main" editor area.
549    Center,
550    /// In the terminal dock, "regular" terminal items' place.
551    #[default]
552    Dock,
553}
554
555/// Spawns a task with name or opens tasks modal.
556#[derive(Debug, PartialEq, Clone, Deserialize, JsonSchema, Action)]
557#[action(namespace = task)]
558#[serde(untagged)]
559pub enum Spawn {
560    /// Spawns a task by the name given.
561    ByName {
562        task_name: String,
563        #[serde(default)]
564        reveal_target: Option<RevealTarget>,
565    },
566    /// Spawns a task by the tag given.
567    ByTag {
568        task_tag: String,
569        #[serde(default)]
570        reveal_target: Option<RevealTarget>,
571    },
572    /// Spawns a task via modal's selection.
573    ViaModal {
574        /// Selected task's `reveal_target` property override.
575        #[serde(default)]
576        reveal_target: Option<RevealTarget>,
577    },
578}
579
580impl Spawn {
581    pub fn modal() -> Self {
582        Self::ViaModal {
583            reveal_target: None,
584        }
585    }
586}
587
588/// Reruns the last task.
589#[derive(PartialEq, Clone, Deserialize, Default, JsonSchema, Action)]
590#[action(namespace = task)]
591#[serde(deny_unknown_fields)]
592pub struct Rerun {
593    /// Controls whether the task context is reevaluated prior to execution of a task.
594    /// 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
595    /// If it is, these variables will be updated to reflect current state of editor at the time task::Rerun is executed.
596    /// default: false
597    #[serde(default)]
598    pub reevaluate_context: bool,
599    /// Overrides `allow_concurrent_runs` property of the task being reran.
600    /// Default: null
601    #[serde(default)]
602    pub allow_concurrent_runs: Option<bool>,
603    /// Overrides `use_new_terminal` property of the task being reran.
604    /// Default: null
605    #[serde(default)]
606    pub use_new_terminal: Option<bool>,
607
608    /// If present, rerun the task with this ID, otherwise rerun the last task.
609    #[serde(skip)]
610    pub task_id: Option<String>,
611}
612
613pub mod outline {
614    use std::sync::OnceLock;
615
616    use gpui::{AnyView, App, Window, actions};
617
618    actions!(
619        outline,
620        [
621            #[action(name = "Toggle")]
622            ToggleOutline
623        ]
624    );
625    /// A pointer to outline::toggle function, exposed here to sewer the breadcrumbs <-> outline dependency.
626    pub static TOGGLE_OUTLINE: OnceLock<fn(AnyView, &mut Window, &mut App)> = OnceLock::new();
627}
628
629actions!(
630    zed_predict_onboarding,
631    [
632        /// Opens the Zed Predict onboarding modal.
633        OpenZedPredictOnboarding
634    ]
635);
636actions!(
637    git_onboarding,
638    [
639        /// Opens the git integration onboarding modal.
640        OpenGitIntegrationOnboarding
641    ]
642);
643
644pub mod debug_panel {
645    use gpui::actions;
646    actions!(
647        debug_panel,
648        [
649            /// Toggles the debug panel.
650            Toggle,
651            /// Toggles focus on the debug panel.
652            ToggleFocus
653        ]
654    );
655}
656
657actions!(
658    debugger,
659    [
660        /// Toggles the enabled state of a breakpoint.
661        ToggleEnableBreakpoint,
662        /// Removes a breakpoint.
663        UnsetBreakpoint,
664        /// Opens the project debug tasks configuration.
665        OpenProjectDebugTasks,
666    ]
667);
668
669pub mod vim {
670    use gpui::actions;
671
672    actions!(
673        vim,
674        [
675            /// Opens the default keymap file.
676            OpenDefaultKeymap
677        ]
678    );
679}
680
681#[derive(Debug, Clone, PartialEq, Eq, Hash)]
682pub struct WslConnectionOptions {
683    pub distro_name: String,
684    pub user: Option<String>,
685}
686
687#[cfg(target_os = "windows")]
688pub mod wsl_actions {
689    use gpui::Action;
690    use schemars::JsonSchema;
691    use serde::Deserialize;
692
693    /// Opens a folder inside Wsl.
694    #[derive(PartialEq, Clone, Deserialize, Default, JsonSchema, Action)]
695    #[action(namespace = projects)]
696    #[serde(deny_unknown_fields)]
697    pub struct OpenFolderInWsl {
698        #[serde(default)]
699        pub create_new_window: bool,
700    }
701
702    /// Open a wsl distro.
703    #[derive(PartialEq, Clone, Deserialize, Default, JsonSchema, Action)]
704    #[action(namespace = projects)]
705    #[serde(deny_unknown_fields)]
706    pub struct OpenWsl {
707        #[serde(default)]
708        pub create_new_window: bool,
709    }
710}
711
712pub mod preview {
713    pub mod markdown {
714        use gpui::actions;
715
716        actions!(
717            markdown,
718            [
719                /// Opens a markdown preview for the current file.
720                OpenPreview,
721                /// Opens a markdown preview in a split pane.
722                OpenPreviewToTheSide,
723            ]
724        );
725    }
726
727    pub mod svg {
728        use gpui::actions;
729
730        actions!(
731            svg,
732            [
733                /// Opens an SVG preview for the current file.
734                OpenPreview,
735                /// Opens an SVG preview in a split pane.
736                OpenPreviewToTheSide,
737            ]
738        );
739    }
740}
741
742pub mod notebook {
743    use gpui::actions;
744
745    actions!(
746        notebook,
747        [
748            /// Move to down in cells
749            NotebookMoveDown,
750            /// Move to up in cells
751            NotebookMoveUp,
752        ]
753    );
754}