Merge remote-tracking branch 'github/master'HEADmaster

2 files changed, 37 insertions, 0 deletions

diff --git a/plugins/tldr/README.md b/plugins/tldr/README.md
new file mode 100644
index 000000000..03b1dfc73
--- /dev/null
+++ b/plugins/tldr/README.md
@@ -0,0 +1,18 @@
+# tldr plugin
+
+This plugin adds a shortcut to insert tldr before the previous command.
+Heavily inspired from [Man plugin](https://github.com/ohmyzsh/ohmyzsh/tree/master/plugins/man).
+
+To use it, add `tldr` to the plugins array in your zshrc file:
+
+```zsh
+plugins=(... tldr)
+```
+
+# Keyboard Shortcuts
+| Shortcut                           | Description                                                                |
+|------------------------------------|----------------------------------------------------------------------------|
+| <kbd>Esc</kbd> + tldr              | add tldr before the previous command to see the tldr page for this command |
+
+## Note
+You also need to install ```tldr```.
diff --git a/plugins/tldr/tldr.plugin.zsh b/plugins/tldr/tldr.plugin.zsh
new file mode 100644
index 000000000..9f3de5f0c
--- /dev/null
+++ b/plugins/tldr/tldr.plugin.zsh
@@ -0,0 +1,19 @@
+tldr-command-line() {
+    # if there is no command typed, use the last command
+    [[ -z "$BUFFER" ]] && zle up-history
+
+    # if typed command begins with tldr, do nothing
+    [[ "$BUFFER" = tldr\ * ]] && return
+
+    # get command and possible subcommand
+    # http://zsh.sourceforge.net/Doc/Release/Expansion.html#Parameter-Expansion-Flags
+    local -a args
+    args=(${${(Az)BUFFER}[1]} ${${(Az)BUFFER}[2]})
+
+    BUFFER="tldr ${args[1]}"
+}
+
+zle -N tldr-command-line
+# Defined shortcut keys: [Esc]tldr
+bindkey "\e"tldr tldr-command-line
+