Lint

Learn how to use Paradime's code quality tools to automatically format SQL and YAML files in your dbt™ project.

Paradime provides built-in code quality tools to help maintain consistent formatting and style in your dbt™ project. The Lint feature automatically applies the appropriate formatting tool based on your file type.

How It Works

Click the Lint button in the Command Panel while editing a file to automatically format your code. The tool used for formatting is determined by the file type you have open in the editor:

• SQLfluff - runs to lint your SQL code if you're editing a .sql file.

• Prettier - runs to lint your YAML if you're editing a .yml file.

---

SQLFluff

SQLfluff is a SQL linter that helps maintain consistent SQL code style and catch potential errors. It understands dbt™ and Jinja templating, making it perfect for dbt™ projects.

Configuring .sqlfluff

Before using SQLfluff, create a configuration file to customize its behavior:

1. Create a .sqlfluff file in your dbt™ project root directory (same location as your dbt_project.yml)

2. Add your configuration:

.sqlfluff example file

[sqlfluff]
dialect = snowflake  # Update based on your warehouse
templater = dbt

[sqlfluff:templater:dbt]
project_dir = ./

# Common rules to exclude
exclude_rules = ambiguous.column_count, structure.column_order

# Line length limit
max_line_length = 120

Visit SQLfluff documentation for a complete list of configuration options.

Using SQLfluff

1. Open a .sql file in your editor

2. Click the Lint button in the Command Panel

3. Review the changes made in Git Lite

   • Syntax errors

   • Style violations

   • Formatting suggestions

4. If satisfied with Lint updates, Commit and Push your changes to your remote branch.

Want to automate SQLfluff linting? Learn how to set up SQLfluff pre-commit hooks to automatically lint SQL files before each commit.

---

Prettier

Prettier automatically formats your YAML files to ensure consistent structure across your dbt™ project. While the integration works out of the box, you can customize Prettier's behavior:

Configuring Prettier

While Prettier works out of the box with sensible defaults, you can customize its behavior:

1. Create a .prettierrc.yaml file in your dbt™ project root directory (same location as your dbt_project.yml)

2. Add your configuration:

.prettierrc.yaml example file

# .prettierrc.yaml example file
yamlCopyparser: yaml
trailingComma: es5
tabWidth: 4
semi: false
singleQuote: true
printWidth: 100

Visit prettier documentation a complete list of configuration options.

Using Prettier

1. Open a .yml file in your editor

2. Click the Lint button in the Command Panel

3. Review the changes in Git Lite

   • YAML syntax corrections

   • Formatting improvements

   • Structure updates

4. If satisfied with Lint updates, Commit and Push your changes to your remote branch

Want to automate YAML formatting? Learn how to set up Prettier pre-commit hooks to automatically format YAML files before each commit.