Skip to content

Use ruff formatter in DABs templates (replacing Black) #4196

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.

Sign up for GitHub

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

Open
lennartkats-db wants to merge 8 commits into
base: main
Choose a base branch
from
Open

Use ruff formatter in DABs templates (replacing Black) #4196

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
8 commits
Select commit Hold shift + click to select a range
67629e1
Replace Black formatter with Ruff in Python bundle templates
lennartkats-db Jan 1, 2026
10456b6
Remove redundant Ruff settings from VS Code configuration
lennartkats-db Jan 5, 2026
9f4e1d4
Remove redundant Ruff instructions from README
lennartkats-db Jan 5, 2026
85eefc3
Remove automatic import organization from VS Code settings
lennartkats-db Jan 5, 2026
dd76b16
Restore original formatting to minimize diff from main
lennartkats-db Jan 5, 2026
bc1b347
Fix acceptance test: remove spurious .vscode/settings.json diff
lennartkats-db Jan 5, 2026
116d130
Merge branch 'main' into template-add-lint
lennartkats-db Jan 7, 2026
f48b89a
Merge branch 'main' into template-add-lint
lennartkats-db Jan 7, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions NEXT_CHANGELOG.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -15,6 +15,7 @@
* Add `ipykernel` to the `default` template to enable Databricks Connect notebooks in Cursor/VS Code ([#4164](https://github.com/databricks/cli/pull/4164))
* Add interactive SQL warehouse picker to `default-sql` and `dbt-sql` bundle templates ([#4170](https://github.com/databricks/cli/pull/4170))
* Add `name`, `target` and `mode` fields to the deployment metadata file ([#4180](https://github.com/databricks/cli/pull/4180))
* Replace Black formatter with Ruff in Python bundle templates for faster, all-in-one linting and formatting ([#4196](https://github.com/databricks/cli/pull/4196))
* engine/direct: Fix app deployment failure when app is in `DELETING` state ([#4176](https://github.com/databricks/cli/pull/4176))
* engine/direct: Changes in config that match remote changes no longer trigger an update ([#4201](https://github.com/databricks/cli/pull/4201))

Expand Down
2 changes: 1 addition & 1 deletion ...ptance/bundle/templates/default-minimal/output/my_default_minimal/.vscode/extensions.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,6 @@
"recommendations": [
"databricks.databricks",
"redhat.vscode-yaml",
"ms-python.black-formatter"
"charliermarsh.ruff"
]
}
2 changes: 1 addition & 1 deletion acceptance/bundle/templates/default-minimal/output/my_default_minimal/.vscode/settings.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -33,7 +33,7 @@
"python.testing.unittestEnabled": false,
"python.testing.pytestEnabled": true,
"[python]": {
"editor.defaultFormatter": "ms-python.black-formatter",
"editor.defaultFormatter": "charliermarsh.ruff",
"editor.formatOnSave": true,
},
}
2 changes: 1 addition & 1 deletion .../bundle/templates/default-python/classic/output/my_default_python/.vscode/extensions.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,6 @@
"recommendations": [
"databricks.databricks",
"redhat.vscode-yaml",
"ms-python.black-formatter"
"charliermarsh.ruff"
]
}
2 changes: 1 addition & 1 deletion ...ce/bundle/templates/default-python/classic/output/my_default_python/.vscode/settings.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -33,7 +33,7 @@
"python.testing.unittestEnabled": false,
"python.testing.pytestEnabled": true,
"[python]": {
"editor.defaultFormatter": "ms-python.black-formatter",
"editor.defaultFormatter": "charliermarsh.ruff",
"editor.formatOnSave": true,
},
}
5 changes: 3 additions & 2 deletions acceptance/bundle/templates/default-python/classic/output/my_default_python/pyproject.toml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -14,6 +14,7 @@ dependencies = [
[dependency-groups]
dev = [
"pytest",
"ruff",
"databricks-dlt",
"databricks-connect>=15.4,<15.5",
"ipykernel",
Expand All @@ -26,5 +27,5 @@ main = "my_default_python.main:main"
requires = ["hatchling"]
build-backend = "hatchling.build"

[tool.black]
line-length = 125
[tool.ruff]
line-length = 120
2 changes: 1 addition & 1 deletion ...ndle/templates/default-python/serverless/output/my_default_python/.vscode/extensions.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,6 @@
"recommendations": [
"databricks.databricks",
"redhat.vscode-yaml",
"ms-python.black-formatter"
"charliermarsh.ruff"
]
}
2 changes: 1 addition & 1 deletion ...bundle/templates/default-python/serverless/output/my_default_python/.vscode/settings.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -33,7 +33,7 @@
"python.testing.unittestEnabled": false,
"python.testing.pytestEnabled": true,
"[python]": {
"editor.defaultFormatter": "ms-python.black-formatter",
"editor.defaultFormatter": "charliermarsh.ruff",
"editor.formatOnSave": true,
},
}
5 changes: 3 additions & 2 deletions ...ptance/bundle/templates/default-python/serverless/output/my_default_python/pyproject.toml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -14,6 +14,7 @@ dependencies = [
[dependency-groups]
dev = [
"pytest",
"ruff",
"databricks-dlt",
"databricks-connect>=15.4,<15.5",
"ipykernel",
Expand All @@ -26,5 +27,5 @@ main = "my_default_python.main:main"
requires = ["hatchling"]
build-backend = "hatchling.build"

[tool.black]
line-length = 125
[tool.ruff]
line-length = 120
2 changes: 1 addition & 1 deletion .../templates/lakeflow-pipelines/python/output/my_lakeflow_pipelines/.vscode/extensions.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,6 @@
"recommendations": [
"databricks.databricks",
"redhat.vscode-yaml",
"ms-python.black-formatter"
"charliermarsh.ruff"
]
}
2 changes: 1 addition & 1 deletion ...le/templates/lakeflow-pipelines/python/output/my_lakeflow_pipelines/.vscode/settings.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -33,7 +33,7 @@
"python.testing.unittestEnabled": false,
"python.testing.pytestEnabled": true,
"[python]": {
"editor.defaultFormatter": "ms-python.black-formatter",
"editor.defaultFormatter": "charliermarsh.ruff",
"editor.formatOnSave": true,
},
}
5 changes: 3 additions & 2 deletions ...ce/bundle/templates/lakeflow-pipelines/python/output/my_lakeflow_pipelines/pyproject.toml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -14,6 +14,7 @@ dependencies = [
[dependency-groups]
dev = [
"pytest",
"ruff",
"databricks-dlt",
"databricks-connect>=15.4,<15.5",
"ipykernel",
Expand All @@ -29,5 +30,5 @@ build-backend = "hatchling.build"
[tool.hatch.build.targets.wheel]
packages = ["src"]

[tool.black]
line-length = 125
[tool.ruff]
line-length = 120
2 changes: 1 addition & 1 deletion ...dle/templates/lakeflow-pipelines/sql/output/my_lakeflow_pipelines/.vscode/extensions.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,6 @@
"recommendations": [
"databricks.databricks",
"redhat.vscode-yaml",
"ms-python.black-formatter"
"charliermarsh.ruff"
]
}
2 changes: 1 addition & 1 deletion ...undle/templates/lakeflow-pipelines/sql/output/my_lakeflow_pipelines/.vscode/settings.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -33,7 +33,7 @@
"python.testing.unittestEnabled": false,
"python.testing.pytestEnabled": true,
"[python]": {
"editor.defaultFormatter": "ms-python.black-formatter",
"editor.defaultFormatter": "charliermarsh.ruff",
"editor.formatOnSave": true,
},
}
5 changes: 3 additions & 2 deletions acceptance/bundle/templates/pydabs/init-classic/output/my_pydabs/pyproject.toml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -14,6 +14,7 @@ dependencies = [
[dependency-groups]
dev = [
"pytest",
"ruff",
"databricks-dlt",
"databricks-connect>=15.4,<15.5",
"ipykernel",
Expand All @@ -27,5 +28,5 @@ main = "my_pydabs.main:main"
requires = ["hatchling"]
build-backend = "hatchling.build"

[tool.black]
line-length = 125
[tool.ruff]
line-length = 120
2 changes: 1 addition & 1 deletion libs/template/templates/default/template/{{.project_name}}/.vscode/extensions.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,6 @@
"recommendations": [
"databricks.databricks",
"redhat.vscode-yaml",
"ms-python.black-formatter"
"charliermarsh.ruff"
]
}
2 changes: 1 addition & 1 deletion libs/template/templates/default/template/{{.project_name}}/.vscode/settings.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -33,7 +33,7 @@
"python.testing.unittestEnabled": false,
"python.testing.pytestEnabled": true,
"[python]": {
"editor.defaultFormatter": "ms-python.black-formatter",
"editor.defaultFormatter": "charliermarsh.ruff",
"editor.formatOnSave": true,
},
}
5 changes: 3 additions & 2 deletions libs/template/templates/default/template/{{.project_name}}/pyproject.toml.tmpl
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -14,6 +14,7 @@ dependencies = [
[dependency-groups]
dev = [
"pytest",
"ruff",
"databricks-dlt",
"databricks-connect{{template "conservative_db_connect_version_spec"}}",
"ipykernel",
Expand All @@ -38,5 +39,5 @@ build-backend = "hatchling.build"
packages = ["src"]
{{- end }}

[tool.black]
line-length = 125
[tool.ruff]
line-length = 120