Add sqlfluff to pre-commit #11010
Open
Add sqlfluff to pre-commit #11010
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
There was a problem hiding this comment.
Pull Request Overview
This PR integrates SQLFluff into the repository’s pre-commit setup to catch SQL syntax issues early by:
- Adding a
.sqlfluffconfiguration file for Postgres dialect and style rules - Registering the
sqlfluff-linthook in.pre-commit-config.yaml - Updating project dependencies to include SQLFluff
Reviewed Changes
Copilot reviewed 2 out of 3 changed files in this pull request and generated no comments.
| File | Description |
|---|---|
| .sqlfluff | Configures SQLFluff for Postgres and style rules |
| .pre-commit-config.yaml | Adds sqlfluff-lint hook under repos: |
Comments suppressed due to low confidence (2)
.pre-commit-config.yaml:127
- Ensure the indentation of this
- repo:entry matches the otherrepos:entries in the file to prevent YAML parsing errors.
- repo: https://github.com/sqlfluff/sqlfluff
.pre-commit-config.yaml:127
- Consider adding a CI step in your workflow to run
pre-commit run --all-filesso that SQLFluff linting is enforced on every pull request.
- repo: https://github.com/sqlfluff/sqlfluff
github-project-automation
bot
moved this to Waiting Review/Merge from Staff
in Ray's Project
RayBB
reviewed
Jul 9, 2025
mekarpeles
commented
Jul 13, 2025
cdrini
requested changes
Jul 14, 2025
| WHERE ratings.created <= (:'upto'::date + '1 day'::interval) | ||
| ) TO stdout WITH (format csv, delimiter E'\t') | ||
| SELECT | ||
| ratings.rating, |
There was a problem hiding this comment.
This will change the ordering of the columns, we don't want that.
Comment on lines
+127
to
+141
| - repo: https://github.com/sqlfluff/sqlfluff | ||
| rev: 3.4.2 # or latest stable version | ||
| hooks: | ||
| - id: sqlfluff-fix | ||
| name: SQLFluff Auto-Fix | ||
| types: [sql] | ||
|
|
||
| - repo: https://github.com/sqlfluff/sqlfluff | ||
| rev: 3.4.2 | ||
| hooks: | ||
| - id: sqlfluff-lint | ||
| name: SQLFluff Linter | ||
| entry: sqlfluff lint | ||
| language: python | ||
| types: [sql] |
|
|
||
| create index thing_latest_revision_idx ON thing(latest_revision); | ||
| create index thing_latest_revision_idx on thing (latest_revision); |
There was a problem hiding this comment.
Why is this file requiring lower case, when the others require uppercase?
| [sqlfluff] | ||
| dialect = postgres | ||
| exclude_rules = L031 | ||
| templater = jinja |
There was a problem hiding this comment.
Do we need this? We don't use jinja
Suggested change
| templater = jinja |
| @@ -27,5 +27,6 @@ qrcode==7.4.2 | |||
| requests==2.32.2 | |||
| sentry-sdk==2.19.2 | |||
| simplejson==3.19.1 | |||
| sqlfluff==3.4.2 | |||
There was a problem hiding this comment.
This should go into requirements_test.py
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Closes #10982
🧩 Problem
New contributors were blocked from initializing the repo due to a subtle syntax error in a .sql file (see #10979). These issues slipped by because the Postgres container caches its state and existing contributors didn’t experience the broken flow.
💡 Solution
Introduce sqlfluff as a SQL linter to catch future issues. Integrate it with our existing pre-commit system and configure it for Postgres.
🔧 Changes Included
Testing
Stakeholders