dbt-labs / dbt-completion.bash Goto Github PK

Hi!

I just came across the bash completion script, and while I am using zsh myself, the current script worked to auto-complete the models, with 2 caveats:

1. I had to update it to make it work with folders including spaces
2. Prefixing with '+' and '@' didn't work and was throwing errors

So, after spending a bit of time understanding zsh completion mechanism I have created the following script:
Gist link

--

Installation

• If you are using Oh My Zsh, just save the _dbt file in ~/.oh-my-zsh/completions (create the folder if it doesn't exist)
• The script has been tested on macOS and with zsh version 5.8

Pros:

• Completion for models works with strings in the middle of the model names (e.g. typing invoice will match models customer_invoice and vendor_invoice
• Completion has been set up for some flags and commands (listing most of the flags available when running dbt run, dbt test and dbt docs as well as the global flags)
• Support for '+' and '@' has been replicated from the bash completion script

Cons:

• Currently, when running dbt run or dbt test the models will be suggested even though there is no model selection flag defined or if the model selection flag is not the last one in the list

--

Happy to submit a PR and share the script on this repo if people want to use it and improve it.

via dbt-labs/dbt-core#2258

I have a bunch of models with prefixes stg_ or int_
I would like to be able to tab complete the prefix from just the name after the prefix.
i.e.
If I have 3 models: stg_model_a_v1, stg_model_a_v2 and stg_model_a_v3
I would like this to happen:

$ dbt run -s model_a<TAB>

to become:

$ dbt run -s stg_model_a_v
stg_model_a_v1   stg_model_a_v2   stg_model_a_v3

I know this is possible since this is the default functionality for autocompletion for e.g. ls

I am very new to zsh so contributing myself seems like a long shot.

Hi,

dbt completion doesn't seem to work with the new Warp terminal. This might have to do with the fact that Warp doesn't use <tab> for auto-completion but the right arrow key instead.

dbt completion works with iTerm on Mac. (It's sourced as part of my ~/.bash_profile and so on.) However, nothing happens when I'm trying to use <tab> or the right arrow key to auto-complete a dbt node name.

Curious if this is a known issue or if I didn't configure this correctly.

When I type dbt run antigen suggests arguments and values to populate, but tab does not list all of the options.

After installing this completion script, I realized that it doesn't complete subcommands, e.g. I expect dbt d<TAB> to offer debug deps docs, or, dbt run --s<TAB> to offer --select --selector --state as completions.

Digging around, I learned that the dbt CLI is built using Click and that it supports shell completion.

It would be nice to merge that generated script with this one to get the best of both worlds!