no autocomplete for <PATH> on CLI commands

[ghostsquad]

I cannot autocomplete paths on commands such as tk diff <PATH>

[issue-label-bot]

Issue-Label Bot is automatically applying the label kind/bug to this issue, with a confidence of 0.70. Please mark this comment with 👍 or 👎 to give our bot feedback!

Links: app homepage, dashboard and code for this bot.

[malcolmholmes]

@ghostsquad how are you configuring autocomplete?

[ghostsquad]

I'm using ZSH. For reference, the problem appears to be if I've nested my environments, and if I'm running tk from a more top-level directory:

example of the location of the spec.json:

./deploy/kubernetes/environments/development/spec.json

if I try to run tk diff from ./ (being the root of my repo) it doesn't try to autocomplete the environments or let me specify the path to the environment.

However, if my PWD is ./deploy/kubernetes/environments then it does autocomplete development

[Duologic]

I have been annoyed by that too, if I'm one directory above the Tanka root, then the directory autocomplete just doesn't respond while technically it will just work.

[sh0rez]

Let me give some technical background on this.

Tanka implements its own bash completion handler in Go, which allows us to use arbitrarily complex computation to generate those results. ZSH and Fish use Bash compat mode and should just work as well. The tk completion command enables the feature for all locally installed shells.

Bespoke directory completion does not actually suggest directories, but instead it uses the code that powers tk env list to find environments, starting from the current directory. This code however requires a jsonnetfile.json in the current or enclosing folders.

When being just one level outside of the this is no longer satisfied and our code returns an empty list, which effectively means no completion.

I see two ways forward here:

1. We could use the last full directory of the already supplied argument to run the search on, instead of pwd (in findBaseDirs):
   

   tanka/cmd/tk/args.go

   Lines 8 to 16 in fdf0ca1

   	var workflowArgs = cli.Args{
   	Validator: cli.ValidateExact(1),
   	Predictor: cli.PredictFunc(func(complete.Args) []string {
   	if dirs := findBaseDirs(); len(dirs) != 0 {
   	return dirs
   	}
   	return []string{""}
   	}),
   	}

2. We could fallback to the regular directory completion in case environment completion is not possible.

No. 2 is certainly simpler and straightforward to implement.

[ghostsquad]

3. since spec.json and main.jsonnet are required files (for now, see how to use a kube config context instead of ApiServer URL? #351) - you could crawl the directory structure (say up to 10 directories deep), looking for folders that contain those 2 files?

[Duologic]

I'd be all for 2., my general expectation is that I can tab complete from current working dir to wherever the environment exists.

[ghostsquad]

You da best!