From c59af6548e434d87805eaf6b6768fd39a9de4471 Mon Sep 17 00:00:00 2001 From: asemmar Date: Sat, 28 Sep 2024 02:12:11 +0200 Subject: [PATCH] chore(tldr): Make it more obvious that tealdeer is the recommended client https://github.com/tldr-pages/tldr mentions tlrc as the official rust client, but navi supports tealdeer instead since c3d75383f89a568b0ee0dc6f807f18f1c8bb9311, so stop mentioning that link and instead point the user directly to tealdeer. Fix: https://github.com/denisidoro/navi/issues/902 --- src/clients/tldr.rs | 7 +++---- 1 file changed, 3 insertions(+), 4 deletions(-) diff --git a/src/clients/tldr.rs b/src/clients/tldr.rs index 79c56bf..160ab36 100644 --- a/src/clients/tldr.rs +++ b/src/clients/tldr.rs @@ -7,8 +7,8 @@ lazy_static! { pub static ref NON_VAR_CHARS_REGEX: Regex = Regex::new(r"[^\da-zA-Z_]").expect("Invalid regex"); } -static VERSION_DISCLAIMER: &str = "The tldr client written in C (the default one in Homebrew) doesn't support markdown files, so navi can't use it. -The client written in Rust is recommended. The one available in npm works, too."; +static VERSION_DISCLAIMER: &str = "tldr-c-client (the default one in Homebrew) doesn't support markdown files, so navi can't use it. +The recommended client is tealdeer(https://github.com/dbrgn/tealdeer)."; fn convert_tldr_vars(line: &str) -> String { let caps = VAR_TLDR_REGEX.find_iter(line); @@ -69,7 +69,6 @@ pub fn call(query: &str) -> Result> { let msg = format!( "navi was unable to call tldr. Make sure tldr is correctly installed. -Refer to https://github.com/tldr-pages/tldr for more info. Note: {VERSION_DISCLAIMER} @@ -100,7 +99,7 @@ Error: Note: The client.tealdeer config option can be set to enable tealdeer support. -Please make sure you're using a version that supports the --markdown flag. +If you want to use another client, please make sure it supports the --markdown flag. If you are already using a supported version you can ignore this message. {} ",