feat: improve some command description strings

This commit is contained in:
CJ van den Berg 2025-03-06 19:59:44 +01:00
parent 61de2bb6b7
commit c71226ee47
Signed by: neurocyte
GPG key ID: 8EB1E1BB660E3FB9
2 changed files with 23 additions and 22 deletions

View file

@ -240,7 +240,7 @@ const cmds = struct {
try self.check_all_not_dirty(); try self.check_all_not_dirty();
try tp.self_pid().send("quit"); try tp.self_pid().send("quit");
} }
pub const quit_meta = .{ .description = "Quit (exit) Flow Control" }; pub const quit_meta = .{ .description = "Quit" };
pub fn quit_without_saving(_: *Self, _: Ctx) Result { pub fn quit_without_saving(_: *Self, _: Ctx) Result {
try tp.self_pid().send("quit"); try tp.self_pid().send("quit");
@ -399,19 +399,19 @@ const cmds = struct {
try command.executeName("open_scratch_buffer", command.fmt(.{ "version", root.version_info, "diff" })); try command.executeName("open_scratch_buffer", command.fmt(.{ "version", root.version_info, "diff" }));
tui.need_render(); tui.need_render();
} }
pub const open_version_info_meta = .{ .description = "Show build version information" }; pub const open_version_info_meta = .{ .description = "Version" };
pub fn open_config(_: *Self, _: Ctx) Result { pub fn open_config(_: *Self, _: Ctx) Result {
const file_name = try root.get_config_file_name(@import("config")); const file_name = try root.get_config_file_name(@import("config"));
try tp.self_pid().send(.{ "cmd", "navigate", .{ .file = file_name[0 .. file_name.len - 5] } }); try tp.self_pid().send(.{ "cmd", "navigate", .{ .file = file_name[0 .. file_name.len - 5] } });
} }
pub const open_config_meta = .{ .description = "Edit configuration file" }; pub const open_config_meta = .{ .description = "Edit configuration" };
pub fn open_gui_config(_: *Self, _: Ctx) Result { pub fn open_gui_config(_: *Self, _: Ctx) Result {
const file_name = try root.get_config_file_name(@import("gui_config")); const file_name = try root.get_config_file_name(@import("gui_config"));
try tp.self_pid().send(.{ "cmd", "navigate", .{ .file = file_name[0 .. file_name.len - ".json".len] } }); try tp.self_pid().send(.{ "cmd", "navigate", .{ .file = file_name[0 .. file_name.len - ".json".len] } });
} }
pub const open_gui_config_meta = .{ .description = "Edit gui configuration file" }; pub const open_gui_config_meta = .{ .description = "Edit gui configuration" };
pub fn open_tabs_style_config(self: *Self, _: Ctx) Result { pub fn open_tabs_style_config(self: *Self, _: Ctx) Result {
const Style = @import("status/tabs.zig").Style; const Style = @import("status/tabs.zig").Style;
@ -433,7 +433,7 @@ const cmds = struct {
})); }));
if (self.get_active_buffer()) |buffer| buffer.mark_not_ephemeral(); if (self.get_active_buffer()) |buffer| buffer.mark_not_ephemeral();
} }
pub const open_tabs_style_config_meta = .{ .description = "Edit tab styles configuration file" }; pub const open_tabs_style_config_meta: Meta = .{ .description = "Edit tab style" };
pub fn create_scratch_buffer(self: *Self, ctx: Ctx) Result { pub fn create_scratch_buffer(self: *Self, ctx: Ctx) Result {
const args = try ctx.args.clone(self.allocator); const args = try ctx.args.clone(self.allocator);
@ -463,7 +463,7 @@ const cmds = struct {
if (tp.env.get().str("language").len == 0) if (tp.env.get().str("language").len == 0)
try command.executeName("change_file_type", .{}); try command.executeName("change_file_type", .{});
} }
pub const create_new_file_meta = .{ .description = "Create: New File…" }; pub const create_new_file_meta: Meta = .{ .description = "New file" };
pub fn delete_buffer(self: *Self, ctx: Ctx) Result { pub fn delete_buffer(self: *Self, ctx: Ctx) Result {
var file_path: []const u8 = undefined; var file_path: []const u8 = undefined;

View file

@ -676,11 +676,12 @@ const cmds = struct {
pub const Target = Self; pub const Target = Self;
const Ctx = command.Context; const Ctx = command.Context;
const Result = command.Result; const Result = command.Result;
const Meta = command.Metadata;
pub fn restart(_: *Self, _: Ctx) Result { pub fn restart(_: *Self, _: Ctx) Result {
try tp.self_pid().send("restart"); try tp.self_pid().send("restart");
} }
pub const restart_meta = .{ .description = "Restart flow (without saving)" }; pub const restart_meta: Meta = .{ .description = "Restart (without saving)" };
pub fn force_terminate(self: *Self, _: Ctx) Result { pub fn force_terminate(self: *Self, _: Ctx) Result {
self.deinit(); self.deinit();
@ -711,7 +712,7 @@ const cmds = struct {
self.logger.print("theme: {s}", .{self.theme.description}); self.logger.print("theme: {s}", .{self.theme.description});
try save_config(); try save_config();
} }
pub const theme_next_meta = .{ .description = "Switch to next color theme" }; pub const theme_next_meta: Meta = .{ .description = "Next color theme" };
pub fn theme_prev(self: *Self, _: Ctx) Result { pub fn theme_prev(self: *Self, _: Ctx) Result {
self.theme = get_prev_theme_by_name(self.theme.name); self.theme = get_prev_theme_by_name(self.theme.name);
@ -720,7 +721,7 @@ const cmds = struct {
self.logger.print("theme: {s}", .{self.theme.description}); self.logger.print("theme: {s}", .{self.theme.description});
try save_config(); try save_config();
} }
pub const theme_prev_meta = .{ .description = "Switch to previous color theme" }; pub const theme_prev_meta: Meta = .{ .description = "Previous color theme" };
pub fn toggle_whitespace_mode(self: *Self, _: Ctx) Result { pub fn toggle_whitespace_mode(self: *Self, _: Ctx) Result {
self.config.whitespace_mode = if (std.mem.eql(u8, self.config.whitespace_mode, "none")) self.config.whitespace_mode = if (std.mem.eql(u8, self.config.whitespace_mode, "none"))
@ -743,7 +744,7 @@ const cmds = struct {
_ = try self.send_widgets(tp.self_pid(), m); _ = try self.send_widgets(tp.self_pid(), m);
self.logger.print("whitespace rendering {s}", .{self.config.whitespace_mode}); self.logger.print("whitespace rendering {s}", .{self.config.whitespace_mode});
} }
pub const toggle_whitespace_mode_meta = .{ .description = "Switch to next whitespace rendering mode" }; pub const toggle_whitespace_mode_meta: Meta = .{ .description = "Next whitespace mode" };
pub fn toggle_input_mode(self: *Self, _: Ctx) Result { pub fn toggle_input_mode(self: *Self, _: Ctx) Result {
var it = std.mem.splitScalar(u8, self.config.input_mode, '/'); var it = std.mem.splitScalar(u8, self.config.input_mode, '/');
@ -766,7 +767,7 @@ const cmds = struct {
try keybind.set_namespace(self.config.input_mode); try keybind.set_namespace(self.config.input_mode);
return self.refresh_input_mode(); return self.refresh_input_mode();
} }
pub const toggle_input_mode_meta = .{ .description = "Switch to next input mode" }; pub const toggle_input_mode_meta: Meta = .{ .description = "Switch input mode" };
pub fn enter_mode(self: *Self, ctx: Ctx) Result { pub fn enter_mode(self: *Self, ctx: Ctx) Result {
var mode: []const u8 = undefined; var mode: []const u8 = undefined;
@ -795,12 +796,12 @@ const cmds = struct {
pub fn open_command_palette(self: *Self, _: Ctx) Result { pub fn open_command_palette(self: *Self, _: Ctx) Result {
return self.enter_overlay_mode(@import("mode/overlay/command_palette.zig").Type); return self.enter_overlay_mode(@import("mode/overlay/command_palette.zig").Type);
} }
pub const open_command_palette_meta = .{ .description = "Show/Run commands" }; pub const open_command_palette_meta: Meta = .{ .description = "Command palette" };
pub fn insert_command_name(self: *Self, _: Ctx) Result { pub fn insert_command_name(self: *Self, _: Ctx) Result {
return self.enter_overlay_mode(@import("mode/overlay/list_all_commands_palette.zig").Type); return self.enter_overlay_mode(@import("mode/overlay/list_all_commands_palette.zig").Type);
} }
pub const insert_command_name_meta = .{ .description = "Insert command name" }; pub const insert_command_name_meta: Meta = .{ .description = "Show active keybindings" };
pub fn find_file(self: *Self, _: Ctx) Result { pub fn find_file(self: *Self, _: Ctx) Result {
return self.enter_overlay_mode(@import("mode/overlay/open_recent.zig")); return self.enter_overlay_mode(@import("mode/overlay/open_recent.zig"));
@ -810,12 +811,12 @@ const cmds = struct {
pub fn open_recent(self: *Self, _: Ctx) Result { pub fn open_recent(self: *Self, _: Ctx) Result {
return self.enter_overlay_mode(@import("mode/overlay/open_recent.zig")); return self.enter_overlay_mode(@import("mode/overlay/open_recent.zig"));
} }
pub const open_recent_meta = .{ .description = "Open recent file" }; pub const open_recent_meta: Meta = .{ .description = "Open recent" };
pub fn open_recent_project(self: *Self, _: Ctx) Result { pub fn open_recent_project(self: *Self, _: Ctx) Result {
return self.enter_overlay_mode(@import("mode/overlay/open_recent_project.zig").Type); return self.enter_overlay_mode(@import("mode/overlay/open_recent_project.zig").Type);
} }
pub const open_recent_project_meta = .{ .description = "Open recent project" }; pub const open_recent_project_meta: Meta = .{ .description = "Open project" };
pub fn switch_buffers(self: *Self, _: Ctx) Result { pub fn switch_buffers(self: *Self, _: Ctx) Result {
return self.enter_overlay_mode(@import("mode/overlay/buffer_palette.zig").Type); return self.enter_overlay_mode(@import("mode/overlay/buffer_palette.zig").Type);
@ -825,7 +826,7 @@ const cmds = struct {
pub fn select_task(self: *Self, _: Ctx) Result { pub fn select_task(self: *Self, _: Ctx) Result {
return self.enter_overlay_mode(@import("mode/overlay/task_palette.zig").Type); return self.enter_overlay_mode(@import("mode/overlay/task_palette.zig").Type);
} }
pub const select_task_meta = .{ .description = "Select a task to run" }; pub const select_task_meta: Meta = .{ .description = "Run task" };
pub fn add_task(self: *Self, ctx: Ctx) Result { pub fn add_task(self: *Self, ctx: Ctx) Result {
return enter_mini_mode(self, struct { return enter_mini_mode(self, struct {
@ -845,7 +846,7 @@ const cmds = struct {
} }
}, ctx); }, ctx);
} }
pub const add_task_meta = .{ .description = "Add a task to run" }; pub const add_task_meta: Meta = .{ .description = "Add task" };
pub fn delete_task(_: *Self, ctx: Ctx) Result { pub fn delete_task(_: *Self, ctx: Ctx) Result {
var task: []const u8 = undefined; var task: []const u8 = undefined;
@ -858,7 +859,7 @@ const cmds = struct {
pub fn change_theme(self: *Self, _: Ctx) Result { pub fn change_theme(self: *Self, _: Ctx) Result {
return self.enter_overlay_mode(@import("mode/overlay/theme_palette.zig").Type); return self.enter_overlay_mode(@import("mode/overlay/theme_palette.zig").Type);
} }
pub const change_theme_meta = .{ .description = "Select color theme" }; pub const change_theme_meta: Meta = .{ .description = "Change color theme" };
pub fn change_file_type(self: *Self, _: Ctx) Result { pub fn change_file_type(self: *Self, _: Ctx) Result {
return self.enter_overlay_mode(@import("mode/overlay/file_type_palette.zig").Type); return self.enter_overlay_mode(@import("mode/overlay/file_type_palette.zig").Type);
@ -869,7 +870,7 @@ const cmds = struct {
if (build_options.gui) if (build_options.gui)
self.rdr.get_fontfaces(); self.rdr.get_fontfaces();
} }
pub const change_fontface_meta = .{ .description = "Select font face" }; pub const change_fontface_meta: Meta = .{ .description = "Change font" };
pub fn exit_overlay_mode(self: *Self, _: Ctx) Result { pub fn exit_overlay_mode(self: *Self, _: Ctx) Result {
self.rdr.cursor_disable(); self.rdr.cursor_disable();
@ -884,12 +885,12 @@ const cmds = struct {
pub fn find(self: *Self, ctx: Ctx) Result { pub fn find(self: *Self, ctx: Ctx) Result {
return enter_mini_mode(self, @import("mode/mini/find.zig"), ctx); return enter_mini_mode(self, @import("mode/mini/find.zig"), ctx);
} }
pub const find_meta = .{ .description = "Find in current file" }; pub const find_meta: Meta = .{ .description = "Find" };
pub fn find_in_files(self: *Self, ctx: Ctx) Result { pub fn find_in_files(self: *Self, ctx: Ctx) Result {
return enter_mini_mode(self, @import("mode/mini/find_in_files.zig"), ctx); return enter_mini_mode(self, @import("mode/mini/find_in_files.zig"), ctx);
} }
pub const find_in_files_meta = .{ .description = "Find in all project files" }; pub const find_in_files_meta: Meta = .{ .description = "Find in files" };
pub fn goto(self: *Self, ctx: Ctx) Result { pub fn goto(self: *Self, ctx: Ctx) Result {
return enter_mini_mode(self, @import("mode/mini/goto.zig"), ctx); return enter_mini_mode(self, @import("mode/mini/goto.zig"), ctx);
@ -899,7 +900,7 @@ const cmds = struct {
pub fn move_to_char(self: *Self, ctx: Ctx) Result { pub fn move_to_char(self: *Self, ctx: Ctx) Result {
return enter_mini_mode(self, @import("mode/mini/move_to_char.zig"), ctx); return enter_mini_mode(self, @import("mode/mini/move_to_char.zig"), ctx);
} }
pub const move_to_char_meta = .{ .description = "Move cursor to matching character" }; pub const move_to_char_meta: Meta = .{ .description = "Move to character" };
pub fn open_file(self: *Self, ctx: Ctx) Result { pub fn open_file(self: *Self, ctx: Ctx) Result {
if (get_active_selection(self.allocator)) |text| { if (get_active_selection(self.allocator)) |text| {