fix: resolves #301

Fixes an issue whereby `cheat` would crash when `$EDITOR` (or
equivalent) contained arguments.

Makefile

@@ -21,6 +21,7 @@ ZIP    := zip -m
 # build flags
 BUILD_FLAGS  := -ldflags="-s -w" -mod vendor -trimpath
 GOBIN        :=
+TMPDIR       := /tmp
 
 # release binaries
 releases :=                        \
@@ -137,6 +138,12 @@ vet:
 test: 
 	$(GO) test ./...
 
+## coverage: generates a test coverage report
+.PHONY: coverage
+coverage:
+	$(GO) test ./... -coverprofile=$(TMPDIR)/cheat-coverage.out && \
+	$(GO) tool cover -html=$(TMPDIR)/cheat-coverage.out
+
 ## check: formats, lints, vets, vendors, and run unit-tests
 .PHONY: check
 check: | vendor fmt lint vet test

README.md

@@ -193,9 +193,17 @@ cheat -p personal -t networking --regex -s '(?:[0-9]{1,3}\.){3}[0-9]{1,3}'
 
 Advanced Usage
 --------------
-`cheat` may be integrated with [fzf][]. See [fzf.bash][bash] for instructions.
-(Support for other shells will be added in future releases.)
+Shell autocompletion is currently available for the `bash` and `fish` shells.
+Copy the relevant [completion script][completion-scripts] into the appropriate
+directory on your filesystem to enable autocompletion. (This directory will
+vary depending on operating system and shell specifics.)
 
+Additionally, `cheat` supports enhanced autocompletion via integration with
+[fzf][]. (This feature is currently available on bash only.) To enable `fzf`
+integration:
+
+1. Ensure that `fzf` is available on your `$PATH`
+2. Set an envvar: `export CHEAT_USE_FZF=true`
 
 [Releases]:    https://github.com/cheat/cheat/releases
 [bash]:        https://github.com/cheat/cheat/blob/master/scripts/fzf.bash

bin/build_devel.sh

@@ -1,15 +0,0 @@
-#!/bin/bash
-
-# TODO: this script has been made obsolete by the Makefile, yet downstream
-# package managers plausibly rely on it for compiling locally. Remove this file
-# after downstream maintainers have had time to modify their packages to simply
-# invoke `make` in the project root.
-
-# locate the cheat project root
-BINDIR="$( cd "$( dirname "${BASH_SOURCE[0]}" )" && pwd )"
-APPDIR=$(readlink -f "$BINDIR/..")
-
-# compile the executable
-cd $APPDIR
-
-make

cmd/cheat/cmd_edit.go

@@ -99,8 +99,15 @@ func cmdEdit(opts map[string]interface{}, conf config.Config) {
 		}
 	}
 
+	// split `conf.Editor` into parts to separate the editor's executable from
+	// any arguments it may have been passed. If this is not done, the nearby
+	// call to `exec.Command` will fail.
+	parts := strings.Fields(conf.Editor)
+	editor := parts[0]
+	args := append(parts[1:], editpath)
+
 	// edit the cheatsheet
-	cmd := exec.Command(conf.Editor, editpath)
+	cmd := exec.Command(editor, args...)
 	cmd.Stdout = os.Stdout
 	cmd.Stdin = os.Stdin
 	cmd.Stderr = os.Stderr

cmd/cheat/main.go

@@ -14,7 +14,7 @@ import (
 	"github.com/cheat/cheat/internal/config"
 )
 
-const version = "3.4.1"
+const version = "3.5.1"
 
 func main() {
 

scripts/cheat-autocompletion.bash

@@ -1,9 +0,0 @@
-function _cheat_autocomplete {
-    sheets=$(cheat -l | sed -n '2,$p'|cut -d' ' -f1)
-    COMPREPLY=()
-    if [ $COMP_CWORD = 1 ]; then
-	COMPREPLY=(`compgen -W "$sheets" -- $2`)
-    fi
-}
-
-complete -F _cheat_autocomplete cheat

scripts/cheat.bash

@@ -0,0 +1,74 @@
+# cheat(1) completion                                      -*- shell-script -*-
+
+# generate cheatsheet completions, optionally using `fzf`
+_cheat_complete_cheatsheets()
+{
+  if [[ "$CHEAT_USE_FZF" = true ]]; then
+    FZF_COMPLETION_TRIGGER='' _fzf_complete "--no-multi" "$@" < <(
+      cheat -l | tail -n +2 | cut -d' ' -f1
+    )
+  else
+    COMPREPLY=( $(compgen -W "$(cheat -l | tail -n +2 | cut -d' ' -f1)" -- "$cur") )
+  fi
+}
+
+# generate tag completions, optionally using `fzf`
+_cheat_complete_tags()
+{
+  if [ "$CHEAT_USE_FZF" = true ]; then
+    FZF_COMPLETION_TRIGGER='' _fzf_complete "--no-multi" "$@" < <(cheat -T)
+  else
+    COMPREPLY=( $(compgen -W "$(cheat -T)" -- "$cur") )
+  fi
+}
+
+# implement the `cheat` autocompletions
+_cheat()
+{
+  local cur prev words cword split
+  _init_completion -s || return
+
+  # complete options that are currently being typed: `--col` => `--colorize`
+  if [[ $cur == -* ]]; then
+    COMPREPLY=( $(compgen -W '$(_parse_help "$1" | sed "s/=//g")' -- "$cur") )
+    [[ $COMPREPLY == *= ]] && compopt -o nospace
+    return
+  fi
+
+  # implement completions
+  case $prev in
+    --colorize|-c|\
+    --directories|-d|\
+    --init|\
+    --regex|-r|\
+    --search|-s|\
+    --tags|-T|\
+    --version|-v)
+      # noop the above, which should implement no completions
+      ;;
+    --edit|-e)
+      _cheat_complete_cheatsheets
+      ;;
+    --list|-l)
+      _cheat_complete_cheatsheets
+      ;;
+    --path|-p)
+      COMPREPLY=( $(compgen -W "$(cheat -d | cut -d':' -f1)" -- "$cur") )  
+      ;;
+    --rm)
+      _cheat_complete_cheatsheets
+      ;;
+    --tag|-t)
+      _cheat_complete_tags
+      ;;
+    *)
+      _cheat_complete_cheatsheets
+      ;;
+  esac
+
+  $split && return
+
+} &&
+complete -F _cheat cheat
+
+# ex: filetype=sh

scripts/fzf.bash

@@ -1,11 +0,0 @@
-#!/bin/bash
-
-# This function enables you to choose a cheatsheet to view by selecting output
-# from `cheat -l`. `source` it in your shell to enable it. (Consider renaming
-# or aliasing it to something convenient.)
-
-# Arguments passed to this function (like --color) will be passed to the second
-# invokation of `cheat`.
-function cheat-fzf {
-  eval `cheat -l | tail -n +2 | fzf | awk -v vars="$*" '{ print "cheat " $1 " -t " $3, vars }'`
-}