Fix #1404, and more...

shell-completion/.gitignore

@@ -1 +1,3 @@
-*.txt
+options*.txt
+generic-options.txt
+commands*.txt

shell-completion/BSDmakefile

@@ -0,0 +1,4 @@
+.DONE:
+	@echo "GNU Make (gmake) required to build"
+.DEFAULT:
+	@echo "GNU Make (gmake) required to build"

shell-completion/Makefile

@@ -1,30 +1,87 @@
+# Setting the number of job runners like this in the makefile only works in
+# GNU Make 4.3 or later. Older versions will require that either an env
+# variable be set before running or command line flag be passed at runtime to
+# get parallel jobs.
+MAKEFLAGS += --jobs=$(shell nproc 2>/dev/null || printf 8)
 
-.PHONY: command-options clean
+EUID := $(shell id -u)
 
-all: command-options hledger-completion.bash
+ifeq ($(EUID),0)
+PREFIX := /usr/local
+endif
 
-hledger-completion.bash: hledger-completion.bash.m4 commands-list.txt query-filters.txt generic-options.txt
-	m4 hledger-completion.bash.m4 > $@
+ifdef PREFIX
+BASHCOMPDIR := $(PREFIX)/share/bash-completion/completions
+else
+XDG_DATA_HOME ?= $(HOME)/.local/share
+BASH_COMPLETION_USER_DIR ?= $(XDG_DATA_HOME)/bash-completion
+BASHCOMPDIR := $(BASH_COMPLETION_USER_DIR)/completions
+endif
 
-generic-options.txt:
-	hledger -h | ./output-options.sh | sort -u > $@
+DESTDIR ?=
+
+PARSE_COMMANDS := ./parse-commands.sh
+PARSE_OPTIONS := ./parse-options.sh
+
+EXTENSIONS := ui web
+INSTALLED_EXTENSIONS := $(foreach EXT,$(EXTENSIONS),$(shell type hledger-$(EXT) >/dev/null 2>&1 && echo $(EXT)))
+
+COMMANDS := $(sort $(shell $(PARSE_COMMANDS)) $(INSTALLED_EXTENSIONS))
+
+ifneq ($(.SHELLSTATUS),0)
+$(error Error running $(PARSE_COMMANDS))
+endif
+
+CMDOPTFILES := $(foreach CMD,$(COMMANDS),options-$(CMD).txt)
+
+define M4DEPS :=
+hledger-completion.bash.m4 \
+hledger-completion.bash.stub \
+commands.txt \
+commands-list.txt \
+query-filters.txt \
+generic-options.txt \
+$(CMDOPTFILES)
+endef
+
+
+all: hledger-completion.bash
+
+.PHONY: install
+install:
+	@install -v -d "$(DESTDIR)$(BASHCOMPDIR)"
+	@install -v -m 0644 hledger-completion.bash "$(DESTDIR)$(BASHCOMPDIR)/hledger"
+	@for ext in $(EXTENSIONS); do \
+		printf "symlink " ; \
+		ln -sfv hledger "$(DESTDIR)$(BASHCOMPDIR)/hledger-$$ext" ; \
+	done
+
+.PHONY: uninstall
+uninstall:
+	@rm -vf "$(DESTDIR)$(BASHCOMPDIR)/hledger"
+	@for ext in $(EXTENSIONS); do \
+		rm -vf "$(DESTDIR)$(BASHCOMPDIR)/hledger-$$ext" ; \
+	done
+
+hledger-completion.bash: $(M4DEPS)
+	m4 -g hledger-completion.bash.m4 > $@
 
 commands.txt:
-	hledger | ./output-commands.sh | grep -v ^hledger > $@
-	echo ui  >> $@
-	echo web >> $@
-	echo api >> $@
+	printf "%s\n" $(COMMANDS) > $@
 
-commands-list.txt: commands.txt
-	paste -sd, $^ | tr -d '\n' > $@
+commands-list.txt:
+	printf "%s,"  $(COMMANDS) | sed 's/,$$//' > $@
 
-#query-filters.txt:
-	# The query filters are hard to extract!
-	# hledger help --cat hledger | sed -n '/^QUERIES/,/^[A-Z]/p'
+generic-options.txt:
+	$(PARSE_OPTIONS) > $@
 
-command-options: commands.txt
-	parallel -j8 'hledger {} -h | ./output-options.sh | sort -u > options-{}.txt' < commands.txt
+options-%.txt:
+	$(PARSE_OPTIONS) $* > $@
 
+.PHONY: clean
 clean:
 	rm -f commands*.txt generic-options.txt options-*.txt
+
+.PHONY: clean-all
+clean-all: clean
 	rm -f hledger-completion.bash

shell-completion/README.md

@@ -15,8 +15,8 @@ The completions can handle hledger's CLI:
 
 - commands and generic options
 - command-specific options
-- filenames for options that take a filename as argument
-- account names from journal files (but not yet for files named by `--file`)
+- most option arguments
+- account names, tags, payees, etc. from journal files
 - query filter keywords like `status:`, `tag:`, or `amt:`
 
 Installation for end users
@@ -27,22 +27,45 @@ Completions are currently only implemented for the Bash shell.
 Please check first if the completions for hledger are already installed on your
 distribution. Refer to the last paragraph of this section for how to test that.
 
-To install the completions manually, follow this steps:
+To install from the repository, do:
 
-- Download or copy the file `shell-completion/hledger-completion.bash` and save
-  it as `~/.hledger-completion.bash`.
+```sh
+cd /path-to-repo/shell-completion
+make install
+```
 
-- Add the command `source ~/.hledger-completion.bash` this to the end of your
-  `~/.bashrc` file.
+Completions installed this way will be loaded dynamically after you use the hledger
+command. Upon the first invocation of a command that has no predefined completion
+bash looks for a file with the same name in a set of predefined locations in this order:
 
-- Then, you have to start a new Bash, e.g. by typing `bash` on the current
-  shell.
+- `$BASH_COMPLETION_USER_DIR/completions`
+- `$XDG_DATA_HOME/bash-completion/completions`
+- `$HOME/.local/share/bash-completion/completions`
+- etc.
 
-Example installation script:
+You can manually achieve the effects of `make install` by copying
+`shell-completion/hledger-completion.bash` to one of the above, and renaming it
+to `hledger`, `_hledger` or `hledger.bash`. For the gory details, type this in a
+bash shell:
 
+```sh
+type __load_completion
 ```
-cp hledger-completion.bash ~/.hledger-completion.bash
-echo 'source ~/.hledger-completion.bash' >> ~/.bashrc
+
+To install the completions manually, you can also just download and copy
+`shell-completion/hledger-completion.bash` to a directory of your choosing, and
+source it from your shell start up files. This way completions are loaded
+eagerly and that adds a delay to shell start up time.
+
+Example:
+
+```sh
+cp hledger-completion.bash ~/.bash_completion.d/hledger
+echo 'source ~/.bash_completion.d/hledger' >> ~/.bashrc
+# Restart shell
+exec bash
+# Confirm that completion is loaded
+complete -p hledger
 ```
 
 Now, try it by typing `hledger` (with a space after the command) and press the
@@ -63,21 +86,23 @@ Information for developers
 
 Generate the completion script for Bash:
 
-```
+```sh
 # change into this folder:
 cd shell-completion/
 make
 ```
 
-Hint: GNU make, GNU m4, and GNU parallel must be installed to call `make`.
-The first two usually are.
+Hint: GNU make and  GNU m4 must be installed to call `make`.
+These are present on most systems anyway.
+Additionally the build will run a lot faster with parallell jobs.
+Use `make -j$(nproc)` for best effect.
 
 The generated completion script must be installed. The package maintainer for
 your distribution should be responsible for this.
 
 For now, or to live-test the script, you can use these two commands:
 
-```
+```sh
 ln -s hledger-completion.bash ~/.hledger-completion.bash
 echo 'source ~/.hledger-completion.bash' >> ~/.bashrc
 ```