Merge pull request #152 from a5chin/feature/sqlfluff

Add sqlfluff

Author: a5chin

.devcontainer/devcontainer.json

@@ -13,6 +13,7 @@
         "vscode": {
             "extensions": [
                 "charliermarsh.ruff",
+                "dorzey.vscode-sqlfluff",
                 "exiasr.hadolint",
                 "kevinrose.vsc-python-indent",
                 "mosapride.zenkaku",

.dockerignore

@@ -182,6 +182,7 @@ pytest-coverage.txt
 .coveragerc
 .env.local
 .pre-commit-config.yaml
+.sqlfluff
 assets
 LICENSE
 noxfile.py

.github/workflows/format.yml

@@ -7,7 +7,9 @@ on:
       - ".github/actions/setup-python-with-uv/action.yml"
       - ".github/workflows/format.yml"
       - "**.py"
+      - "**.sql"
       - ".python-version"
+      - ".sqlfluff"
       - "pyproject.toml"
       - "ruff.toml"
       - "uv.lock"
@@ -18,7 +20,9 @@ on:
       - ".github/actions/setup-python-with-uv/action.yml"
       - ".github/workflows/format.yml"
       - "**.py"
+      - "**.sql"
       - ".python-version"
+      - ".sqlfluff"
       - "pyproject.toml"
       - "ruff.toml"
       - "uv.lock"
@@ -35,4 +39,17 @@ jobs:
         uses: ./.github/actions/setup-python-with-uv
 
       - name: Format by Ruff
-        run: uv run nox -s fmt
+        run: uv run nox -s fmt -- --ruff
+
+  sqlfluff:
+    runs-on: ubuntu-latest
+
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v6
+
+      - name: Setup Python with uv
+        uses: ./.github/actions/setup-python-with-uv
+
+      - name: Format by SQLFluff
+        run: uv run nox -s fmt -- --sqlfluff

.github/workflows/lint.yml

@@ -7,7 +7,9 @@ on:
       - ".github/actions/setup-python-with-uv/action.yml"
       - ".github/workflows/lint.yml"
       - "**.py"
+      - "**.sql"
       - ".python-version"
+      - ".sqlfluff"
       - "pyproject.toml"
       - "pyrightconfig.json"
       - "ruff.toml"
@@ -19,7 +21,9 @@ on:
       - ".github/actions/setup-python-with-uv/action.yml"
       - ".github/workflows/lint.yml"
       - "**.py"
+      - "**.sql"
       - ".python-version"
+      - ".sqlfluff"
       - "pyproject.toml"
       - "pyrightconfig.json"
       - "ruff.toml"
@@ -51,3 +55,16 @@ jobs:
 
       - name: Lint by Ruff
         run: uv run nox -s lint -- --ruff
+
+  sqlfluff:
+    runs-on: ubuntu-latest
+
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v6
+
+      - name: Setup Python with uv
+        uses: ./.github/actions/setup-python-with-uv
+
+      - name: Lint by SQLFluff
+        run: uv run nox -s lint -- --sqlfluff

.pre-commit-config.yaml

@@ -54,5 +54,18 @@ repos:
         types: ["dockerfile"]
         entry: hadolint
 
+  - repo: https://github.com/sqlfluff/sqlfluff
+    rev: 3.5.0
+    hooks:
+      - id: sqlfluff-lint
+        name: SQLFluff Lint
+        description: "Lints sql files with `SQLFluff`"
+        types: [sql]
+
+      - id: sqlfluff-fix
+        name: SQLFluff Fix
+        description: "Fixes sql lint errors with `SQLFluff`"
+        types: [sql]
+
 ci:
   autoupdate_schedule: weekly

.sqlfluff

@@ -0,0 +1,14 @@
+[sqlfluff]
+dialect = bigquery
+max_line_length = 80
+
+exclude_rules =
+
+[sqlfluff:indentation]
+tab_space_size = 2
+
+[sqlfluff:rules:ambiguous.join]
+fully_qualify_join_types = both
+
+[sqlfluff:rules:structure.unused_join]
+forbid_unused_join = True

.vscode/cspell.json

@@ -10,6 +10,7 @@
         "apdisk",
         "autoflake",
         "autolabeler",
+        "beartype",
         "buildkit",
         "buildx",
         "caplog",
@@ -40,6 +41,7 @@
         "ipynb",
         "ipython",
         "isort",
+        "jaxtyping",
         "junitxml",
         "kevinrose",
         "kwargs",
@@ -96,9 +98,11 @@
         "spyderproject",
         "spyproject",
         "sqlalchemy",
+        "sqlfluff",
         "stmts",
         "superfences",
         "tamasfe",
+        "templater",
         "testpaths",
         "timemachine",
         "toolsai",

.vscode/extensions.json

@@ -2,6 +2,7 @@
     "recommendations": [
         "charliermarsh.ruff",
         "codezombiech.gitignore",
+        "dorzey.vscode-sqlfluff",
         "eamodio.gitlens",
         "exiasr.hadolint",
         "kevinrose.vsc-python-indent",

.vscode/settings.json

@@ -13,6 +13,10 @@
         "tests"
     ],
     "python.testing.unittestEnabled": false,
+    "sqlfluff.config": "${workspaceFolder}/.sqlfluff",
+    "sqlfluff.executablePath": "/home/vscode/.venv/bin/sqlfluff",
+    "sqlfluff.format.enabled": true,
+    "sqlfluff.linter.run": "onType",
     "terminal.integrated.defaultProfile.linux": "zsh",
     "terminal.integrated.profiles.linux": {
         "zsh": {
@@ -61,6 +65,11 @@
         "editor.formatOnSave": true,
         "editor.tabSize": 4
     },
+    "[sql]": {
+        "editor.defaultFormatter": "dorzey.vscode-sqlfluff",
+        "editor.formatOnSave": true,
+        "editor.tabSize": 2
+    },
     "[toml]": {
         "editor.defaultFormatter": "tamasfe.even-better-toml",
         "editor.formatOnSave": true,

CLAUDE.md

@@ -42,24 +42,40 @@ uv run pytest
 
 ### Linting & Formatting
 ```bash
-# Format code
-uv run nox -s fmt
+# Format code with Ruff
+uv run nox -s fmt -- --ruff
+
+# Format SQL files with SQLFluff
+uv run nox -s fmt -- --sqlfluff
+
+# Format both Python and SQL
+uv run nox -s fmt -- --ruff --sqlfluff
 
 # Lint with both Pyright and Ruff
 uv run nox -s lint -- --pyright --ruff
 
+# Lint with all tools (Pyright, Ruff, SQLFluff)
+uv run nox -s lint -- --pyright --ruff --sqlfluff
+
 # Lint with Pyright only
 uv run nox -s lint -- --pyright
 
 # Lint with Ruff only
 uv run nox -s lint -- --ruff
 
+# Lint SQL files only
+uv run nox -s lint -- --sqlfluff
+
 # Run Ruff directly
 uv run ruff check . --fix
 uv run ruff format .
 
 # Run Pyright directly
 uv run pyright
+
+# Run SQLFluff directly
+uv run sqlfluff lint .
+uv run sqlfluff fix .
 ```
 
 ### Pre-commit Hooks
@@ -164,6 +180,12 @@ Tests in `tests/tools/` mirror the package structure:
 - Reports: HTML + terminal
 - Import mode: importlib
 
+**SQLFluff (.sqlfluff)**:
+- Dialect: BigQuery
+- Max line length: 80
+- Tab space size: 2
+- Custom rules for join qualification and unused joins
+
 ### Nox Task Automation
 
 The `noxfile.py` uses a custom `CLIArgs` parser (Pydantic-based):
@@ -181,6 +203,8 @@ def lint(session: nox.Session) -> None:
         session.run("uv", "run", "pyright")
     if args.ruff:
         session.run("uv", "run", "ruff", "check", ".", "--fix")
+    if args.sqlfluff:
+        session.run("uv", "run", "sqlfluff", "lint", ".")
 ```
 
 ## Key Patterns for Development