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