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