killingdruid/telegram-tui
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

refactor: add hotkey mapping configuration (P3.10)

Browse Source 
- Add HotkeysConfig structure in src/config.rs
- Implement matches(key: KeyCode, action: &str) method
- Support for 10 configurable hotkeys:
  * Navigation: up, down, left, right (vim + russian + arrows)
  * Actions: reply, forward, delete, copy, react, profile
- Add support for char keys and special keys (Up, Down, Delete, etc)
- Add default values for all hotkeys (english + russian layouts)
- Write 9 unit tests (all passing)
- Add rustdoc documentation with examples
- Update REFACTORING_ROADMAP.md (Priority 3: 4/4 tasks, 100%)
- Update CONTEXT.md with implementation details
- Overall refactoring progress: 12/17 tasks (71%)

Priority 3 is now 100% complete! 🎉

Co-Authored-By: Claude Sonnet 4.5 <noreply@anthropic.com>
This commit is contained in:
Mikhail Kilin
2026-01-31 23:51:10 +03:00
parent 0ca3da54e7
commit 1629c0fc6a
3 changed files with 444 additions and 20 deletions
Download Patch File Download Diff File Expand all files Collapse all files

61
CONTEXT.md
View File

@@ -779,6 +779,67 @@ let message = MessageBuilder::new(MessageId::new(123))
- Интеграция message_grouping в messages.rs
- Реализация message_bubble.rs (теперь разблокировано!)
### 31 января 2026 (поздняя ночь) — Рефакторинг Priority 3: Hotkey Mapping ✅
1. **Создана структура HotkeysConfig** ✅
- **Файл**: `src/config.rs` (расширен на ~230 строк)
- **Реализовано**:
- Структура `HotkeysConfig` с 10 полями hotkeys
- Навигация: up, down, left, right (vim + русские + стрелки)
- Действия: reply, forward, delete, copy, react, profile (англ + русские)
- Метод `matches(key: KeyCode, action: &str) -> bool`
- Приватный метод `key_matches()` для проверки соответствия
- Поддержка специальных клавиш (Up, Down, Delete, Enter, Esc, и др.)
- Дефолтные значения для всех hotkeys
- Default impl для HotkeysConfig
2. **Добавлены unit тесты** ✅
- 9 unit тестов для HotkeysConfig:
- test_hotkeys_matches_char_keys
- test_hotkeys_matches_arrow_keys
- test_hotkeys_matches_vim_keys
- test_hotkeys_matches_russian_vim_keys
- test_hotkeys_matches_special_delete_key
- test_hotkeys_does_not_match_wrong_keys
- test_hotkeys_does_not_match_wrong_actions
- test_hotkeys_unknown_action
- test_config_default_includes_hotkeys
3. **Обновлены файлы проекта** ✅
- Добавлен import `crossterm::event::KeyCode` в config.rs
- Поле `hotkeys` добавлено в структуру `Config`
- `Config::default()` включает `hotkeys: HotkeysConfig::default()`
- Обновлен `REFACTORING_ROADMAP.md`:
- P3.10 отмечено как завершённое ✅
- **Priority 3: 4/4 задач (100%) 🎉🎉**
- **Общий прогресс рефакторинга: 12/17 задач (71%)**
4. **Поддержка конфигурации** ✅
- Пользователи теперь могут настроить hotkeys в `~/.config/tele-tui/config.toml`:
```toml
[hotkeys]
up = ["k", "р", "Up"]
down = ["j", "о", "Down"]
reply = ["r", "к"]
forward = ["f", "а"]
delete = ["d", "в", "Delete"]
copy = ["y", "н"]
react = ["e", "у"]
profile = ["i", "ш"]
```
5. **Результаты**:
- ✅ Код компилируется успешно
- ✅ Все тесты проходят
- ✅ Готово к интеграции в input handlers
**🎉 Priority 3 ЗАВЕРШЁН НА 100%! 🎉**
**Следующие шаги рефакторинга**:
- Priority 4: Качество кода (unit тесты, rustdoc, config validation, async/await)
- Priority 5: Опциональные улучшения (feature flags, LRU cache, tracing)
- Интеграция message_grouping в messages.rs
- Реализация message_bubble.rs
## Известные проблемы
1. При первом запуске нужно пройти авторизацию

63
REFACTORING_ROADMAP.md
View File

@@ -438,46 +438,69 @@ pub fn group_messages(messages: &[MessageInfo]) -> Vec<MessageGroup> {
---
### 10. Hotkey mapping в конфиг
### 10. Hotkey mapping в конфиг ✅ ЗАВЕРШЕНО!
**Статус**: ЗАВЕРШЕНО (2026-01-31)
**Проблема**: Хоткеи захардкожены в коде, нельзя настроить.
**Решение**: Добавить в `config.toml`:
**Решение**: ✅ Добавлено в `config.toml`:
```toml
[hotkeys]
# Навигация
# Навигация (vim + русские + стрелки)
up = ["k", "р", "Up"]
down = ["j", "о", "Down"]
left = ["h", "р", "Left"]
right = ["l", "д", "Right"]
# Действия
# Действия (англ + русские)
reply = ["r", "к"]
forward = ["f", "а"]
delete = ["d", "в", "Delete"]
copy = ["y", "н"]
react = ["e", "у"]
profile = ["i", "ш"]
```
Парсить в `src/config.rs`:
**Что сделано**:
- ✅ Создана структура `HotkeysConfig` в `src/config.rs`
- ✅ Добавлены поля для всех действий (10 hotkeys)
- ✅ Реализован метод `matches(key: KeyCode, action: &str) -> bool`
- ✅ Поддержка символьных клавиш (англ + русские)
- ✅ Поддержка специальных клавиш (Up, Down, Left, Right, Delete, Enter, Esc)
- ✅ Добавлены дефолтные значения для всех hotkeys
- ✅ Написано 9 unit тестов (all passing ✅)
- ✅ Добавлена полная rustdoc документация
- ✅ Config::default() включает hotkeys
**Примеры использования**:
```rust
pub struct Hotkeys {
pub up: Vec<char>,
pub down: Vec<char>,
// ...
let config = Config::default();
// Проверяем английскую клавишу
if config.hotkeys.matches(KeyCode::Char('r'), "reply") {
// Начать ответ
}
impl Hotkeys {
pub fn matches(&self, key: KeyCode, action: &str) -> bool {
// Проверка совпадения
}
// Проверяем русскую клавишу
if config.hotkeys.matches(KeyCode::Char('к'), "reply") {
// Начать ответ (та же логика)
}
// Проверяем стрелку
if config.hotkeys.matches(KeyCode::Up, "up") {
// Вверх по списку
}
```
**Преимущества**:
- Пользовательская настройка хоткеев
- Проще добавлять новые действия
- Документация хоткеев в конфиге
- ✅ Пользовательская настройка хоткеев через config.toml
- ✅ Проще добавлять новые действия
- ✅ Документация хоткеев в конфиге
- ✅ Централизованное управление клавишами
- ✅ Поддержка русской раскладки out of the box
**🎉 Priority 3 ЗАВЕРШЁН НА 100%! 🎉**
---
@@ -699,15 +722,15 @@ tracing-subscriber = "0.3"
- [x] P2.4 — Newtype для ID
- [x] P2.6 — MessageInfo реструктуризация
- [x] P2.7 — MessageBuilder pattern
- [ ] Priority 3: 3/4 задач (75%)
- [x] P3.7 — UI компоненты (частично, 4/5 компонентов)
- [x] Priority 3: 4/4 задач ✅ ЗАВЕРШЕНО! 🎉🎉
- [x] P3.7 — UI компоненты (4/5, message_bubble блокируется)
- [x] P3.8 — Formatting модуль ✅
- [x] P3.9 — Message Grouping ✅
- [ ] P3.10 — Hotkey Mapping
- [x] P3.10 — Hotkey Mapping ✅
- [ ] Priority 4: 0/4 задач
- [ ] Priority 5: 0/3 задач
**Всего**: 11/17 задач (65%)
**Всего**: 12/17 задач (71%)
---

340
src/config.rs
View File

@@ -1,3 +1,4 @@
use crossterm::event::KeyCode;
use serde::{Deserialize, Serialize};
use std::fs;
use std::path::PathBuf;
@@ -8,6 +9,8 @@ pub struct Config {
pub general: GeneralConfig,
#[serde(default)]
pub colors: ColorsConfig,
#[serde(default)]
pub hotkeys: HotkeysConfig,
}
#[derive(Debug, Clone, Serialize, Deserialize)]
@@ -40,6 +43,49 @@ pub struct ColorsConfig {
pub reaction_other: String,
}
#[derive(Debug, Clone, Serialize, Deserialize)]
pub struct HotkeysConfig {
/// Навигация вверх (vim: k, рус: р, стрелка: Up)
#[serde(default = "default_up_keys")]
pub up: Vec<String>,
/// Навигация вниз (vim: j, рус: о, стрелка: Down)
#[serde(default = "default_down_keys")]
pub down: Vec<String>,
/// Навигация влево (vim: h, рус: р, стрелка: Left)
#[serde(default = "default_left_keys")]
pub left: Vec<String>,
/// Навигация вправо (vim: l, рус: д, стрелка: Right)
#[serde(default = "default_right_keys")]
pub right: Vec<String>,
/// Reply — ответить на сообщение (англ: r, рус: к)
#[serde(default = "default_reply_keys")]
pub reply: Vec<String>,
/// Forward — переслать сообщение (англ: f, рус: а)
#[serde(default = "default_forward_keys")]
pub forward: Vec<String>,
/// Delete — удалить сообщение (англ: d, рус: в, Delete key)
#[serde(default = "default_delete_keys")]
pub delete: Vec<String>,
/// Copy — копировать сообщение (англ: y, рус: н)
#[serde(default = "default_copy_keys")]
pub copy: Vec<String>,
/// React — добавить реакцию (англ: e, рус: у)
#[serde(default = "default_react_keys")]
pub react: Vec<String>,
/// Profile — открыть профиль (англ: i, рус: ш)
#[serde(default = "default_profile_keys")]
pub profile: Vec<String>,
}
// Дефолтные значения
fn default_timezone() -> String {
"+03:00".to_string()
@@ -65,6 +111,46 @@ fn default_reaction_other_color() -> String {
"gray".to_string()
}
fn default_up_keys() -> Vec<String> {
vec!["k".to_string(), "р".to_string(), "Up".to_string()]
}
fn default_down_keys() -> Vec<String> {
vec!["j".to_string(), "о".to_string(), "Down".to_string()]
}
fn default_left_keys() -> Vec<String> {
vec!["h".to_string(), "р".to_string(), "Left".to_string()]
}
fn default_right_keys() -> Vec<String> {
vec!["l".to_string(), "д".to_string(), "Right".to_string()]
}
fn default_reply_keys() -> Vec<String> {
vec!["r".to_string(), "к".to_string()]
}
fn default_forward_keys() -> Vec<String> {
vec!["f".to_string(), "а".to_string()]
}
fn default_delete_keys() -> Vec<String> {
vec!["d".to_string(), "в".to_string(), "Delete".to_string()]
}
fn default_copy_keys() -> Vec<String> {
vec!["y".to_string(), "н".to_string()]
}
fn default_react_keys() -> Vec<String> {
vec!["e".to_string(), "у".to_string()]
}
fn default_profile_keys() -> Vec<String> {
vec!["i".to_string(), "ш".to_string()]
}
impl Default for GeneralConfig {
fn default() -> Self {
Self { timezone: default_timezone() }
@@ -83,11 +169,147 @@ impl Default for ColorsConfig {
}
}
impl Default for HotkeysConfig {
fn default() -> Self {
Self {
up: default_up_keys(),
down: default_down_keys(),
left: default_left_keys(),
right: default_right_keys(),
reply: default_reply_keys(),
forward: default_forward_keys(),
delete: default_delete_keys(),
copy: default_copy_keys(),
react: default_react_keys(),
profile: default_profile_keys(),
}
}
}
impl HotkeysConfig {
/// Проверяет, соответствует ли клавиша указанному действию
///
/// # Аргументы
///
/// * `key` - Код нажатой клавиши
/// * `action` - Название действия ("up", "down", "reply", "forward", и т.д.)
///
/// # Возвращает
///
/// `true` если клавиша соответствует действию, иначе `false`
///
/// # Примеры
///
/// ```no_run
/// use tele_tui::config::Config;
/// use crossterm::event::KeyCode;
///
/// let config = Config::default();
///
/// // Проверяем клавишу 'k' для действия "up"
/// assert!(config.hotkeys.matches(KeyCode::Char('k'), "up"));
///
/// // Проверяем русскую клавишу 'р' для действия "up"
/// assert!(config.hotkeys.matches(KeyCode::Char('р'), "up"));
///
/// // Проверяем стрелку вверх
/// assert!(config.hotkeys.matches(KeyCode::Up, "up"));
///
/// // Проверяем клавишу 'r' для действия "reply"
/// assert!(config.hotkeys.matches(KeyCode::Char('r'), "reply"));
/// ```
pub fn matches(&self, key: KeyCode, action: &str) -> bool {
let keys = match action {
"up" => &self.up,
"down" => &self.down,
"left" => &self.left,
"right" => &self.right,
"reply" => &self.reply,
"forward" => &self.forward,
"delete" => &self.delete,
"copy" => &self.copy,
"react" => &self.react,
"profile" => &self.profile,
_ => return false,
};
self.key_matches(key, keys)
}
/// Вспомогательная функция для проверки соответствия KeyCode списку строк
fn key_matches(&self, key: KeyCode, keys: &[String]) -> bool {
for key_str in keys {
match key_str.as_str() {
// Специальные клавиши
"Up" => {
if matches!(key, KeyCode::Up) {
return true;
}
}
"Down" => {
if matches!(key, KeyCode::Down) {
return true;
}
}
"Left" => {
if matches!(key, KeyCode::Left) {
return true;
}
}
"Right" => {
if matches!(key, KeyCode::Right) {
return true;
}
}
"Delete" => {
if matches!(key, KeyCode::Delete) {
return true;
}
}
"Enter" => {
if matches!(key, KeyCode::Enter) {
return true;
}
}
"Esc" => {
if matches!(key, KeyCode::Esc) {
return true;
}
}
"Backspace" => {
if matches!(key, KeyCode::Backspace) {
return true;
}
}
"Tab" => {
if matches!(key, KeyCode::Tab) {
return true;
}
}
// Символьные клавиши (буквы, цифры)
key_char if key_char.len() == 1 => {
if let KeyCode::Char(ch) = key {
if let Some(expected_ch) = key_char.chars().next() {
if ch == expected_ch {
return true;
}
}
}
}
_ => {}
}
}
false
}
}
impl Default for Config {
fn default() -> Self {
Self {
general: GeneralConfig::default(),
colors: ColorsConfig::default(),
hotkeys: HotkeysConfig::default(),
}
}
}
@@ -315,3 +537,121 @@ impl Config {
))
}
}
#[cfg(test)]
mod tests {
use super::*;
#[test]
fn test_hotkeys_matches_char_keys() {
let hotkeys = HotkeysConfig::default();
// Test reply keys (r, к)
assert!(hotkeys.matches(KeyCode::Char('r'), "reply"));
assert!(hotkeys.matches(KeyCode::Char('к'), "reply"));
// Test forward keys (f, а)
assert!(hotkeys.matches(KeyCode::Char('f'), "forward"));
assert!(hotkeys.matches(KeyCode::Char('а'), "forward"));
// Test delete keys (d, в)
assert!(hotkeys.matches(KeyCode::Char('d'), "delete"));
assert!(hotkeys.matches(KeyCode::Char('в'), "delete"));
// Test copy keys (y, н)
assert!(hotkeys.matches(KeyCode::Char('y'), "copy"));
assert!(hotkeys.matches(KeyCode::Char('н'), "copy"));
// Test react keys (e, у)
assert!(hotkeys.matches(KeyCode::Char('e'), "react"));
assert!(hotkeys.matches(KeyCode::Char('у'), "react"));
// Test profile keys (i, ш)
assert!(hotkeys.matches(KeyCode::Char('i'), "profile"));
assert!(hotkeys.matches(KeyCode::Char('ш'), "profile"));
}
#[test]
fn test_hotkeys_matches_arrow_keys() {
let hotkeys = HotkeysConfig::default();
// Test navigation arrows
assert!(hotkeys.matches(KeyCode::Up, "up"));
assert!(hotkeys.matches(KeyCode::Down, "down"));
assert!(hotkeys.matches(KeyCode::Left, "left"));
assert!(hotkeys.matches(KeyCode::Right, "right"));
}
#[test]
fn test_hotkeys_matches_vim_keys() {
let hotkeys = HotkeysConfig::default();
// Test vim navigation keys
assert!(hotkeys.matches(KeyCode::Char('k'), "up"));
assert!(hotkeys.matches(KeyCode::Char('j'), "down"));
assert!(hotkeys.matches(KeyCode::Char('h'), "left"));
assert!(hotkeys.matches(KeyCode::Char('l'), "right"));
}
#[test]
fn test_hotkeys_matches_russian_vim_keys() {
let hotkeys = HotkeysConfig::default();
// Test russian vim navigation keys
assert!(hotkeys.matches(KeyCode::Char('р'), "up"));
assert!(hotkeys.matches(KeyCode::Char('о'), "down"));
assert!(hotkeys.matches(KeyCode::Char('р'), "left"));
assert!(hotkeys.matches(KeyCode::Char('д'), "right"));
}
#[test]
fn test_hotkeys_matches_special_delete_key() {
let hotkeys = HotkeysConfig::default();
// Test Delete key for delete action
assert!(hotkeys.matches(KeyCode::Delete, "delete"));
}
#[test]
fn test_hotkeys_does_not_match_wrong_keys() {
let hotkeys = HotkeysConfig::default();
// Test wrong keys don't match
assert!(!hotkeys.matches(KeyCode::Char('x'), "reply"));
assert!(!hotkeys.matches(KeyCode::Char('z'), "forward"));
assert!(!hotkeys.matches(KeyCode::Char('q'), "delete"));
assert!(!hotkeys.matches(KeyCode::Enter, "copy"));
}
#[test]
fn test_hotkeys_does_not_match_wrong_actions() {
let hotkeys = HotkeysConfig::default();
// Test valid keys don't match wrong actions
assert!(!hotkeys.matches(KeyCode::Char('r'), "forward"));
assert!(!hotkeys.matches(KeyCode::Char('f'), "reply"));
assert!(!hotkeys.matches(KeyCode::Char('d'), "copy"));
}
#[test]
fn test_hotkeys_unknown_action() {
let hotkeys = HotkeysConfig::default();
// Unknown actions should return false
assert!(!hotkeys.matches(KeyCode::Char('r'), "unknown_action"));
assert!(!hotkeys.matches(KeyCode::Enter, "foo"));
}
#[test]
fn test_config_default_includes_hotkeys() {
let config = Config::default();
// Verify hotkeys are included in default config
assert_eq!(config.hotkeys.reply, vec!["r", "к"]);
assert_eq!(config.hotkeys.forward, vec!["f", "а"]);
assert_eq!(config.hotkeys.delete, vec!["d", "в", "Delete"]);
assert_eq!(config.hotkeys.copy, vec!["y", "н"]);
assert_eq!(config.hotkeys.react, vec!["e", "у"]);
assert_eq!(config.hotkeys.profile, vec!["i", "ш"]);
}
}