feat(helper): add more external help providers to plz menu

src/cli.rs

@@ -51,6 +51,12 @@ pub enum CliCommands {
         /// Use a custom URL for cheat.sh.
         #[arg(long, env = "CHEAT_SH_URL", value_name = "URL")]
         cheat_sh_url: Option<String>,
+        /// Use a custom provider URL for `eg` pages.
+        #[arg(long, env = "EG_PAGES_URL", value_name = "URL")]
+        eg_url: Option<String>,
+        /// Use a custom URL for cheat sheets.
+        #[arg(long, env = "CHEATSHEETS_URL", value_name = "URL")]
+        cheat_url: Option<String>,
         /// Sets the pager to use.
         #[arg(short, long)]
         pager: Option<String>,
@@ -76,6 +82,7 @@ impl CliArgs {
         if let Some(CliCommands::Plz {
             ref man_cmd,
             ref cheat_sh_url,
+            ref eg_url,
             no_pager,
             ref pager,
             ..
@@ -85,7 +92,10 @@ impl CliArgs {
                 config.man_command = man_cmd.clone();
             }
             if let Some(cheat_sh_url) = cheat_sh_url {
-                config.cheat_sh_url = cheat_sh_url.clone();
+                config.cheat_sh_url = Some(cheat_sh_url.clone());
+            }
+            if let Some(eg_url) = eg_url {
+                config.eg_url = Some(eg_url.to_owned());
             }
             if no_pager {
                 config.pager_command = None;
@@ -116,6 +126,8 @@ mod tests {
                 cmd: "ps".to_string(),
                 pager: Some("bat".to_string()),
                 cheat_sh_url: None,
+                cheat_url: None,
+                eg_url: None,
                 man_cmd: None,
                 no_pager: false,
             }),

src/config.rs

@@ -1,7 +1,9 @@
 use crate::error::Result;
 use crate::helper::args::common::{HelpArg, VersionArg};
 use crate::helper::args::FOUND_EMOTICON;
-use crate::helper::docs::cheat::DEFAULT_CHEAT_SHEET_PROVIDER;
+use crate::helper::docs::cheat_sh::DEFAULT_CHEAT_SHEET_PROVIDER;
+use crate::helper::docs::cheatsheets::DEFAULT_CHEATSHEETS_PROVIDER;
+use crate::helper::docs::eg::DEFAULT_EG_PAGES_PROVIDER;
 use colored::*;
 use serde::{Deserialize, Serialize};
 use std::env;
@@ -24,7 +26,11 @@ pub struct Config {
     /// Pager to use for command outputs, None to disable.
     pub pager_command: Option<String>,
     /// Use a custom URL for cheat.sh.
-    pub cheat_sh_url: String,
+    pub cheat_sh_url: Option<String>,
+    /// Use a custom URL for `eg` pages provider.
+    pub eg_url: Option<String>,
+    /// Use a custom URL for cheatsheets provider.
+    pub cheatsheets_url: Option<String>,
 }
 
 impl Default for Config {
@@ -44,7 +50,9 @@ impl Default for Config {
             ]),
             man_command: "man".to_string(),
             pager_command: Some("less -R".to_string()),
-            cheat_sh_url: DEFAULT_CHEAT_SHEET_PROVIDER.to_string(),
+            cheat_sh_url: Some(DEFAULT_CHEAT_SHEET_PROVIDER.to_string()),
+            eg_url: Some(DEFAULT_EG_PAGES_PROVIDER.to_string()),
+            cheatsheets_url: Some(DEFAULT_CHEATSHEETS_PROVIDER.to_string()),
         }
     }
 }
@@ -128,7 +136,10 @@ mod tests {
         let config = Config::parse(&path)?;
         assert!(config.check_help);
         assert!(config.check_version);
-        assert_eq!(config.cheat_sh_url, DEFAULT_CHEAT_SHEET_PROVIDER);
+        assert_eq!(
+            config.cheat_sh_url,
+            Some(DEFAULT_CHEAT_SHEET_PROVIDER.to_string())
+        );
         Ok(())
     }
 }

src/error.rs

@@ -18,6 +18,9 @@ pub enum Error {
     /// Error that might occur while serializing the configuration into TOML.
     #[error("TOML serialization error: `{0}`")]
     TomlSerializeError(#[from] toml::ser::Error),
+    /// Error that might occur when tray to get help from an external provider
+    #[error("External help provider error: `{0}`")]
+    ProviderError(String),
 }
 
 /// Type alias for the standard [`Result`] type.

src/helper/docs/cheat_sh.rs

@@ -0,0 +1,54 @@
+use crate::error::{Error, Result};
+use crate::helper::docs::HelpProvider;
+use ureq::{AgentBuilder, Request};
+
+/// Default cheat sheet provider URL.
+pub const DEFAULT_CHEAT_SHEET_PROVIDER: &str = "https://cheat.sh";
+
+/// User agent for the cheat sheet provider.
+///
+/// See <https://github.com/chubin/cheat.sh/blob/83bffa587b6c1048cbcc40ea8fa6af675203fd5f/bin/app.py#L76>
+const CHEAT_SHEET_USER_AGENT: &str = "fetch";
+
+/// The `cheat.sh` provider
+pub struct CheatDotSh;
+
+impl HelpProvider for CheatDotSh {
+    fn url(&self) -> &'static str {
+        DEFAULT_CHEAT_SHEET_PROVIDER
+    }
+
+    fn build_request(&self, cmd: &str, url: &str) -> Request {
+        AgentBuilder::new()
+            .user_agent(CHEAT_SHEET_USER_AGENT)
+            .build()
+            .get(&format!("{}/{}", url, cmd))
+    }
+
+    fn fetch(&self, cmd: &str, custom_url: &Option<String>) -> Result<String> {
+        let response = self._fetch(cmd, custom_url);
+        if let Ok(page) = &response {
+            if page.starts_with("Unknown topic.") {
+                return Err(Error::ProviderError(page.to_owned()));
+            }
+        }
+        response
+    }
+}
+
+#[cfg(test)]
+mod tests {
+    use super::*;
+
+    #[test]
+    fn test_fetch_cheat_sheet() -> Result<()> {
+        let output = CheatDotSh.fetch("ls", &None)?;
+        assert!(output.contains(
+            "# To display all files, along with the size (with unit suffixes) and timestamp:"
+        ));
+        assert!(output.contains(
+            "# Long format list with size displayed using human-readable units (KiB, MiB, GiB):"
+        ));
+        Ok(())
+    }
+}

src/helper/docs/cheatsheets.rs

@@ -0,0 +1,43 @@
+use crate::helper::docs::HelpProvider;
+use ureq::{AgentBuilder, Request};
+
+/// The default cheatsheets provider URL.
+pub const DEFAULT_CHEATSHEETS_PROVIDER: &str =
+    "https://raw.githubusercontent.com/cheat/cheatsheets/master";
+
+/// The `cheatsheets` provider
+pub struct Cheatsheets;
+
+impl HelpProvider for Cheatsheets {
+    fn url(&self) -> &'static str {
+        DEFAULT_CHEATSHEETS_PROVIDER
+    }
+
+    fn build_request(&self, cmd: &str, url: &str) -> Request {
+        AgentBuilder::new().build().get(&format!("{}/{}", url, cmd))
+    }
+}
+
+#[cfg(test)]
+mod tests {
+    use super::*;
+    use crate::error::Result;
+
+    #[test]
+    fn test_fetch_cheatsheets() -> Result<()> {
+        let output = Cheatsheets.fetch("ls", &None)?;
+
+        assert!(output.contains(
+            r##"# To display everything in <dir>, including hidden files:
+ls -a <dir>
+"##
+        ));
+        assert!(output.contains(
+            r##"# To display directories only, include hidden:
+ls -d .*/ */ <dir>
+"##
+        ));
+
+        Ok(())
+    }
+}

src/helper/docs/eg.rs

@@ -0,0 +1,41 @@
+use crate::helper::docs::HelpProvider;
+use ureq::{AgentBuilder, Request};
+
+/// EG page provider URL.
+pub const DEFAULT_EG_PAGES_PROVIDER: &str =
+    "https://raw.githubusercontent.com/srsudar/eg/master/eg/examples";
+
+/// The `eg` pages provider
+pub struct Eg;
+
+impl HelpProvider for Eg {
+    fn url(&self) -> &'static str {
+        DEFAULT_EG_PAGES_PROVIDER
+    }
+
+    fn build_request(&self, cmd: &str, url: &str) -> Request {
+        AgentBuilder::new()
+            .build()
+            .get(&format!("{}/{}.md", url, cmd))
+    }
+}
+
+#[cfg(test)]
+mod tests {
+    use super::*;
+    use crate::error::Result;
+
+    #[test]
+    fn test_eg_page_fetch() -> Result<()> {
+        let output = Eg.fetch("ls", &None)?;
+
+        assert!(output.contains("show contents of current directory"));
+        assert!(output.contains("ls -alh"));
+        assert!(output.contains(
+            r##"`ls` is often aliased to make the defaults a bit more useful. Here are three
+basic aliases. The second two can be remembered by "list long" and "list all":
+"##
+        ));
+        Ok(())
+    }
+}