Mirrors/navi
2
0
Fork 0
mirror of https://github.com/denisidoro/navi synced 2024-11-21 11:03:08 +00:00
Code Issues Projects Releases Packages Wiki Activity

chore(tldr): Make it more obvious that tealdeer is the recommended client

Browse source 
https://github.com/tldr-pages/tldr mentions tlrc as the official
rust client, but navi supports tealdeer instead since
c3d75383f8, so stop mentioning
that link and instead point the user directly to tealdeer.

Fix: https://github.com/denisidoro/navi/issues/902
This commit is contained in:
asemmar 2024-09-28 02:12:11 +02:00
parent e0943c39cf
commit c59af6548e
1 changed files with 3 additions and 4 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

7
src/clients/tldr.rs
View file

@ -7,8 +7,8 @@ lazy_static! {
pub static ref NON_VAR_CHARS_REGEX: Regex = Regex::new(r"[^\da-zA-Z_]").expect("Invalid regex"); 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. static VERSION_DISCLAIMER: &str = "tldr-c-client (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."; The recommended client is tealdeer(https://github.com/dbrgn/tealdeer).";
fn convert_tldr_vars(line: &str) -> String { fn convert_tldr_vars(line: &str) -> String {
let caps = VAR_TLDR_REGEX.find_iter(line); let caps = VAR_TLDR_REGEX.find_iter(line);
@ -69,7 +69,6 @@ pub fn call(query: &str) -> Result<Vec<String>> {
let msg = format!( let msg = format!(
"navi was unable to call tldr. "navi was unable to call tldr.
Make sure tldr is correctly installed. Make sure tldr is correctly installed.
Refer to https://github.com/tldr-pages/tldr for more info.
Note: Note:
{VERSION_DISCLAIMER} {VERSION_DISCLAIMER}
@ -100,7 +99,7 @@ Error:
Note: Note:
The client.tealdeer config option can be set to enable tealdeer support. 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. If you are already using a supported version you can ignore this message.
{} {}
", ",