Configure pre-commit for your dbt project in Paradime

Overview

In Paradime, pre-commit hooks are enforced in your CI pipeline, not on developer machines. You keep a .pre-commit-config.yaml at the root of your dbt™ repository, and a Turbo CI schedule runs the hooks against the files changed in each pull request using the Run pre-commit command, before running your dbt™ build. Because enforcement happens in CI, every contributor gets the same checks with no local setup, and a failing hook blocks the pull request instead of silently slipping through.

Getting Started

Add a .pre-commit-config.yaml at the root of your dbt™ repository with the hooks you want to enforce (see the example below).
Add a Run pre-commit command to your Turbo CI schedule, before your dbt™ command, so only the files changed in the pull request are checked:
pre-commit run --from-ref origin/main --to-ref HEAD

Lint and Test Code Changes On Pull Requests

Full Turbo CI template with a complete pre-commit configuration and schedule YAML.

Example configuration

Paradime’s standard recommended hooks cover:

SQL formatting and linting using SQLFluff
dbt models checks using dbt-checkpoint
YAML validation using Prettier
General code quality checks

Example pre commit hooks template

.pre-commit-config.yaml

# Auto-update the config to the latest repos' versions by executing "pre-commit autoupdate"
# For more dbt pre-commit hooks check https://docs.paradime.io/app-help/documentation/integrations/code-ide/pre-commit

repos:
  # YAML formatting using Prettier
  - repo: https://github.com/pre-commit/mirrors-prettier
    rev: v3.1.0
    hooks:
      - id: prettier
        types: [yaml] # Only run on YAML files
        additional_dependencies:
          - prettier@3.1.0
        args: [--write]

  # Standard pre-commit hooks
  - repo: https://github.com/pre-commit/pre-commit-hooks
    rev: v5.0.0
    hooks:
      - id: trailing-whitespace
        name: Trim Trailing Whitespace
        description: Removes trailing whitespace from all files
        files: ^.*\.(sql|yml|yaml|md)$
      - id: end-of-file-fixer
        name: Fix End of Files
        description: Ensures files end with a newline
        files: ^.*\.(sql|yml|yaml|md)$
      - id: check-added-large-files
        name: Check for Large Files
        description: Prevents giant files from being committed
        args: ["--maxkb=500"]

  # SQL formatting using SQLFluff
  - repo: https://github.com/sqlfluff/sqlfluff
    rev: 3.3.0
    hooks:
      - id: sqlfluff-lint
        name: SQLFluff Lint
        description: Lints SQL files using SQLFluff
        files: ^.*\.sql$
        additional_dependencies: ["sqlfluff-templater-dbt"]
        args: ["--dialect", "bigquery", "--templater", "dbt"]
      - id: sqlfluff-fix
        name: SQLFluff Fix
        description: Auto-fixes SQL files using SQLFluff
        files: ^.*\.sql$
        additional_dependencies: ["sqlfluff-templater-dbt"]
        args: ["--dialect", "bigquery", "--templater", "dbt"]

  # dbt™️ specific checks
  - repo: https://github.com/dbt-checkpoint/dbt-checkpoint
    rev: v2.0.6
    hooks:
      # Model checks
      - id: check-model-has-description
        name: Check Model Descriptions
        description: Ensures models have descriptons
      - id: check-model-has-tests
        name: Check Model Tests
        description: Ensures models have minimum test coverage
        args: ["--test-cnt", "2"]

      # Script checks
      - id: remove-script-semicolon
        name: Remove Script Semicolon
        description: Remove semicolons at the end of the script
        files: models/.*\.sql$
      - id: check-script-has-no-table-name
        name: Check Script Table References
        description: Ensure only source() or ref() macros are used for table references
        files: models/.*\.sql$
      - id: check-script-ref-and-source
        name: Check Script References
        description: Validate all ref() and source() references exist
        files: models/.*\.sql$
        args: [--manifest, target/manifest.json]
      - id: dbt-parse

# Define what files to exclude from all hooks
exclude: |
  (?x)^(
      target/.*|
      logs/.*|
      .*/snapshots/.*|
      tests/.*_test\.sql|
      analysis/.*
  )$

Running checks on demand in the Code IDE

While Turbo CI is the enforcement point, you can run the same checks on demand from the Code IDE terminal to get feedback before you push. Pre-commit comes pre-installed, so run:

paradime pre-commit

Then choose what to check:

All Files: Run checks on all files in your project
Staged Files: Run checks only on files staged for commit

Note: When running pre-commits for the first time, Paradime will install all necessary hooks. This initial setup might take a minute to complete as it downloads and configures the required components.

Do not install pre-commit as a commit hook in the Code IDE. Avoid running pre-commit install: commits made through the Git Lite or Git Advanced panel do not display hook output, so a failing hook blocks the commit with no visible error. Run checks on demand with paradime pre-commit instead, and let your Turbo CI schedule enforce the hooks on every pull request. If you previously ran pre-commit install, remove the commit hook with:

pre-commit uninstall

Best Practices

Start with Paradime’s recommended hooks
Enforce hooks in your Turbo CI schedule so every pull request is checked the same way
Run paradime pre-commit on demand before pushing large changes
Keep hook configurations in version control
Gradually customize configurations as needed

Common Workflows

Check your changes before pushing

git add your_files
paradime pre-commit
# Review and fix any issues, then commit and push

Enforce hooks on pull requests

Add the Run pre-commit command to your Turbo CI schedule ahead of your dbt™ command. See the Lint and Test Code Changes On Pull Requests template.

Updating Hook Configurations

Modify .pre-commit-config.yaml
Auto-update the config to the latest repos’ versions by executing pre-commit autoupdate
Commit the change; your Turbo CI schedule picks it up on the next pull request

​Overview

​Getting Started

Lint and Test Code Changes On Pull Requests

​Example configuration

​Running checks on demand in the Code IDE

​Best Practices

​Common Workflows

Overview

Getting Started

Example configuration

Running checks on demand in the Code IDE

Best Practices

Common Workflows