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