Yehowshua/ZIm
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

gpui: Store action documentation (#33809)

Browse source 
Closes #ISSUE

Adds a new `documentation` method to actions, that is extracted from doc
comments when using the `actions!` or derive macros.

Additionally, this PR adds doc comments to as many action definitions in
Zed as possible.

Release Notes:

- N/A *or* Added/Fixed/Improved ...
This commit is contained in:
Ben Kunkle 2025-07-02 20:14:33 -05:00 • committed by GitHub
parent def8bab5a8
commit 6cd4dbdea1
No known key found for this signature in database
GPG key ID: B5690EEEBB952194
96 changed files with 1467 additions and 78 deletions
Download patch file Download diff file Expand all files Collapse all files

249
crates/editor/src/actions.rs
View file

@ -4,6 +4,7 @@ use gpui::{Action, actions};
use schemars::JsonSchema;
use util::serde::default_true;
/// Selects the next occurrence of the current selection.
#[derive(PartialEq, Clone, Deserialize, Default, JsonSchema, Action)]
#[action(namespace = editor)]
#[serde(deny_unknown_fields)]
@ -12,6 +13,7 @@ pub struct SelectNext {
pub replace_newest: bool,
}
/// Selects the previous occurrence of the current selection.
#[derive(PartialEq, Clone, Deserialize, Default, JsonSchema, Action)]
#[action(namespace = editor)]
#[serde(deny_unknown_fields)]
@ -20,6 +22,7 @@ pub struct SelectPrevious {
pub replace_newest: bool,
}
/// Moves the cursor to the beginning of the current line.
#[derive(PartialEq, Clone, Deserialize, Default, JsonSchema, Action)]
#[action(namespace = editor)]
#[serde(deny_unknown_fields)]
@ -30,6 +33,7 @@ pub struct MoveToBeginningOfLine {
pub stop_at_indent: bool,
}
/// Selects from the cursor to the beginning of the current line.
#[derive(PartialEq, Clone, Deserialize, Default, JsonSchema, Action)]
#[action(namespace = editor)]
#[serde(deny_unknown_fields)]
@ -40,6 +44,7 @@ pub struct SelectToBeginningOfLine {
pub stop_at_indent: bool,
}
/// Deletes from the cursor to the beginning of the current line.
#[derive(PartialEq, Clone, Deserialize, Default, JsonSchema, Action)]
#[action(namespace = editor)]
#[serde(deny_unknown_fields)]
@ -48,6 +53,7 @@ pub struct DeleteToBeginningOfLine {
pub(super) stop_at_indent: bool,
}
/// Moves the cursor up by one page.
#[derive(PartialEq, Clone, Deserialize, Default, JsonSchema, Action)]
#[action(namespace = editor)]
#[serde(deny_unknown_fields)]
@ -56,6 +62,7 @@ pub struct MovePageUp {
pub(super) center_cursor: bool,
}
/// Moves the cursor down by one page.
#[derive(PartialEq, Clone, Deserialize, Default, JsonSchema, Action)]
#[action(namespace = editor)]
#[serde(deny_unknown_fields)]
@ -64,6 +71,7 @@ pub struct MovePageDown {
pub(super) center_cursor: bool,
}
/// Moves the cursor to the end of the current line.
#[derive(PartialEq, Clone, Deserialize, Default, JsonSchema, Action)]
#[action(namespace = editor)]
#[serde(deny_unknown_fields)]
@ -72,6 +80,7 @@ pub struct MoveToEndOfLine {
pub stop_at_soft_wraps: bool,
}
/// Selects from the cursor to the end of the current line.
#[derive(PartialEq, Clone, Deserialize, Default, JsonSchema, Action)]
#[action(namespace = editor)]
#[serde(deny_unknown_fields)]
@ -80,6 +89,7 @@ pub struct SelectToEndOfLine {
pub(super) stop_at_soft_wraps: bool,
}
/// Toggles the display of available code actions at the cursor position.
#[derive(PartialEq, Clone, Deserialize, Default, JsonSchema, Action)]
#[action(namespace = editor)]
#[serde(deny_unknown_fields)]
@ -101,6 +111,7 @@ pub enum CodeActionSource {
QuickActionBar,
}
/// Confirms and accepts the currently selected completion suggestion.
#[derive(PartialEq, Clone, Deserialize, Default, JsonSchema, Action)]
#[action(namespace = editor)]
#[serde(deny_unknown_fields)]
@ -109,6 +120,7 @@ pub struct ConfirmCompletion {
pub item_ix: Option<usize>,
}
/// Composes multiple completion suggestions into a single completion.
#[derive(PartialEq, Clone, Deserialize, Default, JsonSchema, Action)]
#[action(namespace = editor)]
#[serde(deny_unknown_fields)]
@ -117,6 +129,7 @@ pub struct ComposeCompletion {
pub item_ix: Option<usize>,
}
/// Confirms and applies the currently selected code action.
#[derive(PartialEq, Clone, Deserialize, Default, JsonSchema, Action)]
#[action(namespace = editor)]
#[serde(deny_unknown_fields)]
@ -125,6 +138,7 @@ pub struct ConfirmCodeAction {
pub item_ix: Option<usize>,
}
/// Toggles comment markers for the selected lines.
#[derive(PartialEq, Clone, Deserialize, Default, JsonSchema, Action)]
#[action(namespace = editor)]
#[serde(deny_unknown_fields)]
@ -135,6 +149,7 @@ pub struct ToggleComments {
pub ignore_indent: bool,
}
/// Moves the cursor up by a specified number of lines.
#[derive(PartialEq, Clone, Deserialize, Default, JsonSchema, Action)]
#[action(namespace = editor)]
#[serde(deny_unknown_fields)]
@ -143,6 +158,7 @@ pub struct MoveUpByLines {
pub(super) lines: u32,
}
/// Moves the cursor down by a specified number of lines.
#[derive(PartialEq, Clone, Deserialize, Default, JsonSchema, Action)]
#[action(namespace = editor)]
#[serde(deny_unknown_fields)]
@ -151,6 +167,7 @@ pub struct MoveDownByLines {
pub(super) lines: u32,
}
/// Extends selection up by a specified number of lines.
#[derive(PartialEq, Clone, Deserialize, Default, JsonSchema, Action)]
#[action(namespace = editor)]
#[serde(deny_unknown_fields)]
@ -159,6 +176,7 @@ pub struct SelectUpByLines {
pub(super) lines: u32,
}
/// Extends selection down by a specified number of lines.
#[derive(PartialEq, Clone, Deserialize, Default, JsonSchema, Action)]
#[action(namespace = editor)]
#[serde(deny_unknown_fields)]
@ -167,6 +185,7 @@ pub struct SelectDownByLines {
pub(super) lines: u32,
}
/// Expands all excerpts in the editor.
#[derive(PartialEq, Clone, Deserialize, Default, JsonSchema, Action)]
#[action(namespace = editor)]
#[serde(deny_unknown_fields)]
@ -175,6 +194,7 @@ pub struct ExpandExcerpts {
pub(super) lines: u32,
}
/// Expands excerpts above the current position.
#[derive(PartialEq, Clone, Deserialize, Default, JsonSchema, Action)]
#[action(namespace = editor)]
#[serde(deny_unknown_fields)]
@ -183,6 +203,7 @@ pub struct ExpandExcerptsUp {
pub(super) lines: u32,
}
/// Expands excerpts below the current position.
#[derive(PartialEq, Clone, Deserialize, Default, JsonSchema, Action)]
#[action(namespace = editor)]
#[serde(deny_unknown_fields)]
@ -191,6 +212,7 @@ pub struct ExpandExcerptsDown {
pub(super) lines: u32,
}
/// Shows code completion suggestions at the cursor position.
#[derive(PartialEq, Clone, Deserialize, Default, JsonSchema, Action)]
#[action(namespace = editor)]
#[serde(deny_unknown_fields)]
@ -199,10 +221,12 @@ pub struct ShowCompletions {
pub(super) trigger: Option<String>,
}
/// Handles text input in the editor.
#[derive(PartialEq, Clone, Deserialize, Default, JsonSchema, Action)]
#[action(namespace = editor)]
pub struct HandleInput(pub String);
/// Deletes from the cursor to the end of the next word.
#[derive(PartialEq, Clone, Deserialize, Default, JsonSchema, Action)]
#[action(namespace = editor)]
#[serde(deny_unknown_fields)]
@ -211,6 +235,7 @@ pub struct DeleteToNextWordEnd {
pub ignore_newlines: bool,
}
/// Deletes from the cursor to the start of the previous word.
#[derive(PartialEq, Clone, Deserialize, Default, JsonSchema, Action)]
#[action(namespace = editor)]
#[serde(deny_unknown_fields)]
@ -219,10 +244,12 @@ pub struct DeleteToPreviousWordStart {
pub ignore_newlines: bool,
}
/// Folds all code blocks at the specified indentation level.
#[derive(PartialEq, Clone, Deserialize, Default, JsonSchema, Action)]
#[action(namespace = editor)]
pub struct FoldAtLevel(pub u32);
/// Spawns the nearest available task from the current cursor position.
#[derive(PartialEq, Clone, Deserialize, Default, JsonSchema, Action)]
#[action(namespace = editor)]
#[serde(deny_unknown_fields)]
@ -238,11 +265,20 @@ pub enum UuidVersion {
V7,
}
actions!(debugger, [RunToCursor, EvaluateSelectedText]);
actions!(
debugger,
[
/// Runs program execution to the current cursor position.
RunToCursor,
/// Evaluates the selected text in the debugger context.
EvaluateSelectedText
]
);
actions!(
go_to_line,
[
/// Toggles the go to line dialog.
#[action(name = "Toggle")]
ToggleGoToLine
]
@ -251,219 +287,430 @@ actions!(
actions!(
editor,
[
/// Accepts the full edit prediction.
AcceptEditPrediction,
/// Accepts a partial Copilot suggestion.
AcceptPartialCopilotSuggestion,
/// Accepts a partial edit prediction.
AcceptPartialEditPrediction,
/// Adds a cursor above the current selection.
AddSelectionAbove,
/// Adds a cursor below the current selection.
AddSelectionBelow,
/// Applies all diff hunks in the editor.
ApplyAllDiffHunks,
/// Applies the diff hunk at the current position.
ApplyDiffHunk,
/// Deletes the character before the cursor.
Backspace,
/// Cancels the current operation.
Cancel,
/// Cancels the running flycheck operation.
CancelFlycheck,
/// Cancels pending language server work.
CancelLanguageServerWork,
/// Clears flycheck results.
ClearFlycheck,
/// Confirms the rename operation.
ConfirmRename,
/// Confirms completion by inserting at cursor.
ConfirmCompletionInsert,
/// Confirms completion by replacing existing text.
ConfirmCompletionReplace,
/// Navigates to the first item in the context menu.
ContextMenuFirst,
/// Navigates to the last item in the context menu.
ContextMenuLast,
/// Navigates to the next item in the context menu.
ContextMenuNext,
/// Navigates to the previous item in the context menu.
ContextMenuPrevious,
/// Converts indentation from tabs to spaces.
ConvertIndentationToSpaces,
/// Converts indentation from spaces to tabs.
ConvertIndentationToTabs,
/// Converts selected text to kebab-case.
ConvertToKebabCase,
/// Converts selected text to lowerCamelCase.
ConvertToLowerCamelCase,
/// Converts selected text to lowercase.
ConvertToLowerCase,
/// Toggles the case of selected text.
ConvertToOppositeCase,
/// Converts selected text to snake_case.
ConvertToSnakeCase,
/// Converts selected text to Title Case.
ConvertToTitleCase,
/// Converts selected text to UpperCamelCase.
ConvertToUpperCamelCase,
/// Converts selected text to UPPERCASE.
ConvertToUpperCase,
/// Applies ROT13 cipher to selected text.
ConvertToRot13,
/// Applies ROT47 cipher to selected text.
ConvertToRot47,
/// Copies selected text to the clipboard.
Copy,
/// Copies selected text to the clipboard with leading/trailing whitespace trimmed.
CopyAndTrim,
/// Copies the current file location to the clipboard.
CopyFileLocation,
/// Copies the highlighted text as JSON.
CopyHighlightJson,
/// Copies the current file name to the clipboard.
CopyFileName,
/// Copies the file name without extension to the clipboard.
CopyFileNameWithoutExtension,
/// Copies a permalink to the current line.
CopyPermalinkToLine,
/// Cuts selected text to the clipboard.
Cut,
/// Cuts from cursor to end of line.
CutToEndOfLine,
/// Deletes the character after the cursor.
Delete,
/// Deletes the current line.
DeleteLine,
/// Deletes from cursor to end of line.
DeleteToEndOfLine,
/// Deletes to the end of the next subword.
DeleteToNextSubwordEnd,
/// Deletes to the start of the previous subword.
DeleteToPreviousSubwordStart,
/// Displays names of all active cursors.
DisplayCursorNames,
/// Duplicates the current line below.
DuplicateLineDown,
/// Duplicates the current line above.
DuplicateLineUp,
/// Duplicates the current selection.
DuplicateSelection,
/// Expands all diff hunks in the editor.
#[action(deprecated_aliases = ["editor::ExpandAllHunkDiffs"])]
ExpandAllDiffHunks,
/// Expands macros recursively at cursor position.
ExpandMacroRecursively,
/// Finds all references to the symbol at cursor.
FindAllReferences,
/// Finds the next match in the search.
FindNextMatch,
/// Finds the previous match in the search.
FindPreviousMatch,
/// Folds the current code block.
Fold,
/// Folds all foldable regions in the editor.
FoldAll,
/// Folds all function bodies in the editor.
FoldFunctionBodies,
/// Folds the current code block and all its children.
FoldRecursive,
/// Folds the selected ranges.
FoldSelectedRanges,
/// Toggles folding at the current position.
ToggleFold,
/// Toggles recursive folding at the current position.
ToggleFoldRecursive,
/// Formats the entire document.
Format,
/// Formats only the selected text.
FormatSelections,
/// Goes to the declaration of the symbol at cursor.
GoToDeclaration,
/// Goes to declaration in a split pane.
GoToDeclarationSplit,
/// Goes to the definition of the symbol at cursor.
GoToDefinition,
/// Goes to definition in a split pane.
GoToDefinitionSplit,
/// Goes to the next diagnostic in the file.
GoToDiagnostic,
/// Goes to the next diff hunk.
GoToHunk,
/// Goes to the previous diff hunk.
GoToPreviousHunk,
/// Goes to the implementation of the symbol at cursor.
GoToImplementation,
/// Goes to implementation in a split pane.
GoToImplementationSplit,
/// Goes to the next change in the file.
GoToNextChange,
/// Goes to the parent module of the current file.
GoToParentModule,
/// Goes to the previous change in the file.
GoToPreviousChange,
/// Goes to the previous diagnostic in the file.
GoToPreviousDiagnostic,
/// Goes to the type definition of the symbol at cursor.
GoToTypeDefinition,
/// Goes to type definition in a split pane.
GoToTypeDefinitionSplit,
/// Scrolls down by half a page.
HalfPageDown,
/// Scrolls up by half a page.
HalfPageUp,
/// Shows hover information for the symbol at cursor.
Hover,
/// Increases indentation of selected lines.
Indent,
/// Inserts a UUID v4 at cursor position.
InsertUuidV4,
/// Inserts a UUID v7 at cursor position.
InsertUuidV7,
/// Joins the current line with the next line.
JoinLines,
/// Cuts to kill ring (Emacs-style).
KillRingCut,
/// Yanks from kill ring (Emacs-style).
KillRingYank,
/// Moves cursor down one line.
LineDown,
/// Moves cursor up one line.
LineUp,
/// Moves cursor down.
MoveDown,
/// Moves cursor left.
MoveLeft,
/// Moves the current line down.
MoveLineDown,
/// Moves the current line up.
MoveLineUp,
/// Moves cursor right.
MoveRight,
/// Moves cursor to the beginning of the document.
MoveToBeginning,
/// Moves cursor to the enclosing bracket.
MoveToEnclosingBracket,
/// Moves cursor to the end of the document.
MoveToEnd,
/// Moves cursor to the end of the paragraph.
MoveToEndOfParagraph,
/// Moves cursor to the end of the next subword.
MoveToNextSubwordEnd,
/// Moves cursor to the end of the next word.
MoveToNextWordEnd,
/// Moves cursor to the start of the previous subword.
MoveToPreviousSubwordStart,
/// Moves cursor to the start of the previous word.
MoveToPreviousWordStart,
/// Moves cursor to the start of the paragraph.
MoveToStartOfParagraph,
/// Moves cursor to the start of the current excerpt.
MoveToStartOfExcerpt,
/// Moves cursor to the start of the next excerpt.
MoveToStartOfNextExcerpt,
/// Moves cursor to the end of the current excerpt.
MoveToEndOfExcerpt,
/// Moves cursor to the end of the previous excerpt.
MoveToEndOfPreviousExcerpt,
/// Moves cursor up.
MoveUp,
/// Inserts a new line and moves cursor to it.
Newline,
/// Inserts a new line above the current line.
NewlineAbove,
/// Inserts a new line below the current line.
NewlineBelow,
/// Navigates to the next edit prediction.
NextEditPrediction,
/// Scrolls to the next screen.
NextScreen,
/// Opens the context menu at cursor position.
OpenContextMenu,
/// Opens excerpts from the current file.
OpenExcerpts,
/// Opens excerpts in a split pane.
OpenExcerptsSplit,
/// Opens the proposed changes editor.
OpenProposedChangesEditor,
/// Opens documentation for the symbol at cursor.
OpenDocs,
/// Opens a permalink to the current line.
OpenPermalinkToLine,
/// Opens the file whose name is selected in the editor.
#[action(deprecated_aliases = ["editor::OpenFile"])]
OpenSelectedFilename,
/// Opens all selections in a multibuffer.
OpenSelectionsInMultibuffer,
/// Opens the URL at cursor position.
OpenUrl,
/// Organizes import statements.
OrganizeImports,
/// Decreases indentation of selected lines.
Outdent,
/// Automatically adjusts indentation based on context.
AutoIndent,
/// Scrolls down by one page.
PageDown,
/// Scrolls up by one page.
PageUp,
/// Pastes from clipboard.
Paste,
/// Navigates to the previous edit prediction.
PreviousEditPrediction,
/// Redoes the last undone edit.
Redo,
/// Redoes the last selection change.
RedoSelection,
/// Renames the symbol at cursor.
Rename,
/// Restarts the language server for the current file.
RestartLanguageServer,
/// Reveals the current file in the system file manager.
RevealInFileManager,
/// Reverses the order of selected lines.
ReverseLines,
/// Reloads the file from disk.
ReloadFile,
/// Rewraps text to fit within the preferred line length.
Rewrap,
/// Runs flycheck diagnostics.
RunFlycheck,
/// Scrolls the cursor to the bottom of the viewport.
ScrollCursorBottom,
/// Scrolls the cursor to the center of the viewport.
ScrollCursorCenter,
/// Cycles cursor position between center, top, and bottom.
ScrollCursorCenterTopBottom,
/// Scrolls the cursor to the top of the viewport.
ScrollCursorTop,
/// Selects all text in the editor.
SelectAll,
/// Selects all matches of the current selection.
SelectAllMatches,
/// Selects to the start of the current excerpt.
SelectToStartOfExcerpt,
/// Selects to the start of the next excerpt.
SelectToStartOfNextExcerpt,
/// Selects to the end of the current excerpt.
SelectToEndOfExcerpt,
/// Selects to the end of the previous excerpt.
SelectToEndOfPreviousExcerpt,
/// Extends selection down.
SelectDown,
/// Selects the enclosing symbol.
SelectEnclosingSymbol,
/// Selects the next larger syntax node.
SelectLargerSyntaxNode,
/// Extends selection left.
SelectLeft,
/// Selects the current line.
SelectLine,
/// Extends selection down by one page.
SelectPageDown,
/// Extends selection up by one page.
SelectPageUp,
/// Extends selection right.
SelectRight,
/// Selects the next smaller syntax node.
SelectSmallerSyntaxNode,
/// Selects to the beginning of the document.
SelectToBeginning,
/// Selects to the end of the document.
SelectToEnd,
/// Selects to the end of the paragraph.
SelectToEndOfParagraph,
/// Selects to the end of the next subword.
SelectToNextSubwordEnd,
/// Selects to the end of the next word.
SelectToNextWordEnd,
/// Selects to the start of the previous subword.
SelectToPreviousSubwordStart,
/// Selects to the start of the previous word.
SelectToPreviousWordStart,
/// Selects to the start of the paragraph.
SelectToStartOfParagraph,
/// Extends selection up.
SelectUp,
/// Shows the system character palette.
ShowCharacterPalette,
/// Shows edit prediction at cursor.
ShowEditPrediction,
/// Shows signature help for the current function.
ShowSignatureHelp,
/// Shows word completions.
ShowWordCompletions,
/// Randomly shuffles selected lines.
ShuffleLines,
/// Navigates to the next signature in the signature help popup.
SignatureHelpNext,
/// Navigates to the previous signature in the signature help popup.
SignatureHelpPrevious,
/// Sorts selected lines case-insensitively.
SortLinesCaseInsensitive,
/// Sorts selected lines case-sensitively.
SortLinesCaseSensitive,
/// Splits selection into individual lines.
SplitSelectionIntoLines,
/// Stops the language server for the current file.
StopLanguageServer,
/// Switches between source and header files.
SwitchSourceHeader,
/// Inserts a tab character or indents.
Tab,
/// Removes a tab character or outdents.
Backtab,
/// Toggles a breakpoint at the current line.
ToggleBreakpoint,
/// Toggles the case of selected text.
ToggleCase,
/// Disables the breakpoint at the current line.
DisableBreakpoint,
/// Enables the breakpoint at the current line.
EnableBreakpoint,
/// Edits the log message for a breakpoint.
EditLogBreakpoint,
/// Toggles automatic signature help.
ToggleAutoSignatureHelp,
/// Toggles inline git blame display.
ToggleGitBlameInline,
/// Opens the git commit for the blame at cursor.
OpenGitBlameCommit,
/// Toggles the diagnostics panel.
ToggleDiagnostics,
/// Toggles indent guides display.
ToggleIndentGuides,
/// Toggles inlay hints display.
ToggleInlayHints,
/// Toggles inline values display.
ToggleInlineValues,
/// Toggles inline diagnostics display.
ToggleInlineDiagnostics,
/// Toggles edit prediction feature.
ToggleEditPrediction,
/// Toggles line numbers display.
ToggleLineNumbers,
/// Toggles the minimap display.
ToggleMinimap,
/// Swaps the start and end of the current selection.
SwapSelectionEnds,
/// Sets a mark at the current position.
SetMark,
/// Toggles relative line numbers display.
ToggleRelativeLineNumbers,
/// Toggles diff display for selected hunks.
#[action(deprecated_aliases = ["editor::ToggleHunkDiff"])]
ToggleSelectedDiffHunks,
/// Toggles the selection menu.
ToggleSelectionMenu,
/// Toggles soft wrap mode.
ToggleSoftWrap,
/// Toggles the tab bar display.
ToggleTabBar,
/// Transposes characters around cursor.
Transpose,
/// Undoes the last edit.
Undo,
/// Undoes the last selection change.
UndoSelection,
/// Unfolds all folded regions.
UnfoldAll,
/// Unfolds lines at cursor.
UnfoldLines,
/// Unfolds recursively at cursor.
UnfoldRecursive,
/// Removes duplicate lines (case-insensitive).
UniqueLinesCaseInsensitive,
/// Removes duplicate lines (case-sensitive).
UniqueLinesCaseSensitive,
]
);