Merge pull request #184 from nucleogenesis/fish-completions

Add fish completions, update documentation accordingly

Author: naggie

cmd/dstask/main.go

@@ -170,6 +170,9 @@ func main() {
 
 	case dstask.CMD_PRINT_ZSH_COMPLETION:
 		fmt.Printf(completions.Zsh)
+
+	case dstask.CMD_PRINT_FISH_COMPLETION:
+		fmt.Printf(completions.Fish)
 	default:
 		panic("this should never happen?")
 	}

completions/completions.fish

@@ -0,0 +1,6 @@
+#!/usr/bin/env fish
+
+complete -f -c dstask -a (echo (dstask _completions) | string collect)
+#complete -f -c task -a (echo (task _completions) | string collect)
+#complete -f -c t -a (echo (t _completions) | string collect)
+

completions/embed.go

@@ -10,3 +10,7 @@ var Zsh string
 // Bash completion script
 //go:embed bash.sh
 var Bash string
+
+// Fish completion script
+//go:embed completions.fish
+var Fish string

const.go

@@ -63,6 +63,8 @@ const (
 	CMD_PRINT_ZSH_COMPLETION = "zsh-completion"
 	//nolint
 	CMD_PRINT_BASH_COMPLETION = "bash-completion"
+	//nolint
+	CMD_PRINT_FISH_COMPLETION = "fish-completion"
 
 	// filter: P1 P2 etc
 	PRIORITY_CRITICAL = "P0"
@@ -173,6 +175,7 @@ var ALL_CMDS = []string{
 	CMD_SHOW_UNORGANISED,
 	CMD_COMPLETIONS,
 	CMD_PRINT_BASH_COMPLETION,
+	CMD_PRINT_FISH_COMPLETION,
 	CMD_PRINT_ZSH_COMPLETION,
 	CMD_HELP,
 	CMD_VERSION,

help.go

@@ -211,13 +211,15 @@ this command.
 Show a breakdown of projects with progress information
 `
 
-	case CMD_PRINT_BASH_COMPLETION, CMD_PRINT_ZSH_COMPLETION:
-		helpStr = `Usage: dstask [bash|zsh]-completion
+	case CMD_PRINT_BASH_COMPLETION, CMD_PRINT_ZSH_COMPLETION, CMD_PRINT_FISH_COMPLETION:
+		helpStr = `Usage: dstask [bash|zsh|fish]-completion
 
 Print a shell completion script to stdout. The script can be sourced from
-a user's .bashrc or .zshrc like so:
+a user's .bashrc, .zshrc, or fish.config like so:
 
     source <(dstask bash-completion)
+    source <(dstask zsh-completion)
+    dtask fish-completion | source
 `
 	default:
 		helpStr = `Usage: dstask [id...] <cmd> [task summary/filter]
@@ -263,6 +265,7 @@ show-resolved     : Show resolved tasks
 show-templates    : Show task templates
 show-unorganised  : Show untagged tasks with no projects (global context)
 bash-completion   : Print bash completion script to stdout
+fish-completion   : Print fish completion script to stdout
 zsh-completion    : Print zsh completion script to stdout
 help              : Get help on any command or show this message
 version           : Show dstask version information