config text editor

initial work on text editor
show proper error in footer
add open config editor to keybind
proper theming
update command bar

updated CHANGELOG

better dark theme.

Author: casperstorm

CHANGELOG.md

@@ -3,6 +3,7 @@
 Added:
 
 - Internal buffers (logs, highlights, etc) can be added to sidebar
+- Config editor pane for editing the config file in-app
 - Improved legibility of the returned values of `MONITOR` list (`/monitor L`)
 - Config option (`preview.card.description_decode_html`) to decode html strings in preview card descriptions
 - Support displaying a larger version of the card images in-app

Cargo.lock

@@ -92,6 +92,7 @@ iced = { workspace = true, features = [
     "x11",
     "crisp",
     "web-colors",
+    "highlighter",
 ] }
 percent-encoding = { workspace = true }
 

Cargo.toml

@@ -211,6 +211,12 @@
       "css": "eraser",
       "code": 61741,
       "src": "fontawesome"
+    },
+    {
+      "uid": "6533bdc16ab201eb3f3b27ce989cab33",
+      "css": "folder-open-empty",
+      "code": 61717,
+      "src": "fontawesome"
     }
   ]
 }

assets/fontello/config.json

@@ -37,6 +37,8 @@ pub enum Internal {
     Highlights,
     #[strum(serialize = "Channel Discovery")]
     ChannelDiscovery(Option<Server>),
+    #[strum(serialize = "Config Editor")]
+    ConfigEditor,
 }
 
 impl Buffer {
@@ -114,6 +116,7 @@ impl Internal {
         Self::Logs,
         Self::Highlights,
         Self::ChannelDiscovery(None),
+        Self::ConfigEditor,
     ];
 
     pub fn key(&self) -> String {
@@ -122,6 +125,7 @@ impl Internal {
             Internal::Logs => "logs",
             Internal::Highlights => "highlights",
             Internal::ChannelDiscovery(_) => "channel-discovery",
+            Internal::ConfigEditor => "config-editor",
         }
         .to_string()
     }
@@ -130,6 +134,7 @@ impl Internal {
 impl From<config::sidebar::InternalBuffer> for Internal {
     fn from(config: config::sidebar::InternalBuffer) -> Self {
         match config {
+            config::sidebar::InternalBuffer::ConfigEditor => Self::ConfigEditor,
             config::sidebar::InternalBuffer::FileTransfers => {
                 Self::FileTransfers
             }

data/src/buffer.rs

@@ -529,7 +529,7 @@ impl Config {
             .map_err(|e| Error::LoadConfigFile(e.to_string()))?;
 
         let config = toml::Deserializer::parse(content.as_ref())
-            .map_err(|e| Error::Parse(e.to_string()))?;
+            .map_err(|e| Error::Parse(ParseError::new(&content, &e)))?;
 
         let Configuration {
             theme,
@@ -560,7 +560,7 @@ impl Config {
         } = serde_ignored::deserialize(config, |ignored| {
             log::warn!("[config.toml] Ignoring unknown setting: {ignored}");
         })
-        .map_err(|e| Error::Parse(e.to_string()))?;
+        .map_err(|e| Error::Parse(ParseError::new(&content, &e)))?;
 
         keyboard.validate()?;
 
@@ -790,6 +790,32 @@ pub fn random_nickname_with_seed<R: Rng>(rng: &mut R) -> String {
     rand_nick
 }
 
+#[derive(Debug, Clone)]
+pub struct ParseError {
+    /// Short description of the problem, e.g. `invalid basic string`.
+    pub message: String,
+    /// Full rendered error, including a snippet of the offending TOML.
+    pub details: String,
+    /// Zero-indexed line of the parse error in the config file.
+    pub line: Option<usize>,
+}
+
+impl ParseError {
+    fn new(content: &str, error: &toml::de::Error) -> Self {
+        let line = error.span().map(|span| {
+            content[..span.start.min(content.len())]
+                .matches('\n')
+                .count()
+        });
+
+        Self {
+            message: error.message().to_owned(),
+            details: error.to_string(),
+            line,
+        }
+    }
+}
+
 #[derive(Debug, Error, Clone)]
 pub enum Error {
     #[error("config could not be read: {0}")]
@@ -798,8 +824,8 @@ pub enum Error {
     ExecutePasswordCommand(String),
     #[error("{0}")]
     Io(String),
-    #[error("{0}")]
-    Parse(String),
+    #[error("{}", .0.details)]
+    Parse(ParseError),
     #[error("UTF8 parsing error: {0}")]
     StrUtf8Error(#[from] str::Utf8Error),
     #[error("UTF8 parsing error: {0}")]

data/src/config.rs

@@ -42,6 +42,7 @@ pub struct Keyboard {
     pub cycle_previous_unread_buffer: KeyBinds,
     pub mark_as_read: KeyBinds,
     pub quit_application: KeyBinds,
+    pub open_config_editor: KeyBinds,
     pub open_config_file: KeyBinds,
 }
 
@@ -80,6 +81,7 @@ impl Default for Keyboard {
                 KeyBind::cycle_previous_unread_buffer().into(),
             mark_as_read: KeyBind::mark_as_read().into(),
             quit_application: KeyBind::quit_application().into(),
+            open_config_editor: KeyBind::open_config_editor().into(),
             open_config_file: KeyBind::open_config_file().into(),
         }
     }
@@ -122,6 +124,7 @@ impl Keyboard {
             ),
             (&self.mark_as_read, MarkAsRead),
             (&self.quit_application, QuitApplication),
+            (&self.open_config_editor, OpenConfigEditor),
             (&self.open_config_file, OpenConfigFile),
         ]
     }

data/src/config/keys.rs

@@ -297,6 +297,7 @@ pub enum OrderChannelsBy {
 #[derive(Debug, Copy, Clone, Deserialize, PartialEq, Eq)]
 #[serde(rename_all = "kebab-case")]
 pub enum InternalBuffer {
+    ConfigEditor,
     FileTransfers,
     ChannelDiscovery,
     Highlights,

data/src/config/sidebar.rs

@@ -132,6 +132,7 @@ impl Kind {
             }
             Buffer::Internal(buffer::Internal::FileTransfers) => None,
             Buffer::Internal(buffer::Internal::ChannelDiscovery(_)) => None,
+            Buffer::Internal(buffer::Internal::ConfigEditor) => None,
         }
     }
 }

data/src/history.rs

@@ -108,6 +108,7 @@ pub enum Command {
     CycleNextUnreadBuffer,
     CyclePreviousUnreadBuffer,
     MarkAsRead,
+    OpenConfigEditor,
     OpenConfigFile,
 }
 
@@ -356,9 +357,10 @@ impl KeyBind {
     #[cfg(not(target_os = "linux"))]
     default!(quit_application);
     #[cfg(target_os = "macos")]
-    default!(open_config_file, ",", COMMAND);
+    default!(open_config_editor, ",", COMMAND);
     #[cfg(not(target_os = "macos"))]
-    default!(open_config_file, ",", CTRL);
+    default!(open_config_editor, ",", CTRL);
+    default!(open_config_file);
 }
 
 impl From<(keyboard::Key, keyboard::Modifiers)> for KeyBind {