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    ]
 74);
 75
 76#[derive(PartialEq, Clone, Copy, Debug, Deserialize, JsonSchema)]
 77#[serde(rename_all = "snake_case")]
 78pub enum ExtensionCategoryFilter {
 79    Themes,
 80    IconThemes,
 81    Languages,
 82    Grammars,
 83    LanguageServers,
 84    ContextServers,
 85    AgentServers,
 86    SlashCommands,
 87    IndexedDocsProviders,
 88    Snippets,
 89    DebugAdapters,
 90}
 91
 92/// Opens the extensions management interface.
 93#[derive(PartialEq, Clone, Default, Debug, Deserialize, JsonSchema, Action)]
 94#[action(namespace = zed)]
 95#[serde(deny_unknown_fields)]
 96pub struct Extensions {
 97    /// Filters the extensions page down to extensions that are in the specified category.
 98    #[serde(default)]
 99    pub category_filter: Option<ExtensionCategoryFilter>,
100    /// Focuses just the extension with the specified ID.
101    #[serde(default)]
102    pub id: Option<String>,
103}
104
105/// Decreases the font size in the editor buffer.
106#[derive(PartialEq, Clone, Default, Debug, Deserialize, JsonSchema, Action)]
107#[action(namespace = zed)]
108#[serde(deny_unknown_fields)]
109pub struct DecreaseBufferFontSize {
110    #[serde(default)]
111    pub persist: bool,
112}
113
114/// Increases the font size in the editor buffer.
115#[derive(PartialEq, Clone, Default, Debug, Deserialize, JsonSchema, Action)]
116#[action(namespace = zed)]
117#[serde(deny_unknown_fields)]
118pub struct IncreaseBufferFontSize {
119    #[serde(default)]
120    pub persist: bool,
121}
122
123/// Increases the font size in the editor buffer.
124#[derive(PartialEq, Clone, Debug, Deserialize, JsonSchema, Action)]
125#[action(namespace = zed)]
126#[serde(deny_unknown_fields)]
127pub struct OpenSettingsAt {
128    /// A path to a specific setting (e.g. `theme.mode`)
129    pub path: String,
130}
131
132/// Resets the buffer font size to the default value.
133#[derive(PartialEq, Clone, Default, Debug, Deserialize, JsonSchema, Action)]
134#[action(namespace = zed)]
135#[serde(deny_unknown_fields)]
136pub struct ResetBufferFontSize {
137    #[serde(default)]
138    pub persist: bool,
139}
140
141/// Decreases the font size of the user interface.
142#[derive(PartialEq, Clone, Default, Debug, Deserialize, JsonSchema, Action)]
143#[action(namespace = zed)]
144#[serde(deny_unknown_fields)]
145pub struct DecreaseUiFontSize {
146    #[serde(default)]
147    pub persist: bool,
148}
149
150/// Increases the font size of the user interface.
151#[derive(PartialEq, Clone, Default, Debug, Deserialize, JsonSchema, Action)]
152#[action(namespace = zed)]
153#[serde(deny_unknown_fields)]
154pub struct IncreaseUiFontSize {
155    #[serde(default)]
156    pub persist: bool,
157}
158
159/// Resets the UI font size to the default value.
160#[derive(PartialEq, Clone, Default, Debug, Deserialize, JsonSchema, Action)]
161#[action(namespace = zed)]
162#[serde(deny_unknown_fields)]
163pub struct ResetUiFontSize {
164    #[serde(default)]
165    pub persist: bool,
166}
167
168/// Resets all zoom levels (UI and buffer font sizes, including in the agent panel) to their default values.
169#[derive(PartialEq, Clone, Default, Debug, Deserialize, JsonSchema, Action)]
170#[action(namespace = zed)]
171#[serde(deny_unknown_fields)]
172pub struct ResetAllZoom {
173    #[serde(default)]
174    pub persist: bool,
175}
176
177pub mod dev {
178    use gpui::actions;
179
180    actions!(
181        dev,
182        [
183            /// Toggles the developer inspector for debugging UI elements.
184            ToggleInspector
185        ]
186    );
187}
188
189pub mod workspace {
190    use gpui::actions;
191
192    actions!(
193        workspace,
194        [
195            #[action(deprecated_aliases = ["editor::CopyPath", "outline_panel::CopyPath", "project_panel::CopyPath"])]
196            CopyPath,
197            #[action(deprecated_aliases = ["editor::CopyRelativePath", "outline_panel::CopyRelativePath", "project_panel::CopyRelativePath"])]
198            CopyRelativePath,
199            /// Opens the selected file with the system's default application.
200            #[action(deprecated_aliases = ["project_panel::OpenWithSystem"])]
201            OpenWithSystem,
202        ]
203    );
204}
205
206pub mod git {
207    use gpui::actions;
208
209    actions!(
210        git,
211        [
212            /// Checks out a different git branch.
213            CheckoutBranch,
214            /// Switches to a different git branch.
215            Switch,
216            /// Selects a different repository.
217            SelectRepo,
218            /// Opens the git branch selector.
219            #[action(deprecated_aliases = ["branches::OpenRecent"])]
220            Branch,
221            /// Opens the git stash selector.
222            ViewStash,
223            /// Opens the git worktree selector.
224            Worktree
225        ]
226    );
227}
228
229pub mod toast {
230    use gpui::actions;
231
232    actions!(
233        toast,
234        [
235            /// Runs the action associated with a toast notification.
236            RunAction
237        ]
238    );
239}
240
241pub mod command_palette {
242    use gpui::actions;
243
244    actions!(
245        command_palette,
246        [
247            /// Toggles the command palette.
248            Toggle,
249        ]
250    );
251}
252
253pub mod feedback {
254    use gpui::actions;
255
256    actions!(
257        feedback,
258        [
259            /// Opens email client to send feedback to Zed support.
260            EmailZed,
261            /// Opens the bug report form.
262            FileBugReport,
263            /// Opens the feature request form.
264            RequestFeature
265        ]
266    );
267}
268
269pub mod theme_selector {
270    use gpui::Action;
271    use schemars::JsonSchema;
272    use serde::Deserialize;
273
274    /// Toggles the theme selector interface.
275    #[derive(PartialEq, Clone, Default, Debug, Deserialize, JsonSchema, Action)]
276    #[action(namespace = theme_selector)]
277    #[serde(deny_unknown_fields)]
278    pub struct Toggle {
279        /// A list of theme names to filter the theme selector down to.
280        pub themes_filter: Option<Vec<String>>,
281    }
282}
283
284pub mod icon_theme_selector {
285    use gpui::Action;
286    use schemars::JsonSchema;
287    use serde::Deserialize;
288
289    /// Toggles the icon theme selector interface.
290    #[derive(PartialEq, Clone, Default, Debug, Deserialize, JsonSchema, Action)]
291    #[action(namespace = icon_theme_selector)]
292    #[serde(deny_unknown_fields)]
293    pub struct Toggle {
294        /// A list of icon theme names to filter the theme selector down to.
295        pub themes_filter: Option<Vec<String>>,
296    }
297}
298
299pub mod settings_profile_selector {
300    use gpui::Action;
301    use schemars::JsonSchema;
302    use serde::Deserialize;
303
304    #[derive(PartialEq, Clone, Default, Debug, Deserialize, JsonSchema, Action)]
305    #[action(namespace = settings_profile_selector)]
306    pub struct Toggle;
307}
308
309pub mod agent {
310    use gpui::actions;
311
312    actions!(
313        agent,
314        [
315            /// Opens the agent settings panel.
316            #[action(deprecated_aliases = ["agent::OpenConfiguration"])]
317            OpenSettings,
318            /// Opens the agent onboarding modal.
319            OpenOnboardingModal,
320            /// Opens the ACP onboarding modal.
321            OpenAcpOnboardingModal,
322            /// Opens the Claude Code onboarding modal.
323            OpenClaudeCodeOnboardingModal,
324            /// Resets the agent onboarding state.
325            ResetOnboarding,
326            /// Starts a chat conversation with the agent.
327            Chat,
328            /// Toggles the language model selector dropdown.
329            #[action(deprecated_aliases = ["assistant::ToggleModelSelector", "assistant2::ToggleModelSelector"])]
330            ToggleModelSelector,
331            /// Triggers re-authentication on Gemini
332            ReauthenticateAgent,
333            /// Add the current selection as context for threads in the agent panel.
334            #[action(deprecated_aliases = ["assistant::QuoteSelection", "agent::QuoteSelection"])]
335            AddSelectionToThread,
336            /// Resets the agent panel zoom levels (agent UI and buffer font sizes).
337            ResetAgentZoom,
338        ]
339    );
340}
341
342pub mod assistant {
343    use gpui::{Action, actions};
344    use schemars::JsonSchema;
345    use serde::Deserialize;
346    use uuid::Uuid;
347
348    actions!(
349        agent,
350        [
351            #[action(deprecated_aliases = ["assistant::ToggleFocus"])]
352            ToggleFocus
353        ]
354    );
355
356    actions!(
357        assistant,
358        [
359            /// Shows the assistant configuration panel.
360            ShowConfiguration
361        ]
362    );
363
364    /// Opens the rules library for managing agent rules and prompts.
365    #[derive(PartialEq, Clone, Default, Debug, Deserialize, JsonSchema, Action)]
366    #[action(namespace = agent, deprecated_aliases = ["assistant::OpenRulesLibrary", "assistant::DeployPromptLibrary"])]
367    #[serde(deny_unknown_fields)]
368    pub struct OpenRulesLibrary {
369        #[serde(skip)]
370        pub prompt_to_select: Option<Uuid>,
371    }
372
373    /// Deploys the assistant interface with the specified configuration.
374    #[derive(Clone, Default, Deserialize, PartialEq, JsonSchema, Action)]
375    #[action(namespace = assistant)]
376    #[serde(deny_unknown_fields)]
377    pub struct InlineAssist {
378        pub prompt: Option<String>,
379    }
380}
381
382pub mod debugger {
383    use gpui::actions;
384
385    actions!(
386        debugger,
387        [
388            /// Opens the debugger onboarding modal.
389            OpenOnboardingModal,
390            /// Resets the debugger onboarding state.
391            ResetOnboarding
392        ]
393    );
394}
395
396/// Opens the recent projects interface.
397#[derive(PartialEq, Clone, Deserialize, Default, JsonSchema, Action)]
398#[action(namespace = projects)]
399#[serde(deny_unknown_fields)]
400pub struct OpenRecent {
401    #[serde(default)]
402    pub create_new_window: bool,
403}
404
405/// Creates a project from a selected template.
406#[derive(PartialEq, Clone, Deserialize, Default, JsonSchema, Action)]
407#[action(namespace = projects)]
408#[serde(deny_unknown_fields)]
409pub struct OpenRemote {
410    #[serde(default)]
411    pub from_existing_connection: bool,
412    #[serde(default)]
413    pub create_new_window: bool,
414}
415
416/// Where to spawn the task in the UI.
417#[derive(Default, Clone, Copy, Debug, PartialEq, Eq, Serialize, Deserialize, JsonSchema)]
418#[serde(rename_all = "snake_case")]
419pub enum RevealTarget {
420    /// In the central pane group, "main" editor area.
421    Center,
422    /// In the terminal dock, "regular" terminal items' place.
423    #[default]
424    Dock,
425}
426
427/// Spawns a task with name or opens tasks modal.
428#[derive(Debug, PartialEq, Clone, Deserialize, JsonSchema, Action)]
429#[action(namespace = task)]
430#[serde(untagged)]
431pub enum Spawn {
432    /// Spawns a task by the name given.
433    ByName {
434        task_name: String,
435        #[serde(default)]
436        reveal_target: Option<RevealTarget>,
437    },
438    /// Spawns a task by the name given.
439    ByTag {
440        task_tag: String,
441        #[serde(default)]
442        reveal_target: Option<RevealTarget>,
443    },
444    /// Spawns a task via modal's selection.
445    ViaModal {
446        /// Selected task's `reveal_target` property override.
447        #[serde(default)]
448        reveal_target: Option<RevealTarget>,
449    },
450}
451
452impl Spawn {
453    pub fn modal() -> Self {
454        Self::ViaModal {
455            reveal_target: None,
456        }
457    }
458}
459
460/// Reruns the last task.
461#[derive(PartialEq, Clone, Deserialize, Default, JsonSchema, Action)]
462#[action(namespace = task)]
463#[serde(deny_unknown_fields)]
464pub struct Rerun {
465    /// Controls whether the task context is reevaluated prior to execution of a task.
466    /// 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
467    /// If it is, these variables will be updated to reflect current state of editor at the time task::Rerun is executed.
468    /// default: false
469    #[serde(default)]
470    pub reevaluate_context: bool,
471    /// Overrides `allow_concurrent_runs` property of the task being reran.
472    /// Default: null
473    #[serde(default)]
474    pub allow_concurrent_runs: Option<bool>,
475    /// Overrides `use_new_terminal` property of the task being reran.
476    /// Default: null
477    #[serde(default)]
478    pub use_new_terminal: Option<bool>,
479
480    /// If present, rerun the task with this ID, otherwise rerun the last task.
481    #[serde(skip)]
482    pub task_id: Option<String>,
483}
484
485pub mod outline {
486    use std::sync::OnceLock;
487
488    use gpui::{AnyView, App, Window, actions};
489
490    actions!(
491        outline,
492        [
493            #[action(name = "Toggle")]
494            ToggleOutline
495        ]
496    );
497    /// A pointer to outline::toggle function, exposed here to sewer the breadcrumbs <-> outline dependency.
498    pub static TOGGLE_OUTLINE: OnceLock<fn(AnyView, &mut Window, &mut App)> = OnceLock::new();
499}
500
501actions!(
502    zed_predict_onboarding,
503    [
504        /// Opens the Zed Predict onboarding modal.
505        OpenZedPredictOnboarding
506    ]
507);
508actions!(
509    git_onboarding,
510    [
511        /// Opens the git integration onboarding modal.
512        OpenGitIntegrationOnboarding
513    ]
514);
515
516actions!(
517    debug_panel,
518    [
519        /// Toggles focus on the debug panel.
520        ToggleFocus
521    ]
522);
523actions!(
524    debugger,
525    [
526        /// Toggles the enabled state of a breakpoint.
527        ToggleEnableBreakpoint,
528        /// Removes a breakpoint.
529        UnsetBreakpoint,
530        /// Opens the project debug tasks configuration.
531        OpenProjectDebugTasks,
532    ]
533);
534
535#[derive(Debug, Clone, PartialEq, Eq, Hash)]
536pub struct WslConnectionOptions {
537    pub distro_name: String,
538    pub user: Option<String>,
539}
540
541#[cfg(target_os = "windows")]
542pub mod wsl_actions {
543    use gpui::Action;
544    use schemars::JsonSchema;
545    use serde::Deserialize;
546
547    /// Opens a folder inside Wsl.
548    #[derive(PartialEq, Clone, Deserialize, Default, JsonSchema, Action)]
549    #[action(namespace = projects)]
550    #[serde(deny_unknown_fields)]
551    pub struct OpenFolderInWsl {
552        #[serde(default)]
553        pub create_new_window: bool,
554    }
555
556    /// Open a wsl distro.
557    #[derive(PartialEq, Clone, Deserialize, Default, JsonSchema, Action)]
558    #[action(namespace = projects)]
559    #[serde(deny_unknown_fields)]
560    pub struct OpenWsl {
561        #[serde(default)]
562        pub create_new_window: bool,
563    }
564}