From 2ed64b0ea1f7e438627344805877762b8b67526b Mon Sep 17 00:00:00 2001 From: Natalie Pendragon Date: Mon, 10 Dec 2018 08:46:36 -0500 Subject: [PATCH 1/3] Add support for Fish-based autocompletion --- README.md | 8 +++++++- fish_tealdeer | 21 +++++++++++++++++++++ 2 files changed, 28 insertions(+), 1 deletion(-) create mode 100644 fish_tealdeer diff --git a/README.md b/README.md index 2eee71045..1c2535c17 100644 --- a/README.md +++ b/README.md @@ -178,11 +178,17 @@ Example customization: Screenshot of customized version -## Bash Autocompletion +## Autocompletion + +### Bash To get bash autocompletion, simply rename the file `bash_tealdeer` to `tldr` and copy it to `/usr/share/bash-completion/completions/tldr`. +### Fish + +To get fish autocompletion, simply rename the file `fish_tealdeer` to `tldr.fish` +and copy it to `~/.config/fish/completions/tldr.fish`. ## Development diff --git a/fish_tealdeer b/fish_tealdeer new file mode 100644 index 000000000..d1a0c9a48 --- /dev/null +++ b/fish_tealdeer @@ -0,0 +1,21 @@ +# +# Completions for the tealdeer implementation of tldr +# https://github.com/dbrgn/tealdeer/ +# + +complete -c tldr -s h -l help -d 'Print the help message.' -f +complete -c tldr -s v -l version -d 'Show version information.' -f +complete -c tldr -s l -l list -d 'List all commands in the cache.' -f +complete -c tldr -s f -l render -d 'Render a specific markdown file.' -r +complete -c tldr -s o -l os -d 'Override the operating system.' -xa 'linux osx sunos other' +complete -c tldr -s u -l update -d 'Update the local cache.' -f +complete -c tldr -s c -l clear-cache -d 'Clear the local cache.' -f +complete -c tldr -s q -l quiet -d 'Suppress informational messages.' -f +complete -c tldr -l config-path -d 'Show config file path.' -f +complete -c tldr -l seed-config -d 'Create a basic config.' -f + +function __tealdeer_entries + tldr --list | sed -e 's/, /\n/g' +end + +complete -f -c tldr -a '(__tealdeer_entries)' \ No newline at end of file From 79c1dc6db79b6e53d3c8426d01f43bb7707fc14b Mon Sep 17 00:00:00 2001 From: Natalie Pendragon Date: Mon, 10 Dec 2018 08:53:55 -0500 Subject: [PATCH 2/3] Add trailing newline --- fish_tealdeer | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/fish_tealdeer b/fish_tealdeer index d1a0c9a48..9276e9a68 100644 --- a/fish_tealdeer +++ b/fish_tealdeer @@ -18,4 +18,4 @@ function __tealdeer_entries tldr --list | sed -e 's/, /\n/g' end -complete -f -c tldr -a '(__tealdeer_entries)' \ No newline at end of file +complete -f -c tldr -a '(__tealdeer_entries)' From 2e7eb3ee31374929a25cf66da2ecb067e43ce748 Mon Sep 17 00:00:00 2001 From: Natalie Pendragon Date: Mon, 10 Dec 2018 19:01:21 -0500 Subject: [PATCH 3/3] Tersify autocompletion docs --- README.md | 11 ++--------- 1 file changed, 2 insertions(+), 9 deletions(-) diff --git a/README.md b/README.md index 1c2535c17..6c4fa1377 100644 --- a/README.md +++ b/README.md @@ -180,15 +180,8 @@ Example customization: ## Autocompletion -### Bash - -To get bash autocompletion, simply rename the file `bash_tealdeer` to `tldr` -and copy it to `/usr/share/bash-completion/completions/tldr`. - -### Fish - -To get fish autocompletion, simply rename the file `fish_tealdeer` to `tldr.fish` -and copy it to `~/.config/fish/completions/tldr.fish`. +- *Bash*: copy `bash_tealdeer` to `/usr/share/bash-completion/completions/tldr` +- *Fish*: copy `fish_tealdeer` to `~/.config/fish/completions/tldr.fish` ## Development