Skip to content

Commit

Permalink
Update lint-format.md (#4245)
Browse files Browse the repository at this point in the history
## What are you changing in this pull request and why?
Adding some limitations of our SQLFluff implementation. See internal
JIRA: https://dbtlabs.atlassian.net/browse/XP-2679

## Checklist
- [x] Review the [Content style
guide](https://github.com/dbt-labs/docs.getdbt.com/blob/current/contributing/content-style-guide.md)
and [About
versioning](https://github.com/dbt-labs/docs.getdbt.com/blob/current/contributing/single-sourcing-content.md#adding-a-new-version)
so my content adheres to these guidelines.
- [ ] Add a checklist item for anything that needs to happen before this
PR is merged, such as "needs technical review" or "change base branch."
  • Loading branch information
mirnawong1 authored Oct 11, 2023
2 parents 0dc55d4 + 0499a69 commit cf0a4e1
Showing 1 changed file with 11 additions and 1 deletion.
12 changes: 11 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.

:::info Ephemeral models not supported
Linting doesn't support ephemeral models in dbt v1.5 and lower. Refer to the [FAQs](#faqs) for more info.
:::

### Enable linting

Expand Down Expand Up @@ -223,6 +227,12 @@ 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>
&mdash; Double-check your SQLFluff version matches the one in dbt Cloud IDE (found in the <b>Code Quality</b> tab after a lint operation). <br /><br />
&mdash; If your lint operation passes despite clear rule violations, confirm you're not linting models with ephemeral models. Linting doesn't support ephemeral models in dbt v1.5 and lower.
</details>

## Related docs

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

0 comments on commit cf0a4e1

Please sign in to comment.