Skip to content

Add dbt keybindings, audit scripts, and neovim integration#76

Closed
michaelbarton wants to merge 21 commits intomasterfrom
claude/review-dbt-audit-script-vxq2a
Closed

Add dbt keybindings, audit scripts, and neovim integration#76
michaelbarton wants to merge 21 commits intomasterfrom
claude/review-dbt-audit-script-vxq2a

Conversation

@michaelbarton
Copy link
Owner

Summary

  • Add comprehensive dbt keybindings in neovim (<leader>d prefix) for running, building, testing, compiling, and previewing dbt models
  • Add Python audit scripts (dbt_analyse.py, dbt_batch_audit.py) for AI-assisted dbt model analysis with lineage and test coverage
  • Add prompt templates for quick and deep dbt model analysis
  • Update ansible to symlink the new dbt config directory

Test plan

  • Run ansible playbook to verify symlinks are created correctly
  • Open a dbt model in neovim and test keybindings
  • Run dbt_analyse.py on a sample model

https://claude.ai/code/session_01RHSUYqsWy6xLfAC9tFTy66

claude and others added 21 commits March 5, 2026 05:46
Add <leader>dr (dbt run), <leader>dc (dbt compile), and <leader>dt
(dbt test) keybindings that format the current SQL file with sqlfmt
via conform, save, then send the dbt command to toggleterm. Also add
sql to treesitter ensure_installed for better SQL highlighting.

https://claude.ai/code/session_016johXLfEd6P4umaT14YQEQ
- <leader>dR: dbt run -s model+ (model and all downstream dependents)
- <leader>db: dbt build (run + test in DAG order)
- <leader>ds: dbt show (preview query results without materializing)

https://claude.ai/code/session_016johXLfEd6P4umaT14YQEQ
- <leader>dg: jump to ref() or source() under cursor
- <leader>df: fzf model picker with ctrl-r/b/t to run/build/test
- <leader>do: open compiled SQL in readonly vsplit
- <leader>d/: grep across all models (find columns, CTEs, etc.)

Inspired by fzf-dbt CLI tool, adapted for neovim with fzf-lua.

https://claude.ai/code/session_016johXLfEd6P4umaT14YQEQ
<leader>da: quick analysis with sonnet — reviews the current model
and suggests improvements in non-interactive mode.

<leader>dA: deep analysis with sonnet thinking — interrogates the
duckdb database and cross-references with the current model to check
data quality, joins, types, and more.

https://claude.ai/code/session_016johXLfEd6P4umaT14YQEQ
The <leader>dA keymap now compiles the model first, then passes
the compiled SQL and first 20 rows from dbt show as extra context
to the claude agent for more informed analysis.

https://claude.ai/code/session_016johXLfEd6P4umaT14YQEQ
Prompts now live in nvim/prompts/ as markdown files with {{var}}
template placeholders. The quick analysis prompt is loaded and
substituted in Lua; the deep analysis prompt uses sed at runtime
to inject compiled SQL and sample rows before passing to claude.

https://claude.ai/code/session_016johXLfEd6P4umaT14YQEQ
- <leader>da now replaces the buffer with the annotated SQL (undo with :u)
- Updated prompt to allow brief explanations alongside suggestions
- All dbt commands (run, build, test, compile, show) now use uv run

https://claude.ai/code/session_016johXLfEd6P4umaT14YQEQ
<leader>dA now opens a new tmux window named 'dbt:<model>' that
compiles the model, gathers sample rows, then starts an interactive
claude session with that context so you can discuss the model.

https://claude.ai/code/session_016johXLfEd6P4umaT14YQEQ
Runs dbt show --limit 20 asynchronously and displays the results
in a read-only scratch buffer. Press q to close.

https://claude.ai/code/session_016johXLfEd6P4umaT14YQEQ
fzf-lua is not installed; the config uses telescope via LazyVim.
Converts wiki search, wiki insert link, dbt model finder (with
C-r/C-b/C-t actions), and dbt grep to telescope equivalents.

https://claude.ai/code/session_016johXLfEd6P4umaT14YQEQ
Pipes `dbt show --output csv --limit 500` into visidata via
toggleterm. Formats and saves the file first like other dbt commands.

https://claude.ai/code/session_016johXLfEd6P4umaT14YQEQ
Uses a dedicated toggleterm Terminal with close_on_exit and an
on_exit callback instead of the shared terminal, so focus returns
to the previous window when visidata is quit.

https://claude.ai/code/session_016johXLfEd6P4umaT14YQEQ
dbt show only supports --output json/text, not csv. Use
--output json --log-format json and pipe through a python
script that extracts the preview data and converts to CSV.

https://claude.ai/code/session_016johXLfEd6P4umaT14YQEQ
- Close file handles properly in dbt_analyse.py (use `with` statements)
- Add PEP 723 inline metadata to dbt_analyse.py for uv compatibility
- Move `import re` to module level in dbt_batch_audit.py
- Write context to a temp file in dbt_analyse.py to avoid ARG_MAX limits
- Add subprocess timeouts (900s audit, 1200s synthesis) to prevent hangs
- Order template substitutions to avoid placeholder injection

https://claude.ai/code/session_01RHSUYqsWy6xLfAC9tFTy66
- Rewrite dbt_deep_analysis.md with a comprehensive 8-section audit
  checklist covering schema/types, join correctness, filters, grain,
  data quality, performance, test coverage gaps, and upstream risks
- Add structured output format (findings table, evidence queries,
  suggested dbt test YAML snippets)
- Add conditional template sections ({{#if lineage}}, {{#if existing_tests}})
  with a lightweight Handlebars-style renderer in both scripts
- Gather model lineage (parents/children) via `dbt ls` selectors
- Scan schema.yml files for existing test definitions and include them
  so the LLM focuses on coverage gaps rather than redundant suggestions
- Add pyyaml dependency to both scripts' PEP 723 metadata

https://claude.ai/code/session_01RHSUYqsWy6xLfAC9tFTy66
- Remove unused `import json`
- Remove stub `get_data_profile` that always returned empty string
- Simplify redundant glob patterns in get_existing_tests (*.yml already
  covers schema.yml, _schema.yml, *_models.yml)

https://claude.ai/code/session_01RHSUYqsWy6xLfAC9tFTy66
Move all dbt helpers and keymaps from keymaps.lua into a dedicated
config/dbt.lua, loaded via require("config.dbt"). Keeps keymaps.lua
focused on general-purpose bindings.

https://claude.ai/code/session_01RHSUYqsWy6xLfAC9tFTy66
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants