Skip to content

Use click completion for commands and models for -s #29

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Draft
b-per wants to merge 1 commit into
base: master
Choose a base branch
from
Draft

Use click completion for commands and models for -s #29

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
232 changes: 73 additions & 159 deletions _dbt
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,21 +2,20 @@

# OVERVIEW
# Adds autocompletion to dbt CLI by:
# 1. Finding the root of the repo (identified by dbt_project.yml
# 2. Parsing target/manifest.json file, extracting valid model selectors
# 3. Doing some bash magic to autocomplete selectors for:
# -m
# --model[s]
# -s
# --select
# 1. Using Click's built-in completion for all dbt commands and flags
# 2. Enhancing with manifest.json parsing for intelligent model/selector completions
# 3. Finding the root of the repo (identified by dbt_project.yml)
# 4. Extracting valid model selectors from target/manifest.json for:
# -m / --model[s]
# -s / --select
# --exclude
# --selector
#
# NOTE: This script uses the manifest (assumed to be at target/manifest.json)
# to _quickly_ provide a list of existing selectors. As such, a dbt
# resource must be compiled before it will be available for tab completion.
# In the future, this script should use dbt directly to parse the project
# directory and generate possible selectors. Until then, brand new
# models/sources/tags/packages will not be displayed in the tab complete menu
# Brand new models/sources/tags/packages will not be displayed in the tab
# complete menu until they are compiled and appear in the manifest.
#
#
# CREDITS
Expand Down Expand Up @@ -247,162 +246,77 @@ _dbt_list_selectors() {
}


# Provides sub-commands and arguments for dbt docs
_dbt_docs() {

action=(
"generate"
"serve"
)

_describe -t action 'action' action

_arguments -C -s -S -n \
$profile_args \
'(- 1 *)'{-h,--help}"[show the help message and exit]" \
'(-t --target)'{-t,--target}"[which target to load for the given profile]:()" \
--vars"[supply variables to the project - eg. '{my_variable: my_value}']:()" \
--no-compile"[Do not run \"dbt compile\" as part of docs generation]"
}

# Provides arguments for dbt build
_dbt_build() {

_arguments -C -s -S -n \
$common_test_run_build_args \
$profile_args \
--full-refresh"[perform full-refresh]" \
--resource-type"[type of resources to select]:res:(model snapshot test seed all)" \
'*:: :_dbt_list_models'
}

# Provides arguments for dbt test
_dbt_test() {

_arguments -C -s -S -n \
$common_test_run_build_args \
$profile_args \
'(-m --model)'{-m,--model}"[specify the models to include]:models:_dbt_list_models" \
'*:: :_dbt_list_models'
}

# Provides arguments for dbt run
_dbt_run() {

_arguments -C -s -S -n \
$common_test_run_build_args \
$profile_args \
--full-refresh"[perform full-refresh]" \
'(-m --model)'{-m,--model}"[specify the models to include]:models:_dbt_list_models" \
'*:: :_dbt_list_models'
}

# Provides arguments for dbt ls / list
_dbt_list() {

_arguments -C -s -S -n \
$profile_args \
'(-s --select)'{-s,--select}"[specify the nodes to include]:models:_dbt_list_models" \
'(--exclude)'--exclude"[specify models to exclude]:models:_dbt_list_models" \
--selector"[the selector name to use, as defined in selectors.yml]:selectors:_dbt_list_selectors" \
--resource-type"[type of resources to select]:res:(exposure snapshot metric analysis model source seed test default all)" \
--output"[format of the output]:outp:(json name path selector)" \
--output-keys"[if --output json, this flag controls which node properties are included in the output]:()" \

}


# Main function
# Contains the global actions and flags
# Uses Click-generated completions and enhances with manifest-based model/selector completions
_dbt() {
local ret=1

local -a state commands common_test_run_build_args profile_args

profile_args=(
--profile"[which profile to load]:profile:_files" \
--profiles-dir"[which directory to look in for the profiles.yml file]:profile:_files" \
--project-dir"[which directory to look in for the dbt_project.yml file]:dir:_files" \
)

common_test_run_build_args=(
'(- 1 *)'{-h,--help}"[show the help message and exit]" \
'(-s --select)'{-s,--select}"[specify the nodes to include]:models:_dbt_list_models" \
'(--exclude)'--exclude"[specify models to exclude]:models:_dbt_list_models" \
'(-t --target)'{-t,--target}"[which target to load for the given profile]:()" \
'(-x --fail-fast)'{-x,--fail-fast}"[stop execution upon a first test failure]" \
--vars"[supply variables to the project - eg. '{my_variable: my_value}']:()" \
--threads"[specify number of threads to use while executing models]:()" \
--selector"[the selector name to use, as defined in selectors.yml]:selectors:_dbt_list_selectors" \
--state"[if set, use the given directory as the source for json files to compare with this project.]:state:_files" \
--defer"[If set, defer to the state variable for resolving unselected nodes.]" \
--no-defer"[if set, do not defer to the state variable for resolving unselected nodes.]" \
--store-failures"[store test results (failing rows) in the database]" \
--indirect-selection"[select all tests that are adjacent to selected resources, even if they those resources have been explicitly selected.]:opts:(eager cautious)" \
)
# Only continue if dbt can be found
if ! command -v dbt &> /dev/null; then
return 1
fi

commands=(
"build:run all Seeds, Models, Snapshots, and tests in DAG order"
"run:run SQL transformation"
"test:runs tests on data in deployed model"
"seed:load csv seeds"
"docs:generate and serve docs"
"compile:generates executable sql - written to the target/ directory"
"clean:delete all folders in the clean-targets list"
"debug:show some helpful information about dbt for debugging"
"ls:list the resources in your project"
"snapshot:execute snapshots defined in your project"
"run-operation:run the named macro with any supplied arguments"
"deps:pull the most recent version of the dependencies listed in packages.yml"
"parse:parse the project and provides information on performance"
"source:manage your project's sources"
)
# Check if we should use model/selector completions based on previous word
local prev_word=""
if (( CURRENT > 1 )); then
prev_word="${words[CURRENT-1]}"
fi

_arguments -C -s -S -n \
'(- 1 *)'--version"[Show version information]: :->full" \
'(- 1 *)'{-h,--help}'[show the help message and exit]: :->full' \
'(-d --debug)'{-d,--debug}"[display debug logging during dbt execution]" \
'(--log-format)'--log-format"[specify the log forma]:log format:(text json default)" \
--warn-error'[display usage information]' \
--partial-parse'[allow for partial parsing by looking for and writing to a pickle file in the target directory]' \
--no-version-check"[If set, skip ensuring dbt's version matches the one specified in the dbt_project.ym]" \
'1:cmd:->cmds' \
'*:: :->args' && ret=0

case "$state" in
(cmds)
_describe -t commands 'commands' commands
;;
(args)
local cmd
cmd=$words[1]
case "$cmd" in
(build)
_dbt_build && ret=0
;;
(run)
_dbt_run && ret=0
;;
(test)
_dbt_test && ret=0
;;
(docs)
_dbt_docs && ret=0
;;
(list)
_dbt_list && ret=0
;;
(ls)
_dbt_list && ret=0
;;
(*)
_default && ret=0
;;
esac
;;
(*)
;;
# If we're completing after a model/selector flag, use custom manifest-based completions
case "$prev_word" in
-s|--select|-m|--model|--models|--exclude)
_dbt_list_models
return $?
;;
--selector)
_dbt_list_selectors
return $?
;;
esac

# Otherwise, use Click-generated completions
local IFS=$'\n'
local response

# Call Click completion - note: COMP_CWORD in Click is 0-indexed for the position we're completing
response=$(env COMP_WORDS="${words[*]}" COMP_CWORD=$((CURRENT - 1)) _DBT_COMPLETE=zsh_complete dbt 2>/dev/null)

# If we got a response, process it
# Click's zsh completion returns 3 lines per item: type, value, description
if [[ -n "$response" ]]; then
local lines=("${(@f)response}")
local i=1
local -a completions descriptions

while (( i <= ${#lines[@]} )); do
local comp_type="${lines[i]}"
local comp_value="${lines[i+1]}"
local comp_desc="${lines[i+2]}"

if [[ $comp_type == 'dir' ]]; then
_files -/ && ret=0
elif [[ $comp_type == 'file' ]]; then
_files && ret=0
elif [[ $comp_type == 'plain' ]]; then
if [[ -n "$comp_desc" ]]; then
descriptions+=("$comp_value:$comp_desc")
else
completions+=("$comp_value")
fi
ret=0
fi

i=$((i + 3))
done

# Add all plain completions with descriptions
if (( ${#descriptions[@]} > 0 )); then
_describe 'dbt commands' descriptions
elif (( ${#completions[@]} > 0 )); then
compadd -U -a completions
fi
fi

return ret
}

Expand Down