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 the default keymap file.
 47        OpenDefaultKeymap,
 48        /// Opens the user keymap file.
 49        #[action(deprecated_aliases = ["zed_actions::OpenKeymap"])]
 50        OpenKeymapFile,
 51        /// Opens the keymap editor.
 52        #[action(deprecated_aliases = ["zed_actions::OpenKeymapEditor"])]
 53        OpenKeymap,
 54        /// Opens account settings.
 55        OpenAccountSettings,
 56        /// Opens server settings.
 57        OpenServerSettings,
 58        /// Quits the application.
 59        Quit,
 60        /// Shows information about Zed.
 61        About,
 62        /// Opens the documentation website.
 63        OpenDocs,
 64        /// Views open source licenses.
 65        OpenLicenses,
 66        /// Opens the telemetry log.
 67        OpenTelemetryLog,
 68    ]
 69);
 70
 71#[derive(PartialEq, Clone, Copy, Debug, Deserialize, JsonSchema)]
 72#[serde(rename_all = "snake_case")]
 73pub enum ExtensionCategoryFilter {
 74    Themes,
 75    IconThemes,
 76    Languages,
 77    Grammars,
 78    LanguageServers,
 79    ContextServers,
 80    AgentServers,
 81    SlashCommands,
 82    IndexedDocsProviders,
 83    Snippets,
 84    DebugAdapters,
 85}
 86
 87/// Opens the extensions management interface.
 88#[derive(PartialEq, Clone, Default, Debug, Deserialize, JsonSchema, Action)]
 89#[action(namespace = zed)]
 90#[serde(deny_unknown_fields)]
 91pub struct Extensions {
 92    /// Filters the extensions page down to extensions that are in the specified category.
 93    #[serde(default)]
 94    pub category_filter: Option<ExtensionCategoryFilter>,
 95    /// Focuses just the extension with the specified ID.
 96    #[serde(default)]
 97    pub id: Option<String>,
 98}
 99
100/// Decreases the font size in the editor buffer.
101#[derive(PartialEq, Clone, Default, Debug, Deserialize, JsonSchema, Action)]
102#[action(namespace = zed)]
103#[serde(deny_unknown_fields)]
104pub struct DecreaseBufferFontSize {
105    #[serde(default)]
106    pub persist: bool,
107}
108
109/// Increases the font size in the editor buffer.
110#[derive(PartialEq, Clone, Default, Debug, Deserialize, JsonSchema, Action)]
111#[action(namespace = zed)]
112#[serde(deny_unknown_fields)]
113pub struct IncreaseBufferFontSize {
114    #[serde(default)]
115    pub persist: bool,
116}
117
118/// Increases the font size in the editor buffer.
119#[derive(PartialEq, Clone, Debug, Deserialize, JsonSchema, Action)]
120#[action(namespace = zed)]
121#[serde(deny_unknown_fields)]
122pub struct OpenSettingsAt {
123    /// A path to a specific setting (e.g. `theme.mode`)
124    pub path: String,
125}
126
127/// Resets the buffer font size to the default value.
128#[derive(PartialEq, Clone, Default, Debug, Deserialize, JsonSchema, Action)]
129#[action(namespace = zed)]
130#[serde(deny_unknown_fields)]
131pub struct ResetBufferFontSize {
132    #[serde(default)]
133    pub persist: bool,
134}
135
136/// Decreases the font size of the user interface.
137#[derive(PartialEq, Clone, Default, Debug, Deserialize, JsonSchema, Action)]
138#[action(namespace = zed)]
139#[serde(deny_unknown_fields)]
140pub struct DecreaseUiFontSize {
141    #[serde(default)]
142    pub persist: bool,
143}
144
145/// Increases the font size of the user interface.
146#[derive(PartialEq, Clone, Default, Debug, Deserialize, JsonSchema, Action)]
147#[action(namespace = zed)]
148#[serde(deny_unknown_fields)]
149pub struct IncreaseUiFontSize {
150    #[serde(default)]
151    pub persist: bool,
152}
153
154/// Resets the UI font size to the default value.
155#[derive(PartialEq, Clone, Default, Debug, Deserialize, JsonSchema, Action)]
156#[action(namespace = zed)]
157#[serde(deny_unknown_fields)]
158pub struct ResetUiFontSize {
159    #[serde(default)]
160    pub persist: bool,
161}
162
163/// Resets all zoom levels (UI and buffer font sizes, including in the agent panel) to their default values.
164#[derive(PartialEq, Clone, Default, Debug, Deserialize, JsonSchema, Action)]
165#[action(namespace = zed)]
166#[serde(deny_unknown_fields)]
167pub struct ResetAllZoom {
168    #[serde(default)]
169    pub persist: bool,
170}
171
172pub mod dev {
173    use gpui::actions;
174
175    actions!(
176        dev,
177        [
178            /// Toggles the developer inspector for debugging UI elements.
179            ToggleInspector
180        ]
181    );
182}
183
184pub mod workspace {
185    use gpui::actions;
186
187    actions!(
188        workspace,
189        [
190            #[action(deprecated_aliases = ["editor::CopyPath", "outline_panel::CopyPath", "project_panel::CopyPath"])]
191            CopyPath,
192            #[action(deprecated_aliases = ["editor::CopyRelativePath", "outline_panel::CopyRelativePath", "project_panel::CopyRelativePath"])]
193            CopyRelativePath,
194            /// Opens the selected file with the system's default application.
195            #[action(deprecated_aliases = ["project_panel::OpenWithSystem"])]
196            OpenWithSystem,
197        ]
198    );
199}
200
201pub mod git {
202    use gpui::actions;
203
204    actions!(
205        git,
206        [
207            /// Checks out a different git branch.
208            CheckoutBranch,
209            /// Switches to a different git branch.
210            Switch,
211            /// Selects a different repository.
212            SelectRepo,
213            /// Opens the git branch selector.
214            #[action(deprecated_aliases = ["branches::OpenRecent"])]
215            Branch,
216            /// Opens the git stash selector.
217            ViewStash
218        ]
219    );
220}
221
222pub mod toast {
223    use gpui::actions;
224
225    actions!(
226        toast,
227        [
228            /// Runs the action associated with a toast notification.
229            RunAction
230        ]
231    );
232}
233
234pub mod command_palette {
235    use gpui::actions;
236
237    actions!(
238        command_palette,
239        [
240            /// Toggles the command palette.
241            Toggle,
242        ]
243    );
244}
245
246pub mod feedback {
247    use gpui::actions;
248
249    actions!(
250        feedback,
251        [
252            /// Opens email client to send feedback to Zed support.
253            EmailZed,
254            /// Opens the bug report form.
255            FileBugReport,
256            /// Opens the feature request form.
257            RequestFeature
258        ]
259    );
260}
261
262pub mod theme_selector {
263    use gpui::Action;
264    use schemars::JsonSchema;
265    use serde::Deserialize;
266
267    /// Toggles the theme selector interface.
268    #[derive(PartialEq, Clone, Default, Debug, Deserialize, JsonSchema, Action)]
269    #[action(namespace = theme_selector)]
270    #[serde(deny_unknown_fields)]
271    pub struct Toggle {
272        /// A list of theme names to filter the theme selector down to.
273        pub themes_filter: Option<Vec<String>>,
274    }
275}
276
277pub mod icon_theme_selector {
278    use gpui::Action;
279    use schemars::JsonSchema;
280    use serde::Deserialize;
281
282    /// Toggles the icon theme selector interface.
283    #[derive(PartialEq, Clone, Default, Debug, Deserialize, JsonSchema, Action)]
284    #[action(namespace = icon_theme_selector)]
285    #[serde(deny_unknown_fields)]
286    pub struct Toggle {
287        /// A list of icon theme names to filter the theme selector down to.
288        pub themes_filter: Option<Vec<String>>,
289    }
290}
291
292pub mod settings_profile_selector {
293    use gpui::Action;
294    use schemars::JsonSchema;
295    use serde::Deserialize;
296
297    #[derive(PartialEq, Clone, Default, Debug, Deserialize, JsonSchema, Action)]
298    #[action(namespace = settings_profile_selector)]
299    pub struct Toggle;
300}
301
302pub mod encodings {
303    use gpui::Action;
304
305    #[derive(PartialEq, Debug, Clone, Action)]
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}