Skip to content
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.

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

Update lint-format.md #4245

Merged
merged 9 commits into from
Oct 11, 2023
13 changes: 12 additions & 1 deletion website/docs/docs/cloud/dbt-cloud-ide/lint-format.md
Original file line number Diff line number Diff line change
Expand Up @@ -45,7 +45,11 @@ With the dbt Cloud IDE, you can seamlessly use [SQLFluff](https://sqlfluff.com/)
- Works with Jinja and SQL,
- Comes with built-in [linting rules](https://docs.sqlfluff.com/en/stable/rules.html). You can also [customize](#customize-linting) your own linting rules.
- Empowers you to [enable linting](#enable-linting) with options like **Lint** (displays linting errors and recommends actions) or **Fix** (auto-fixes errors in the IDE).
- Displays a **Code Quality** tab to view code errors, and provides code quality visibility and management.
- Displays a **Code Quality** tab to view code errors, and provides code quality visibility and management.

:::Ephemeral models not supported
Linting doesn't support ephemeral models in dbt versions 1.5 and lower. Refer to the [FAQs](#faqs) for more info.
mirnawong1 marked this conversation as resolved.
Show resolved Hide resolved
:::

### Enable linting

Expand Down Expand Up @@ -223,6 +227,13 @@ Currently, running SQLFluff commands from the terminal isn't supported.
Make sure you're on a development branch. Formatting or Linting isn't available on "main" or "read-only" branches.
</details>

<details>
<summary>Why is there inconsistent SQLFluff behavior when running outside the dbt Cloud IDE (such as a GitHub Action)?</summary>

* Double-check your SQLFluff version matches the one in dbt Cloud IDE (found in the "Code Quality" tab after a lint operation).
* If your lint operation is always passing when there exist clear rule violations - check that you are not linting a model that uses ephemeral models (dbt versions prior to 1.6 only).
mirnawong1 marked this conversation as resolved.
Show resolved Hide resolved
</details>

## Related docs

- [User interface](/docs/cloud/dbt-cloud-ide/ide-user-interface)
Expand Down
Loading