From 263876659510241bae77c893d0797ca06af0e87b Mon Sep 17 00:00:00 2001 From: Will Sargent <109557847+will-sargent-dbtlabs@users.noreply.github.com> Date: Tue, 15 Aug 2023 17:16:31 -0600 Subject: [PATCH 1/8] Update 2-how-we-style-our-sql.md Adds information about custom .sqlfluff and .sqlfluffignore files --- .../best-practices/how-we-style/2-how-we-style-our-sql.md | 4 +++- 1 file changed, 3 insertions(+), 1 deletion(-) diff --git a/website/docs/guides/best-practices/how-we-style/2-how-we-style-our-sql.md b/website/docs/guides/best-practices/how-we-style/2-how-we-style-our-sql.md index 1ea9c064d7..62c5fcda89 100644 --- a/website/docs/guides/best-practices/how-we-style/2-how-we-style-our-sql.md +++ b/website/docs/guides/best-practices/how-we-style/2-how-we-style-our-sql.md @@ -6,7 +6,9 @@ id: 2-how-we-style-our-sql ## Basics - ☁️ Use [SQLFluff](https://sqlfluff.com/) to maintain these style rules automatically. - - Reference this [SQLFluff config file](https://github.com/dbt-labs/jaffle-shop-template/blob/main/.sqlfluff) for the rules we use. + - Custom `.sqlfluff` configuration files are supported. + - Reference this [SQLFluff config file](https://github.com/dbt-labs/jaffle-shop-template/blob/main/.sqlfluff) for the rules we use in our own projects. + - We also support ignoring files and folders using a standard `.sqlfluffignore` file. Reference these docs for the syntax: [.sqlfluffignore syntax docs](https://docs.sqlfluff.com/en/stable/configuration.html#id2) - 👻 Use Jinja comments (`{# #}`) for comments that should not be included in the compiled SQL. - ⏭️ Use trailing commas. - 4️⃣ Indents should be four spaces. From 47ef3617e43cad90504e211e017ee1533660b116 Mon Sep 17 00:00:00 2001 From: mirnawong1 <89008547+mirnawong1@users.noreply.github.com> Date: Wed, 16 Aug 2023 10:14:28 -0400 Subject: [PATCH 2/8] Update website/docs/guides/best-practices/how-we-style/2-how-we-style-our-sql.md --- .../best-practices/how-we-style/2-how-we-style-our-sql.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/website/docs/guides/best-practices/how-we-style/2-how-we-style-our-sql.md b/website/docs/guides/best-practices/how-we-style/2-how-we-style-our-sql.md index 62c5fcda89..75250745b8 100644 --- a/website/docs/guides/best-practices/how-we-style/2-how-we-style-our-sql.md +++ b/website/docs/guides/best-practices/how-we-style/2-how-we-style-our-sql.md @@ -6,7 +6,7 @@ id: 2-how-we-style-our-sql ## Basics - ☁️ Use [SQLFluff](https://sqlfluff.com/) to maintain these style rules automatically. - - Custom `.sqlfluff` configuration files are supported. + - Customize `.sqlfluff` configuration files to your needs. - Reference this [SQLFluff config file](https://github.com/dbt-labs/jaffle-shop-template/blob/main/.sqlfluff) for the rules we use in our own projects. - We also support ignoring files and folders using a standard `.sqlfluffignore` file. Reference these docs for the syntax: [.sqlfluffignore syntax docs](https://docs.sqlfluff.com/en/stable/configuration.html#id2) - 👻 Use Jinja comments (`{# #}`) for comments that should not be included in the compiled SQL. From 0663b5e38d341de058ff1f1b4fb7de29e7ace5da Mon Sep 17 00:00:00 2001 From: mirnawong1 <89008547+mirnawong1@users.noreply.github.com> Date: Wed, 16 Aug 2023 10:15:25 -0400 Subject: [PATCH 3/8] Update website/docs/guides/best-practices/how-we-style/2-how-we-style-our-sql.md --- .../best-practices/how-we-style/2-how-we-style-our-sql.md | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/website/docs/guides/best-practices/how-we-style/2-how-we-style-our-sql.md b/website/docs/guides/best-practices/how-we-style/2-how-we-style-our-sql.md index 75250745b8..cbc4e69e4d 100644 --- a/website/docs/guides/best-practices/how-we-style/2-how-we-style-our-sql.md +++ b/website/docs/guides/best-practices/how-we-style/2-how-we-style-our-sql.md @@ -7,7 +7,8 @@ id: 2-how-we-style-our-sql - ☁️ Use [SQLFluff](https://sqlfluff.com/) to maintain these style rules automatically. - Customize `.sqlfluff` configuration files to your needs. - - Reference this [SQLFluff config file](https://github.com/dbt-labs/jaffle-shop-template/blob/main/.sqlfluff) for the rules we use in our own projects. + - Refer to our [SQLFluff config file](https://github.com/dbt-labs/jaffle-shop-template/blob/main/.sqlfluff) for the rules we us in our own projects. + - We also support ignoring files and folders using a standard `.sqlfluffignore` file. Reference these docs for the syntax: [.sqlfluffignore syntax docs](https://docs.sqlfluff.com/en/stable/configuration.html#id2) - 👻 Use Jinja comments (`{# #}`) for comments that should not be included in the compiled SQL. - ⏭️ Use trailing commas. From e3648a7b7332e50318630a62560286a31ee5e2d9 Mon Sep 17 00:00:00 2001 From: mirnawong1 <89008547+mirnawong1@users.noreply.github.com> Date: Wed, 16 Aug 2023 10:16:39 -0400 Subject: [PATCH 4/8] Update website/docs/guides/best-practices/how-we-style/2-how-we-style-our-sql.md --- .../best-practices/how-we-style/2-how-we-style-our-sql.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/website/docs/guides/best-practices/how-we-style/2-how-we-style-our-sql.md b/website/docs/guides/best-practices/how-we-style/2-how-we-style-our-sql.md index cbc4e69e4d..2845c1cbe9 100644 --- a/website/docs/guides/best-practices/how-we-style/2-how-we-style-our-sql.md +++ b/website/docs/guides/best-practices/how-we-style/2-how-we-style-our-sql.md @@ -9,7 +9,7 @@ id: 2-how-we-style-our-sql - Customize `.sqlfluff` configuration files to your needs. - Refer to our [SQLFluff config file](https://github.com/dbt-labs/jaffle-shop-template/blob/main/.sqlfluff) for the rules we us in our own projects. - - We also support ignoring files and folders using a standard `.sqlfluffignore` file. Reference these docs for the syntax: [.sqlfluffignore syntax docs](https://docs.sqlfluff.com/en/stable/configuration.html#id2) + - Exclude files and directories by using a standard `.sqlfluffignore` file. Learn more about the syntax in the [.sqlfluffignore syntax docs](https://docs.sqlfluff.com/en/stable/configuration.html#id2). - 👻 Use Jinja comments (`{# #}`) for comments that should not be included in the compiled SQL. - ⏭️ Use trailing commas. - 4️⃣ Indents should be four spaces. From a89a1fe334e8e7ae31ffcbf2baa17ca065232013 Mon Sep 17 00:00:00 2001 From: mirnawong1 <89008547+mirnawong1@users.noreply.github.com> Date: Wed, 16 Aug 2023 10:19:43 -0400 Subject: [PATCH 5/8] Update lint-format.md --- website/docs/docs/cloud/dbt-cloud-ide/lint-format.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/website/docs/docs/cloud/dbt-cloud-ide/lint-format.md b/website/docs/docs/cloud/dbt-cloud-ide/lint-format.md index 099641cc22..77c1089ed9 100644 --- a/website/docs/docs/cloud/dbt-cloud-ide/lint-format.md +++ b/website/docs/docs/cloud/dbt-cloud-ide/lint-format.md @@ -63,7 +63,7 @@ With the dbt Cloud IDE, you can seamlessly use [SQLFluff](https://sqlfluff.com/) ### Customize linting -SQLFluff is a configurable SQL linter, which means you can configure your own linting rules instead of using the default linting settings in the IDE. +SQLFluff is a configurable SQL linter, which means you can configure your own linting rules instead of using the default linting settings in the IDE. You can exclude files and directories by using a standard `.sqlfluffignore` file. Learn more about the syntax in the [.sqlfluffignore syntax docs](https://docs.sqlfluff.com/en/stable/configuration.html#id2). To configure your own linting rules: From 7882282f5fd78895b834c7be02cf213de42686e7 Mon Sep 17 00:00:00 2001 From: Will Sargent <109557847+will-sargent-dbtlabs@users.noreply.github.com> Date: Wed, 16 Aug 2023 08:25:04 -0600 Subject: [PATCH 6/8] Grammer fix "use" instead of "us" --- .../best-practices/how-we-style/2-how-we-style-our-sql.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/website/docs/guides/best-practices/how-we-style/2-how-we-style-our-sql.md b/website/docs/guides/best-practices/how-we-style/2-how-we-style-our-sql.md index 2845c1cbe9..9684a498bc 100644 --- a/website/docs/guides/best-practices/how-we-style/2-how-we-style-our-sql.md +++ b/website/docs/guides/best-practices/how-we-style/2-how-we-style-our-sql.md @@ -7,7 +7,7 @@ id: 2-how-we-style-our-sql - ☁️ Use [SQLFluff](https://sqlfluff.com/) to maintain these style rules automatically. - Customize `.sqlfluff` configuration files to your needs. - - Refer to our [SQLFluff config file](https://github.com/dbt-labs/jaffle-shop-template/blob/main/.sqlfluff) for the rules we us in our own projects. + - Refer to our [SQLFluff config file](https://github.com/dbt-labs/jaffle-shop-template/blob/main/.sqlfluff) for the rules we use in our own projects. - Exclude files and directories by using a standard `.sqlfluffignore` file. Learn more about the syntax in the [.sqlfluffignore syntax docs](https://docs.sqlfluff.com/en/stable/configuration.html#id2). - 👻 Use Jinja comments (`{# #}`) for comments that should not be included in the compiled SQL. From e2466c9d3e9eab4e634708f4628e4f35b03e7ac9 Mon Sep 17 00:00:00 2001 From: mirnawong1 <89008547+mirnawong1@users.noreply.github.com> Date: Wed, 16 Aug 2023 10:31:50 -0400 Subject: [PATCH 7/8] Update lint-format.md --- website/docs/docs/cloud/dbt-cloud-ide/lint-format.md | 6 ++++-- 1 file changed, 4 insertions(+), 2 deletions(-) diff --git a/website/docs/docs/cloud/dbt-cloud-ide/lint-format.md b/website/docs/docs/cloud/dbt-cloud-ide/lint-format.md index 77c1089ed9..60af0961db 100644 --- a/website/docs/docs/cloud/dbt-cloud-ide/lint-format.md +++ b/website/docs/docs/cloud/dbt-cloud-ide/lint-format.md @@ -63,7 +63,7 @@ With the dbt Cloud IDE, you can seamlessly use [SQLFluff](https://sqlfluff.com/) ### Customize linting -SQLFluff is a configurable SQL linter, which means you can configure your own linting rules instead of using the default linting settings in the IDE. You can exclude files and directories by using a standard `.sqlfluffignore` file. Learn more about the syntax in the [.sqlfluffignore syntax docs](https://docs.sqlfluff.com/en/stable/configuration.html#id2). +SQLFluff is a configurable SQL linter, which means you can configure your own linting rules instead of using the default linting settings in the IDE. You can exclude files and directories by using a standard `.sqlfluffignore` file. Learn more about the syntax in the [.sqlfluffignore syntax docs](https://docs.sqlfluff.com/en/stable/configuration.html#id2). To configure your own linting rules: @@ -76,7 +76,7 @@ To configure your own linting rules: :::tip Configure dbtonic linting rules -Use the following code example to incorporate well-written dbt code (or dbtonic) to your linting: +Refer to the [SQLFluff config file](https://github.com/dbt-labs/jaffle-shop-template/blob/main/.sqlfluff) to add the dbt code (or dbtonic) rules we use for our own projects:
dbtonic config code example provided by dbt Labs @@ -122,6 +122,8 @@ capitalisation_policy = lower group_by_and_order_by_style = implicit ```
+ +Refer to [How we style our SQL](/guides/best-practices/how-we-style/2-how-we-style-our-sql) for more info. ::: From 2e9ebeae9f9bea422bed63935e786e9b50369e1d Mon Sep 17 00:00:00 2001 From: mirnawong1 <89008547+mirnawong1@users.noreply.github.com> Date: Wed, 16 Aug 2023 11:04:40 -0400 Subject: [PATCH 8/8] Update website/docs/docs/cloud/dbt-cloud-ide/lint-format.md --- website/docs/docs/cloud/dbt-cloud-ide/lint-format.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/website/docs/docs/cloud/dbt-cloud-ide/lint-format.md b/website/docs/docs/cloud/dbt-cloud-ide/lint-format.md index 60af0961db..8ffd83ef00 100644 --- a/website/docs/docs/cloud/dbt-cloud-ide/lint-format.md +++ b/website/docs/docs/cloud/dbt-cloud-ide/lint-format.md @@ -123,7 +123,7 @@ group_by_and_order_by_style = implicit ``` -Refer to [How we style our SQL](/guides/best-practices/how-we-style/2-how-we-style-our-sql) for more info. +For more info on styling best practices, refer to [How we style our SQL](/guides/best-practices/how-we-style/2-how-we-style-our-sql). :::