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 std::sync::Arc;
304
305    use gpui::Action;
306    use schemars::JsonSchema;
307    use serde::Deserialize;
308
309    #[derive(PartialEq, Debug, Clone, Action, JsonSchema, Deserialize)]
310    pub struct Toggle(pub Arc<std::path::Path>);
311}
312
313pub mod agent {
314    use gpui::actions;
315
316    actions!(
317        agent,
318        [
319            /// Opens the agent settings panel.
320            #[action(deprecated_aliases = ["agent::OpenConfiguration"])]
321            OpenSettings,
322            /// Opens the agent onboarding modal.
323            OpenOnboardingModal,
324            /// Opens the ACP onboarding modal.
325            OpenAcpOnboardingModal,
326            /// Opens the Claude Code onboarding modal.
327            OpenClaudeCodeOnboardingModal,
328            /// Resets the agent onboarding state.
329            ResetOnboarding,
330            /// Starts a chat conversation with the agent.
331            Chat,
332            /// Toggles the language model selector dropdown.
333            #[action(deprecated_aliases = ["assistant::ToggleModelSelector", "assistant2::ToggleModelSelector"])]
334            ToggleModelSelector,
335            /// Triggers re-authentication on Gemini
336            ReauthenticateAgent,
337            /// Add the current selection as context for threads in the agent panel.
338            #[action(deprecated_aliases = ["assistant::QuoteSelection", "agent::QuoteSelection"])]
339            AddSelectionToThread,
340            /// Resets the agent panel zoom levels (agent UI and buffer font sizes).
341            ResetAgentZoom,
342        ]
343    );
344}
345
346pub mod assistant {
347    use gpui::{Action, actions};
348    use schemars::JsonSchema;
349    use serde::Deserialize;
350    use uuid::Uuid;
351
352    actions!(
353        agent,
354        [
355            #[action(deprecated_aliases = ["assistant::ToggleFocus"])]
356            ToggleFocus
357        ]
358    );
359
360    actions!(
361        assistant,
362        [
363            /// Shows the assistant configuration panel.
364            ShowConfiguration
365        ]
366    );
367
368    /// Opens the rules library for managing agent rules and prompts.
369    #[derive(PartialEq, Clone, Default, Debug, Deserialize, JsonSchema, Action)]
370    #[action(namespace = agent, deprecated_aliases = ["assistant::OpenRulesLibrary", "assistant::DeployPromptLibrary"])]
371    #[serde(deny_unknown_fields)]
372    pub struct OpenRulesLibrary {
373        #[serde(skip)]
374        pub prompt_to_select: Option<Uuid>,
375    }
376
377    /// Deploys the assistant interface with the specified configuration.
378    #[derive(Clone, Default, Deserialize, PartialEq, JsonSchema, Action)]
379    #[action(namespace = assistant)]
380    #[serde(deny_unknown_fields)]
381    pub struct InlineAssist {
382        pub prompt: Option<String>,
383    }
384}
385
386pub mod debugger {
387    use gpui::actions;
388
389    actions!(
390        debugger,
391        [
392            /// Opens the debugger onboarding modal.
393            OpenOnboardingModal,
394            /// Resets the debugger onboarding state.
395            ResetOnboarding
396        ]
397    );
398}
399
400/// Opens the recent projects interface.
401#[derive(PartialEq, Clone, Deserialize, Default, JsonSchema, Action)]
402#[action(namespace = projects)]
403#[serde(deny_unknown_fields)]
404pub struct OpenRecent {
405    #[serde(default)]
406    pub create_new_window: bool,
407}
408
409/// Creates a project from a selected template.
410#[derive(PartialEq, Clone, Deserialize, Default, JsonSchema, Action)]
411#[action(namespace = projects)]
412#[serde(deny_unknown_fields)]
413pub struct OpenRemote {
414    #[serde(default)]
415    pub from_existing_connection: bool,
416    #[serde(default)]
417    pub create_new_window: bool,
418}
419
420/// Where to spawn the task in the UI.
421#[derive(Default, Clone, Copy, Debug, PartialEq, Eq, Serialize, Deserialize, JsonSchema)]
422#[serde(rename_all = "snake_case")]
423pub enum RevealTarget {
424    /// In the central pane group, "main" editor area.
425    Center,
426    /// In the terminal dock, "regular" terminal items' place.
427    #[default]
428    Dock,
429}
430
431/// Spawns a task with name or opens tasks modal.
432#[derive(Debug, PartialEq, Clone, Deserialize, JsonSchema, Action)]
433#[action(namespace = task)]
434#[serde(untagged)]
435pub enum Spawn {
436    /// Spawns a task by the name given.
437    ByName {
438        task_name: String,
439        #[serde(default)]
440        reveal_target: Option<RevealTarget>,
441    },
442    /// Spawns a task by the name given.
443    ByTag {
444        task_tag: String,
445        #[serde(default)]
446        reveal_target: Option<RevealTarget>,
447    },
448    /// Spawns a task via modal's selection.
449    ViaModal {
450        /// Selected task's `reveal_target` property override.
451        #[serde(default)]
452        reveal_target: Option<RevealTarget>,
453    },
454}
455
456impl Spawn {
457    pub fn modal() -> Self {
458        Self::ViaModal {
459            reveal_target: None,
460        }
461    }
462}
463
464/// Reruns the last task.
465#[derive(PartialEq, Clone, Deserialize, Default, JsonSchema, Action)]
466#[action(namespace = task)]
467#[serde(deny_unknown_fields)]
468pub struct Rerun {
469    /// Controls whether the task context is reevaluated prior to execution of a task.
470    /// 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
471    /// If it is, these variables will be updated to reflect current state of editor at the time task::Rerun is executed.
472    /// default: false
473    #[serde(default)]
474    pub reevaluate_context: bool,
475    /// Overrides `allow_concurrent_runs` property of the task being reran.
476    /// Default: null
477    #[serde(default)]
478    pub allow_concurrent_runs: Option<bool>,
479    /// Overrides `use_new_terminal` property of the task being reran.
480    /// Default: null
481    #[serde(default)]
482    pub use_new_terminal: Option<bool>,
483
484    /// If present, rerun the task with this ID, otherwise rerun the last task.
485    #[serde(skip)]
486    pub task_id: Option<String>,
487}
488
489pub mod outline {
490    use std::sync::OnceLock;
491
492    use gpui::{AnyView, App, Window, actions};
493
494    actions!(
495        outline,
496        [
497            #[action(name = "Toggle")]
498            ToggleOutline
499        ]
500    );
501    /// A pointer to outline::toggle function, exposed here to sewer the breadcrumbs <-> outline dependency.
502    pub static TOGGLE_OUTLINE: OnceLock<fn(AnyView, &mut Window, &mut App)> = OnceLock::new();
503}
504
505actions!(
506    zed_predict_onboarding,
507    [
508        /// Opens the Zed Predict onboarding modal.
509        OpenZedPredictOnboarding
510    ]
511);
512actions!(
513    git_onboarding,
514    [
515        /// Opens the git integration onboarding modal.
516        OpenGitIntegrationOnboarding
517    ]
518);
519
520actions!(
521    debug_panel,
522    [
523        /// Toggles focus on the debug panel.
524        ToggleFocus
525    ]
526);
527actions!(
528    debugger,
529    [
530        /// Toggles the enabled state of a breakpoint.
531        ToggleEnableBreakpoint,
532        /// Removes a breakpoint.
533        UnsetBreakpoint,
534        /// Opens the project debug tasks configuration.
535        OpenProjectDebugTasks,
536    ]
537);
538
539#[derive(Debug, Clone, PartialEq, Eq, Hash)]
540pub struct WslConnectionOptions {
541    pub distro_name: String,
542    pub user: Option<String>,
543}
544
545#[cfg(target_os = "windows")]
546pub mod wsl_actions {
547    use gpui::Action;
548    use schemars::JsonSchema;
549    use serde::Deserialize;
550
551    /// Opens a folder inside Wsl.
552    #[derive(PartialEq, Clone, Deserialize, Default, JsonSchema, Action)]
553    #[action(namespace = projects)]
554    #[serde(deny_unknown_fields)]
555    pub struct OpenFolderInWsl {
556        #[serde(default)]
557        pub create_new_window: bool,
558    }
559
560    /// Open a wsl distro.
561    #[derive(PartialEq, Clone, Deserialize, Default, JsonSchema, Action)]
562    #[action(namespace = projects)]
563    #[serde(deny_unknown_fields)]
564    pub struct OpenWsl {
565        #[serde(default)]
566        pub create_new_window: bool,
567    }
568}