implement welcome and help screens for better onboarding

Cargo.toml

@@ -11,7 +11,7 @@ data = { version = "0.1.0", path = "data" }
 
 chrono = { version = "0.4", features = ['serde'] }
 fern = "0.6.1"
-iced = { version = "0.9", features = ["tokio", "lazy", "advanced"] }
+iced = { version = "0.9", features = ["tokio", "lazy", "advanced", "image"] }
 log = "0.4.16"
 palette = "=0.7.2"
 thiserror = "1.0.30"

data/src/config.rs

@@ -1,4 +1,4 @@
-use std::fs::File;
+use std::fs::{self, File};
 use std::io::BufReader;
 use std::path::PathBuf;
 
@@ -8,6 +8,8 @@ use thiserror::Error;
 use crate::palette::Palette;
 use crate::{environment, pane, server};
 
+const CONFIG_TEMPLATE: &[u8] = include_bytes!("../../config.yaml");
+
 #[derive(Debug, Clone, Default, Deserialize)]
 pub struct Config {
     #[serde(default)]
@@ -19,38 +21,45 @@ pub struct Config {
 }
 
 impl Config {
-    pub fn config_dir() -> Result<PathBuf, Error> {
-        let dir = environment::config_dir()
-            .ok_or(Error::DirectoryNotFound)?
-            .join("halloy");
+    pub fn config_dir() -> PathBuf {
+        let dir = environment::config_dir().join("halloy");
 
         if !dir.exists() {
-            std::fs::create_dir(dir.as_path()).map_err(|_| Error::DirectoryCreation)?;
+            std::fs::create_dir(dir.as_path())
+                .expect("expected permissions to create config folder");
         }
 
-        Ok(dir)
+        dir
     }
 
-    fn path() -> Result<PathBuf, Error> {
-        Ok(Self::config_dir()?.join("config.yaml"))
+    fn path() -> PathBuf {
+        Self::config_dir().join("config.yaml")
     }
 
     pub fn load() -> Result<Self, Error> {
-        let path = Self::path()?;
+        let path = Self::path();
         let file = File::open(path).map_err(|e| Error::Read(e.to_string()))?;
 
         serde_yaml::from_reader(BufReader::new(file)).map_err(|e| Error::Parse(e.to_string()))
     }
+
+    pub fn create_template_config() {
+        // Checks if a config file is there
+        let config_file = Self::path();
+        if config_file.exists() {
+            return;
+        }
+
+        // Create template configuration file.
+        let config_template_file = Self::config_dir().join("config.template.yaml");
+        let _ = fs::write(config_template_file, CONFIG_TEMPLATE);
+    }
 }
 
 #[derive(Debug, Error, Clone)]
 pub enum Error {
-    #[error("config directory could not be found")]
-    DirectoryNotFound,
-    #[error("config directory could not be created")]
-    DirectoryCreation,
     #[error("config could not be read: {0}")]
     Read(String),
-    #[error("config could not be parsed: {0}")]
+    #[error("{0}")]
     Parse(String),
 }

data/src/environment.rs

@@ -12,7 +12,7 @@ pub fn formatted_version() -> String {
     format!("{}{hash}", VERSION)
 }
 
-pub(crate) fn config_dir() -> Option<PathBuf> {
+pub(crate) fn config_dir() -> PathBuf {
     // HOST_* checked first for flatpak
     #[cfg(target_os = "linux")]
     {
@@ -21,11 +21,12 @@ pub(crate) fn config_dir() -> Option<PathBuf> {
             .map(PathBuf::from)
             .filter(|p| is_absolute(p))
             .or_else(dirs_next::config_dir)
+            .expect("expected valid config dir")
     }
 
     #[cfg(not(target_os = "linux"))]
     {
-        dirs_next::config_dir()
+        dirs_next::config_dir().expect("expected valid config dir")
     }
 }
 
@@ -46,6 +47,7 @@ pub(crate) fn data_dir() -> Option<PathBuf> {
     }
 }
 
+#[allow(dead_code)]
 fn is_absolute(path: &Path) -> bool {
     path.is_absolute()
 }

data/src/message.rs

@@ -358,9 +358,8 @@ pub(crate) mod broadcast {
     //! Generate messages that can be broadcast into every buffer
     use chrono::Utc;
 
-    use crate::user::Nick;
-
     use super::{Direction, Message, Sender, Source};
+    use crate::user::Nick;
 
     fn expand(
         channels: impl IntoIterator<Item = String>,

data/src/stream.rs

@@ -2,8 +2,7 @@ use std::time::Duration;
 
 use futures::channel::mpsc;
 use futures::never::Never;
-use futures::stream;
-use futures::{SinkExt, StreamExt};
+use futures::{stream, SinkExt, StreamExt};
 use irc::proto::Capability;
 use tokio::time::{self, Instant, Interval};
 

src/buffer.rs

@@ -1,4 +1,4 @@
-use data::{buffer, config, history};
+use data::{buffer, history};
 use iced::Command;
 
 use self::channel::Channel;
@@ -89,12 +89,9 @@ impl Buffer {
         history: &'a history::Manager,
         settings: &'a buffer::Settings,
         is_focused: bool,
-        load_config_error: &'a Option<config::Error>,
     ) -> Element<'a, Message> {
         match self {
-            Buffer::Empty(state) => {
-                empty::view(state, clients, load_config_error).map(Message::Empty)
-            }
+            Buffer::Empty(state) => empty::view(state).map(Message::Empty),
             Buffer::Channel(state) => {
                 let status = clients.status(&state.server);
 

src/buffer/empty.rs

@@ -1,55 +1,21 @@
 use core::fmt;
 
-use data::{config, Config};
-use iced::widget::{button, column, container, text, vertical_space};
+use iced::widget::{column, container, text};
 use iced::{alignment, Length};
 
-use crate::theme;
-use crate::widget::{Collection, Element};
+use crate::widget::Element;
 
 #[derive(Debug, Clone)]
-pub enum Message {
-    ConfigurationDirectoryPressed,
-}
+pub enum Message {}
 
 #[derive(Debug, Clone)]
 pub enum Event {}
 
-pub fn view<'a>(
-    _state: &Empty,
-    clients: &data::client::Map,
-    // TODO: Make error a separate screen so we don't
-    // have to pass this all the way down
-    load_config_error: &'a Option<config::Error>,
-) -> Element<'a, Message> {
-    let is_empty = clients.get_channels().is_empty();
-    let config_dir = is_empty
-        .then(|| {
-            Config::config_dir()
-                .map(|path| String::from(path.to_string_lossy()))
-                .ok()
-        })
-        .flatten();
-
-    let error = load_config_error
-        .as_ref()
-        .map(|error| text(error.to_string()).style(theme::Text::Error));
-    let title = if is_empty {
-        text("please create or edit config.yaml in the directory below")
-    } else {
-        text("you had me at halloy")
-    };
+pub fn view<'a>(_state: &Empty) -> Element<'a, Message> {
+    // TODO: Consider if we can completetly remove this buffer.
 
-    let action = config_dir.map(|path| {
-        button(text(path))
-            .on_press(Message::ConfigurationDirectoryPressed)
-            .style(theme::Button::Default)
-    });
     let content = column![]
-        .push_maybe(error)
-        .push(title)
-        .push(vertical_space(14))
-        .push_maybe(action)
+        .push(text("⟵ select buffer"))
         .align_items(iced::Alignment::Center);
 
     container(content)
@@ -64,17 +30,7 @@ pub fn view<'a>(
 pub struct Empty {}
 
 impl Empty {
-    pub fn update(&mut self, message: Message) -> Option<Event> {
-        match message {
-            Message::ConfigurationDirectoryPressed => {
-                let Ok(config) = Config::config_dir() else {
-                    return None
-                };
-
-                let _ = open::that(config);
-            }
-        }
-
+    pub fn update(&mut self, _message: Message) -> Option<Event> {
         None
     }
 }

src/font.rs

@@ -6,7 +6,7 @@ pub const MONO: Font = Font {
     ..Font::with_name("Iosevka Term")
 };
 
-pub const _MONO_BOLD: Font = Font {
+pub const MONO_BOLD: Font = Font {
     monospaced: true,
     weight: font::Weight::Bold,
     ..Font::with_name("Iosevka Term")

src/icon.rs

@@ -6,6 +6,10 @@ use crate::{font, theme};
 
 // Based off https://github.com/iced-rs/iced_aw/blob/main/src/graphics/icons/bootstrap.rs
 
+pub fn error<'a>() -> Text<'a> {
+    to_text('\u{f33a}')
+}
+
 pub fn globe<'a>() -> Text<'a> {
     to_text('\u{f3ef}')
 }
@@ -40,6 +44,7 @@ pub fn people<'a>() -> Text<'a> {
 
 fn to_text<'a>(unicode: char) -> Text<'a> {
     text(unicode.to_string())
+        .style(theme::Text::Primary)
         .line_height(LineHeight::Relative(1.1))
         .size(theme::ICON_SIZE)
         .font(font::ICON)