Adding ruff into the template by ChrsBaur · Pull Request #129 · at-gmbh/at-python-template

ChrsBaur · 2024-05-27T23:20:05Z

No description provided.

# Conflicts: # poetry.lock # {{cookiecutter.project_slug}}/environment-dev.yml # {{cookiecutter.project_slug}}/pyproject.toml # {{cookiecutter.project_slug}}/requirements-dev.txt

# Conflicts: # {{cookiecutter.project_slug}}/pyproject.toml # {{cookiecutter.project_slug}}/requirements-dev.txt

Copilot

Pull request overview

This PR adds Ruff as a third code formatter option to the cookiecutter template, alongside the existing Black and none options. Ruff is a modern, fast Python linter and formatter that consolidates the functionality of multiple tools (Black, isort, pyupgrade, flake8) into a single tool.

Changes:

Added Ruff as a selectable code formatter option in cookiecutter.json
Integrated Ruff configuration across all package managers (Poetry, Conda, Pip, UV)
Added GitLab CI linting jobs for Ruff across all package managers
Updated dependency versions (JupyterLab 3.5 → 4.5.3, Ruff 0.1.7 → 0.12.2)

Reviewed changes

Copilot reviewed 10 out of 11 changed files in this pull request and generated 9 comments.

Show a summary per file

File	Description
cookiecutter.json	Added "ruff" as a third option for code_formatter with descriptive prompt text
{{cookiecutter.project_slug}}/pyproject.toml	Added Ruff configuration blocks and updated conditional logic for tool selection
{{cookiecutter.project_slug}}/requirements-dev.txt	Added Ruff dependency for pip-based projects
{{cookiecutter.project_slug}}/environment-dev.yml	Added Ruff to conda dependencies with proper conditionals
{{cookiecutter.project_slug}}/.pre-commit-config.yaml	Added ruff-pre-commit hooks with format and check support
{{cookiecutter.project_slug}}/.gitlab-ci.yml	Added linter-happiness CI jobs for all package managers using Ruff
{{cookiecutter.project_slug}}/.vscode__editor/settings.json	Added VSCode configuration for Ruff extension
tests/test_options.py	Added comprehensive test coverage for Ruff across all package managers and CI scenarios
hooks/post_gen_project.py	Updated formatter validation to include 'ruff' option
CHANGELOG.md	Documented the new Ruff support feature and related changes
{{cookiecutter.project_slug}}/README.md	Fixed trailing whitespace

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

Copilot · 2026-01-27T23:41:43Z

{{cookiecutter.project_slug}}/pyproject.toml

-{%- endif %}
 isort = "^5.12.0"
+{%- elif cookiecutter.code_formatter == 'ruff' %}
+ruff = "^0.12.2"


The linter group is empty when code_formatter is 'none'. However, the pre-commit configuration for this case includes isort and pyupgrade hooks (lines 36-44 in .pre-commit-config.yaml). For consistency, add an else clause to include these dependencies: isort = "^5.12.0" and pyupgrade = "^3.15.0".

Suggested change

ruff = "^0.12.2"

ruff = "^0.12.2"

{%- else %}

isort = "^5.12.0"

pyupgrade = "^3.15.0"

Copilot · 2026-01-27T23:41:43Z

{{cookiecutter.project_slug}}/pyproject.toml

+
+[tool.isort]{% if cookiecutter.code_formatter == 'black' %}
+profile = "black"{% else %}
+py_version = 310


The py_version setting should be a string, not an integer. Change py_version = 310 to py_version = "310" or use the more standard format py_version = "3.10".

Suggested change

py_version = 310

py_version = "3.10"

Copilot · 2026-01-27T23:41:43Z

{{cookiecutter.project_slug}}/pyproject.toml

+{%- if cookiecutter.code_formatter == 'ruff' %}
+
+[tool.ruff]
+line-length = 100
+src = ["src", "tests"]
+target-version = "py311"
+exclude = ["__init__.py"]
+extend-exclude = ["notebooks/*"]
+
+[tool.ruff.lint]
+select = [
+    "E",  # Pycodestyle errors
+    "F",  # Pyflakes errors
+    "UP", # pyupgrade checks
+    "B",  # Bugbear checks
+    "SIM",# Simplification checks
+    "I",  # Import order checks (isort)
+    "N"   # Naming convention checks
 ]
-test = ["pytest>=8.4.1", "pytest-cov>=6.2.1"]
+task-tags = ["TODO", "FIXME", "NOTE"]
+
+[tool.ruff.lint.isort]
+known-first-party = ["{{ cookiecutter.module_name }}"]
+
+[tool.ruff.lint.pycodestyle]
+max-line-length = 100
+
+[tool.ruff.lint.flake8-quotes]
+inline-quotes = "double"
+multiline-quotes = "double"
+docstring-quotes = "double"
+{%- endif %}


This Ruff configuration block is duplicated. The same configuration already exists at lines 46-77 for the Poetry section. Having duplicate configuration blocks will cause issues in the generated pyproject.toml file. Remove this duplicate block to avoid configuration conflicts.

Copilot · 2026-01-27T23:41:43Z

{{cookiecutter.project_slug}}/pyproject.toml

-{%- endif %}
 "isort>=5.12.0"
+{%- elif cookiecutter.code_formatter == 'ruff' %}
+"ruff>=0.12.2"


The linter dependency group is empty when code_formatter is 'none'. However, the pre-commit configuration for this case includes isort and pyupgrade hooks (lines 36-44 in .pre-commit-config.yaml). For consistency, the linter group should include these dependencies: "isort>=5.12.0" and "pyupgrade>=3.15.0".

Suggested change

"ruff>=0.12.2"

"ruff>=0.12.2"

{%- else %}

"isort>=5.12.0",

"pyupgrade>=3.15.0"

Copilot · 2026-01-27T23:41:43Z

{{cookiecutter.project_slug}}/.vscode__editor/settings.json

+  "ruff.lint.run": "onSave",
+  "ruff.format.args": ["--config=pyproject.toml"]


The --config=pyproject.toml argument is unnecessary. Ruff automatically discovers and uses pyproject.toml configuration from the project root. This explicit argument can be removed to simplify the configuration.

Suggested change

"ruff.lint.run": "onSave",

"ruff.format.args": ["--config=pyproject.toml"]

"ruff.lint.run": "onSave"

Copilot · 2026-01-27T23:41:44Z

{{cookiecutter.project_slug}}/pyproject.toml

+    "SIM",# Simplification checks
+    "I",  # Import order checks (isort)


Missing space after comma in inline comments. For consistency with Python and TOML formatting conventions, add a space after the comma: "SIM", # Simplification checks" and "I", # Import order checks".

Suggested change

"SIM",# Simplification checks

"I", # Import order checks (isort)

"SIM", # Simplification checks

"I", # Import order checks (isort)

Copilot · 2026-01-27T23:41:44Z

{{cookiecutter.project_slug}}/pyproject.toml

+    "UP", # pyupgrade checks
+    "B",  # Bugbear checks
+    "SIM",# Simplification checks


Missing space after comma in inline comments. For consistency with Python and TOML formatting conventions, add a space after the comma: "SIM", # Simplification checks" and "I", # Import order checks".

Suggested change

"UP", # pyupgrade checks

"B", # Bugbear checks

"SIM",# Simplification checks

"UP", # pyupgrade checks

"B", # Bugbear checks

"SIM", # Simplification checks

Copilot · 2026-01-27T23:41:44Z

{{cookiecutter.project_slug}}/.vscode__editor/settings.json

  "editor.defaultFormatter": "ms-python.python"
+  {% elif cookiecutter.code_formatter == 'ruff' %} // Use ruff as our linter and formatter
+  "[python]": {
+    "editor.formatOnSave": true,
+    "editor.codeActionsOnSave": {
+      "source.fixAll": "explicit",
+      "source.organizeImports": "explicit"
+    },
+    "editor.defaultFormatter": "charliermarsh.ruff"
+  },
+  "ruff.lint.run": "onSave",
+  "ruff.format.args": ["--config=pyproject.toml"]


Missing comma after the last property in each conditional block. When the template is rendered, the JSON object needs a comma after the last property before the closing brace of the root object. Add a comma at the end of line 17 for the black formatter case and at the end of line 28 for the ruff formatter case to create valid JSON.

add ruff into the template

4762dbc

ChrsBaur self-assigned this May 27, 2024

ChrsBaur added 7 commits May 31, 2024 11:08

pre-commit autoupdate

9a75db5

poetry update

7994cbe

add ruff

0888c4b

git merge origin/master

e3dde53

git merge origin/master

bb4d3cd

update dependencies and update ruff in pyproject.toml

f6b306b

Merge remote-tracking branch 'origin/master' into feature/adding-ruff

4a544b0

# Conflicts: # poetry.lock # {{cookiecutter.project_slug}}/environment-dev.yml # {{cookiecutter.project_slug}}/pyproject.toml # {{cookiecutter.project_slug}}/requirements-dev.txt

ChrsBaur force-pushed the feature/adding-ruff branch 2 times, most recently from 6533cb3 to 4a544b0 Compare December 23, 2025 19:55

ChrsBaur added 4 commits December 23, 2025 20:58

git merge origin/master

10c1306

fix: auto-format template files (pre-commit)

c1e2b75

Merge remote-tracking branch 'origin/master' into feature/adding-ruff

9371bdc

# Conflicts: # {{cookiecutter.project_slug}}/pyproject.toml # {{cookiecutter.project_slug}}/requirements-dev.txt

feat: integrate Ruff as a code formatter with full CI support

f8f1644

ChrsBaur marked this pull request as ready for review January 27, 2026 23:36

ChrsBaur requested a review from Copilot January 27, 2026 23:36

Copilot started reviewing on behalf of ChrsBaur January 27, 2026 23:36 View session

Copilot AI reviewed Jan 27, 2026

View reviewed changes

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Comments

Adding ruff into the template#129

Adding ruff into the template#129
ChrsBaur wants to merge 12 commits intomasterfrom
feature/adding-ruff

ChrsBaur commented May 27, 2024

Uh oh!

Copilot AI left a comment

Uh oh!

Copilot AI Jan 27, 2026

Uh oh!

Copilot AI Jan 27, 2026

Uh oh!

Copilot AI Jan 27, 2026

Uh oh!

Copilot AI Jan 27, 2026

Uh oh!

Copilot AI Jan 27, 2026

Uh oh!

Copilot AI Jan 27, 2026

Uh oh!

Copilot AI Jan 27, 2026

Uh oh!

Copilot AI Jan 27, 2026

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

1 participant

-"ruff>=0.12.2"
+"ruff>=0.12.2"
+{%- else %}
+"isort>=5.12.0",
+"pyupgrade>=3.15.0"

		"ruff.lint.run": "onSave",
		"ruff.format.args": ["--config=pyproject.toml"]

	"ruff.lint.run": "onSave",
	"ruff.format.args": ["--config=pyproject.toml"]
	"ruff.lint.run": "onSave"

		"SIM",# Simplification checks
		"I", # Import order checks (isort)

Comments

Conversation

ChrsBaur commented May 27, 2024

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull request overview

Reviewed changes

Uh oh!

Copilot AI Jan 27, 2026

Choose a reason for hiding this comment

Uh oh!

Copilot AI Jan 27, 2026

Choose a reason for hiding this comment

Uh oh!

Copilot AI Jan 27, 2026

Choose a reason for hiding this comment

Uh oh!

Copilot AI Jan 27, 2026

Choose a reason for hiding this comment

Uh oh!

Copilot AI Jan 27, 2026

Choose a reason for hiding this comment

Uh oh!

Copilot AI Jan 27, 2026

Choose a reason for hiding this comment

Uh oh!

Copilot AI Jan 27, 2026

Choose a reason for hiding this comment

Uh oh!

Copilot AI Jan 27, 2026

Choose a reason for hiding this comment

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

1 participant