Feat/add chatsheets provider

src/cli.rs

@@ -54,6 +54,9 @@ pub enum CliCommands {
         /// 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>,
@@ -123,6 +126,7 @@ 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

@@ -2,6 +2,7 @@ use crate::error::Result;
 use crate::helper::args::common::{HelpArg, VersionArg};
 use crate::helper::args::FOUND_EMOTICON;
 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};
@@ -28,6 +29,8 @@ pub struct Config {
     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 {
@@ -49,6 +52,7 @@ impl Default for Config {
             pager_command: Some("less -R".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()),
         }
     }
 }

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/mod.rs

@@ -3,12 +3,15 @@ pub mod man;
 
 /// Cheat sheet helper.
 pub mod cheat_sh;
+/// cheat helper.
+pub mod cheatsheets;
 /// eg page helper.
 pub mod eg;
 
 use crate::config::Config;
 use crate::error::{Error, Result};
 use crate::helper::docs::cheat_sh::CheatDotSh;
+use crate::helper::docs::cheatsheets::Cheatsheets;
 use crate::helper::docs::eg::Eg;
 use crate::helper::docs::man::show_man_page;
 use console::{style, Style, Term};
@@ -111,11 +114,13 @@ pub fn get_docs_help<Output: Write>(cmd: &str, config: &Config, output: &mut Out
     const MAN_PAGE: usize = 0;
     const CHEAT_SHEET: usize = 1;
     const EG_PAGE: usize = 2;
+    const CHEATSHEETS: usize = 3;
 
     let menu_options = [
         "Show man page",
-        "Show cheat sheet",
+        "Show cheat.sh page",
         "Show the eg page",
+        "Show the cheatsheet page",
         "Exit",
     ];
     let mut selection = Some(MAN_PAGE);
@@ -133,6 +138,7 @@ pub fn get_docs_help<Output: Write>(cmd: &str, config: &Config, output: &mut Out
             let page = match selection {
                 Some(CHEAT_SHEET) => CheatDotSh.fetch(cmd, &config.cheat_sh_url)?,
                 Some(EG_PAGE) => Eg.fetch(cmd, &config.eg_url)?,
+                Some(CHEATSHEETS) => Cheatsheets.fetch(cmd, &config.cheatsheets_url)?,
                 _ => return Ok(()),
             };