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            /// Opens the selected file with the system's default application.
161            #[action(deprecated_aliases = ["project_panel::OpenWithSystem"])]
162            OpenWithSystem,
163        ]
164    );
165}
166
167pub mod git {
168    use gpui::actions;
169
170    actions!(
171        git,
172        [
173            /// Checks out a different git branch.
174            CheckoutBranch,
175            /// Switches to a different git branch.
176            Switch,
177            /// Selects a different repository.
178            SelectRepo,
179            /// Opens the git branch selector.
180            #[action(deprecated_aliases = ["branches::OpenRecent"])]
181            Branch
182        ]
183    );
184}
185
186pub mod jj {
187    use gpui::actions;
188
189    actions!(
190        jj,
191        [
192            /// Opens the Jujutsu bookmark list.
193            BookmarkList
194        ]
195    );
196}
197
198pub mod toast {
199    use gpui::actions;
200
201    actions!(
202        toast,
203        [
204            /// Runs the action associated with a toast notification.
205            RunAction
206        ]
207    );
208}
209
210pub mod command_palette {
211    use gpui::actions;
212
213    actions!(
214        command_palette,
215        [
216            /// Toggles the command palette.
217            Toggle
218        ]
219    );
220}
221
222pub mod feedback {
223    use gpui::actions;
224
225    actions!(
226        feedback,
227        [
228            /// Opens the bug report form.
229            FileBugReport,
230            /// Opens the feedback form.
231            GiveFeedback
232        ]
233    );
234}
235
236pub mod theme_selector {
237    use gpui::Action;
238    use schemars::JsonSchema;
239    use serde::Deserialize;
240
241    /// Toggles the theme selector interface.
242    #[derive(PartialEq, Clone, Default, Debug, Deserialize, JsonSchema, Action)]
243    #[action(namespace = theme_selector)]
244    #[serde(deny_unknown_fields)]
245    pub struct Toggle {
246        /// A list of theme names to filter the theme selector down to.
247        pub themes_filter: Option<Vec<String>>,
248    }
249}
250
251pub mod icon_theme_selector {
252    use gpui::Action;
253    use schemars::JsonSchema;
254    use serde::Deserialize;
255
256    /// Toggles the icon theme selector interface.
257    #[derive(PartialEq, Clone, Default, Debug, Deserialize, JsonSchema, Action)]
258    #[action(namespace = icon_theme_selector)]
259    #[serde(deny_unknown_fields)]
260    pub struct Toggle {
261        /// A list of icon theme names to filter the theme selector down to.
262        pub themes_filter: Option<Vec<String>>,
263    }
264}
265
266pub mod settings_profile_selector {
267    use gpui::Action;
268    use schemars::JsonSchema;
269    use serde::Deserialize;
270
271    #[derive(PartialEq, Clone, Default, Debug, Deserialize, JsonSchema, Action)]
272    #[action(namespace = settings_profile_selector)]
273    pub struct Toggle;
274}
275
276pub mod agent {
277    use gpui::actions;
278
279    actions!(
280        agent,
281        [
282            /// Opens the agent settings panel.
283            #[action(deprecated_aliases = ["agent::OpenConfiguration"])]
284            OpenSettings,
285            /// Opens the agent onboarding modal.
286            OpenOnboardingModal,
287            /// Opens the ACP onboarding modal.
288            OpenAcpOnboardingModal,
289            /// Opens the Claude Code onboarding modal.
290            OpenClaudeCodeOnboardingModal,
291            /// Resets the agent onboarding state.
292            ResetOnboarding,
293            /// Starts a chat conversation with the agent.
294            Chat,
295            /// Toggles the language model selector dropdown.
296            #[action(deprecated_aliases = ["assistant::ToggleModelSelector", "assistant2::ToggleModelSelector"])]
297            ToggleModelSelector,
298            /// Triggers re-authentication on Gemini
299            ReauthenticateAgent
300        ]
301    );
302}
303
304pub mod assistant {
305    use gpui::{Action, actions};
306    use schemars::JsonSchema;
307    use serde::Deserialize;
308    use uuid::Uuid;
309
310    actions!(
311        agent,
312        [
313            #[action(deprecated_aliases = ["assistant::ToggleFocus"])]
314            ToggleFocus
315        ]
316    );
317
318    actions!(
319        assistant,
320        [
321            /// Shows the assistant configuration panel.
322            ShowConfiguration
323        ]
324    );
325
326    /// Opens the rules library for managing agent rules and prompts.
327    #[derive(PartialEq, Clone, Default, Debug, Deserialize, JsonSchema, Action)]
328    #[action(namespace = agent, deprecated_aliases = ["assistant::OpenRulesLibrary", "assistant::DeployPromptLibrary"])]
329    #[serde(deny_unknown_fields)]
330    pub struct OpenRulesLibrary {
331        #[serde(skip)]
332        pub prompt_to_select: Option<Uuid>,
333    }
334
335    /// Deploys the assistant interface with the specified configuration.
336    #[derive(Clone, Default, Deserialize, PartialEq, JsonSchema, Action)]
337    #[action(namespace = assistant)]
338    #[serde(deny_unknown_fields)]
339    pub struct InlineAssist {
340        pub prompt: Option<String>,
341    }
342}
343
344pub mod debugger {
345    use gpui::actions;
346
347    actions!(
348        debugger,
349        [
350            /// Opens the debugger onboarding modal.
351            OpenOnboardingModal,
352            /// Resets the debugger onboarding state.
353            ResetOnboarding
354        ]
355    );
356}
357
358/// Opens the recent projects interface.
359#[derive(PartialEq, Clone, Deserialize, Default, JsonSchema, Action)]
360#[action(namespace = projects)]
361#[serde(deny_unknown_fields)]
362pub struct OpenRecent {
363    #[serde(default)]
364    pub create_new_window: bool,
365}
366
367/// Creates a project from a selected template.
368#[derive(PartialEq, Clone, Deserialize, Default, JsonSchema, Action)]
369#[action(namespace = projects)]
370#[serde(deny_unknown_fields)]
371pub struct OpenRemote {
372    #[serde(default)]
373    pub from_existing_connection: bool,
374    #[serde(default)]
375    pub create_new_window: bool,
376}
377
378/// Where to spawn the task in the UI.
379#[derive(Default, Clone, Copy, Debug, PartialEq, Eq, Serialize, Deserialize, JsonSchema)]
380#[serde(rename_all = "snake_case")]
381pub enum RevealTarget {
382    /// In the central pane group, "main" editor area.
383    Center,
384    /// In the terminal dock, "regular" terminal items' place.
385    #[default]
386    Dock,
387}
388
389/// Spawns a task with name or opens tasks modal.
390#[derive(Debug, PartialEq, Clone, Deserialize, JsonSchema, Action)]
391#[action(namespace = task)]
392#[serde(untagged)]
393pub enum Spawn {
394    /// Spawns a task by the name given.
395    ByName {
396        task_name: String,
397        #[serde(default)]
398        reveal_target: Option<RevealTarget>,
399    },
400    /// Spawns a task by the name given.
401    ByTag {
402        task_tag: String,
403        #[serde(default)]
404        reveal_target: Option<RevealTarget>,
405    },
406    /// Spawns a task via modal's selection.
407    ViaModal {
408        /// Selected task's `reveal_target` property override.
409        #[serde(default)]
410        reveal_target: Option<RevealTarget>,
411    },
412}
413
414impl Spawn {
415    pub fn modal() -> Self {
416        Self::ViaModal {
417            reveal_target: None,
418        }
419    }
420}
421
422/// Reruns the last task.
423#[derive(PartialEq, Clone, Deserialize, Default, JsonSchema, Action)]
424#[action(namespace = task)]
425#[serde(deny_unknown_fields)]
426pub struct Rerun {
427    /// Controls whether the task context is reevaluated prior to execution of a task.
428    /// 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
429    /// If it is, these variables will be updated to reflect current state of editor at the time task::Rerun is executed.
430    /// default: false
431    #[serde(default)]
432    pub reevaluate_context: bool,
433    /// Overrides `allow_concurrent_runs` property of the task being reran.
434    /// Default: null
435    #[serde(default)]
436    pub allow_concurrent_runs: Option<bool>,
437    /// Overrides `use_new_terminal` property of the task being reran.
438    /// Default: null
439    #[serde(default)]
440    pub use_new_terminal: Option<bool>,
441
442    /// If present, rerun the task with this ID, otherwise rerun the last task.
443    #[serde(skip)]
444    pub task_id: Option<String>,
445}
446
447pub mod outline {
448    use std::sync::OnceLock;
449
450    use gpui::{AnyView, App, Window, actions};
451
452    actions!(
453        outline,
454        [
455            #[action(name = "Toggle")]
456            ToggleOutline
457        ]
458    );
459    /// A pointer to outline::toggle function, exposed here to sewer the breadcrumbs <-> outline dependency.
460    pub static TOGGLE_OUTLINE: OnceLock<fn(AnyView, &mut Window, &mut App)> = OnceLock::new();
461}
462
463actions!(
464    zed_predict_onboarding,
465    [
466        /// Opens the Zed Predict onboarding modal.
467        OpenZedPredictOnboarding
468    ]
469);
470actions!(
471    git_onboarding,
472    [
473        /// Opens the git integration onboarding modal.
474        OpenGitIntegrationOnboarding
475    ]
476);
477
478actions!(
479    debug_panel,
480    [
481        /// Toggles focus on the debug panel.
482        ToggleFocus
483    ]
484);
485actions!(
486    debugger,
487    [
488        /// Toggles the enabled state of a breakpoint.
489        ToggleEnableBreakpoint,
490        /// Removes a breakpoint.
491        UnsetBreakpoint,
492        /// Opens the project debug tasks configuration.
493        OpenProjectDebugTasks,
494    ]
495);