fix(tui): annotate opaque tui literals

Add missing argument comments around positional boolean and numeric
literals that the TUI keymap work now reaches.

This keeps callsites self-documenting and satisfies the
argument-comment lint in CI.
This commit is contained in:
Felipe Coury
2026-04-23 10:35:34 -03:00
parent 2228d45325
commit 2e15fb0666
6 changed files with 64 additions and 47 deletions
@@ -1322,8 +1322,11 @@ mod tests {
};
let view = make_overlay(exec_request, tx, Features::with_defaults());
let mut buf = Buffer::empty(Rect::new(0, 0, 80, view.desired_height(80)));
view.render(Rect::new(0, 0, 80, view.desired_height(80)), &mut buf);
let mut buf = Buffer::empty(Rect::new(0, 0, 80, view.desired_height(/*width*/ 80)));
view.render(
Rect::new(0, 0, 80, view.desired_height(/*width*/ 80)),
&mut buf,
);
let rendered: Vec<String> = (0..buf.area.height)
.map(|row| {
@@ -1553,8 +1556,11 @@ mod tests {
};
let view = make_overlay(exec_request, tx, Features::with_defaults());
let mut buf = Buffer::empty(Rect::new(0, 0, 100, view.desired_height(100)));
view.render(Rect::new(0, 0, 100, view.desired_height(100)), &mut buf);
let mut buf = Buffer::empty(Rect::new(0, 0, 100, view.desired_height(/*width*/ 100)));
view.render(
Rect::new(0, 0, 100, view.desired_height(/*width*/ 100)),
&mut buf,
);
let rendered: Vec<String> = (0..buf.area.height)
.map(|row| {
+28 -28
View File
@@ -2941,11 +2941,11 @@ impl ChatComposer {
self.footer_mode = reset_mode_after_activity(self.footer_mode);
}
if self.queue_keys.is_pressed(key_event) && self.is_task_running {
return self.handle_submission(true);
return self.handle_submission(/*should_queue*/ true);
}
if self.submit_keys.is_pressed(key_event) {
return self.handle_submission(false);
return self.handle_submission(/*should_queue*/ false);
}
match key_event {
@@ -5062,7 +5062,7 @@ mod tests {
"Ask Codex to do anything".to_string(),
/*disable_paste_burst*/ false,
);
composer.set_vim_enabled(true);
composer.set_vim_enabled(/*enabled*/ true);
composer.handle_key_event(KeyEvent::new(KeyCode::Char('i'), KeyModifiers::NONE));
assert!(composer.is_empty());
@@ -5208,14 +5208,14 @@ mod tests {
let (tx, _rx) = unbounded_channel::<AppEvent>();
let sender = AppEventSender::new(tx);
let mut composer = ChatComposer::new(
true,
/*has_input_focus*/ true,
sender,
true,
/*enhanced_keys_supported*/ true,
"Ask Codex to do anything".to_string(),
false,
/*disable_paste_burst*/ false,
);
composer.set_steer_enabled(true);
composer.set_vim_enabled(true);
composer.set_steer_enabled(/*enabled*/ true);
composer.set_vim_enabled(/*enabled*/ true);
assert!(composer.textarea.is_vim_enabled());
assert_eq!(
@@ -5225,7 +5225,7 @@ mod tests {
composer.handle_key_event(KeyEvent::new(KeyCode::Char('i'), KeyModifiers::NONE));
composer.set_text_content("h".to_string(), Vec::new(), Vec::new());
let (result, _) = composer.handle_submission(false);
let (result, _) = composer.handle_submission(/*should_queue*/ false);
assert!(composer.textarea.is_vim_enabled());
assert_eq!(
@@ -5248,13 +5248,13 @@ mod tests {
let (tx, _rx) = unbounded_channel::<AppEvent>();
let sender = AppEventSender::new(tx);
let mut composer = ChatComposer::new(
true,
/*has_input_focus*/ true,
sender,
true,
/*enhanced_keys_supported*/ true,
"Ask Codex to do anything".to_string(),
false,
/*disable_paste_burst*/ false,
);
composer.set_vim_enabled(true);
composer.set_vim_enabled(/*enabled*/ true);
composer.handle_key_event(KeyEvent::new(KeyCode::Char('i'), KeyModifiers::NONE));
composer.set_text_content("hey".to_string(), Vec::new(), Vec::new());
@@ -5285,11 +5285,11 @@ mod tests {
let (tx, _rx) = unbounded_channel::<AppEvent>();
let sender = AppEventSender::new(tx);
let mut composer = ChatComposer::new(
true,
/*has_input_focus*/ true,
sender,
true,
/*enhanced_keys_supported*/ true,
"Ask Codex to do anything".to_string(),
false,
/*disable_paste_burst*/ false,
);
let area = Rect::new(0, 0, 80, 10);
let style_output = |style| {
@@ -5302,7 +5302,7 @@ mod tests {
assert_eq!(style_output(composer.cursor_style(area)), default,);
composer.set_vim_enabled(true);
composer.set_vim_enabled(/*enabled*/ true);
assert_eq!(style_output(composer.cursor_style(area)), default,);
composer.handle_key_event(KeyEvent::new(KeyCode::Char('i'), KeyModifiers::NONE));
@@ -5486,13 +5486,13 @@ mod tests {
let (tx, _rx) = unbounded_channel::<AppEvent>();
let sender = AppEventSender::new(tx);
let mut composer = ChatComposer::new(
true,
/*has_input_focus*/ true,
sender,
false,
/*enhanced_keys_supported*/ false,
"Ask Codex to do anything".to_string(),
false,
/*disable_paste_burst*/ false,
);
composer.set_steer_enabled(true);
composer.set_steer_enabled(/*enabled*/ true);
let (result, needs_redraw) =
composer.handle_key_event(KeyEvent::new(KeyCode::Char('?'), KeyModifiers::SHIFT));
@@ -6589,7 +6589,7 @@ mod tests {
"Ask Codex to do anything".to_string(),
/*disable_paste_burst*/ false,
);
composer.set_steer_enabled(true);
composer.set_steer_enabled(/*enabled*/ true);
let input = "x".repeat(MAX_USER_INPUT_TEXT_CHARS);
composer.textarea.set_text_clearing_elements(&input);
@@ -6617,7 +6617,7 @@ mod tests {
"Ask Codex to do anything".to_string(),
/*disable_paste_burst*/ false,
);
composer.set_steer_enabled(true);
composer.set_steer_enabled(/*enabled*/ true);
let input = "x".repeat(MAX_USER_INPUT_TEXT_CHARS + 1);
composer.textarea.set_text_clearing_elements(&input);
@@ -6784,13 +6784,13 @@ mod tests {
let (tx, _rx) = unbounded_channel::<AppEvent>();
let sender = AppEventSender::new(tx);
let mut composer = ChatComposer::new(
true,
/*has_input_focus*/ true,
sender,
true,
/*enhanced_keys_supported*/ true,
"Ask Codex to do anything".to_string(),
false,
/*disable_paste_burst*/ false,
);
composer.set_vim_enabled(true);
composer.set_vim_enabled(/*enabled*/ true);
composer.handle_key_event(KeyEvent::new(KeyCode::Char('i'), KeyModifiers::NONE));
composer.set_text_content("hey you, how are you?".to_string(), Vec::new(), Vec::new());
composer.textarea.set_cursor(composer.textarea.text().len());
@@ -7069,7 +7069,7 @@ mod tests {
"Ask Codex to do anything".to_string(),
/*disable_paste_burst*/ false,
);
composer.set_steer_enabled(true);
composer.set_steer_enabled(/*enabled*/ true);
composer.textarea.insert_str("restore me");
composer.textarea.set_cursor(/*pos*/ 0);
+3 -3
View File
@@ -480,7 +480,7 @@ impl TextArea {
}
if keymap.delete_backward.is_pressed(event) {
self.delete_backward(1);
self.delete_backward(/*n*/ 1);
return;
}
if keymap.delete_forward_word.is_pressed(event) {
@@ -488,7 +488,7 @@ impl TextArea {
return;
}
if keymap.delete_forward.is_pressed(event) {
self.delete_forward(1);
self.delete_forward(/*n*/ 1);
return;
}
if keymap.kill_line_start.is_pressed(event) {
@@ -666,7 +666,7 @@ impl TextArea {
return;
}
if self.vim_normal_keymap.delete_char.is_pressed(event) {
self.delete_forward_kill(1);
self.delete_forward_kill(/*n*/ 1);
return;
}
if self.vim_normal_keymap.delete_to_line_end.is_pressed(event) {
+5 -5
View File
@@ -198,23 +198,23 @@ impl KeyboardHandler for AuthModeWidget {
}
if self.onboarding_keymap.move_up.is_pressed(key_event) {
self.move_highlight(-1);
self.move_highlight(/*delta*/ -1);
return;
}
if self.onboarding_keymap.move_down.is_pressed(key_event) {
self.move_highlight(1);
self.move_highlight(/*delta*/ 1);
return;
}
if self.onboarding_keymap.select_first.is_pressed(key_event) {
self.select_option_by_index(0);
self.select_option_by_index(/*index*/ 0);
return;
}
if self.onboarding_keymap.select_second.is_pressed(key_event) {
self.select_option_by_index(1);
self.select_option_by_index(/*index*/ 1);
return;
}
if self.onboarding_keymap.select_third.is_pressed(key_event) {
self.select_option_by_index(2);
self.select_option_by_index(/*index*/ 2);
return;
}
if self.onboarding_keymap.confirm.is_pressed(key_event) {
+5 -1
View File
@@ -206,7 +206,11 @@ mod tests {
fn ctrl_shift_dot_changes_animation_variant() {
let mut widget = WelcomeWidget {
is_logged_in: false,
animation: AsciiAnimation::with_variants(FrameRequester::test_dummy(), &VARIANTS, 0),
animation: AsciiAnimation::with_variants(
FrameRequester::test_dummy(),
&VARIANTS,
/*variant_idx*/ 0,
),
animations_enabled: true,
animations_suppressed: Cell::new(false),
toggle_animation_keys: crate::keymap::RuntimeKeymap::defaults()
+13 -6
View File
@@ -767,7 +767,7 @@ impl StaticOverlay {
keymap: PagerKeymap,
) -> Self {
Self {
view: PagerView::new(renderables, title, 0, keymap),
view: PagerView::new(renderables, title, /*scroll_offset*/ 0, keymap),
is_done: false,
}
}
@@ -1299,9 +1299,12 @@ mod tests {
#[test]
fn pager_view_content_height_counts_renderables() {
let pv = pager_view(
vec![paragraph_block("a", 2), paragraph_block("b", 3)],
vec![
paragraph_block("a", /*lines*/ 2),
paragraph_block("b", /*lines*/ 3),
],
"T",
0,
/*scroll_offset*/ 0,
);
assert_eq!(pv.content_height(/*width*/ 80), 5);
@@ -1316,7 +1319,7 @@ mod tests {
paragraph_block("c", /*lines*/ 3),
],
"T",
0,
/*scroll_offset*/ 0,
);
let area = Rect::new(0, 0, 20, 8);
@@ -1351,7 +1354,7 @@ mod tests {
paragraph_block("c", /*lines*/ 3),
],
"T",
0,
/*scroll_offset*/ 0,
);
let area = Rect::new(0, 0, 20, 3);
@@ -1363,7 +1366,11 @@ mod tests {
#[test]
fn pager_view_is_scrolled_to_bottom_accounts_for_wrapped_height() {
let mut pv = pager_view(vec![paragraph_block("a", 10)], "T", 0);
let mut pv = pager_view(
vec![paragraph_block("a", /*lines*/ 10)],
"T",
/*scroll_offset*/ 0,
);
let area = Rect::new(0, 0, 20, 8);
let mut buf = Buffer::empty(area);