Code formatting, config

[hmpf]

So we're planning to run ruff check --fix on main and all branches. That means we need to settle on some code style things. (Docs for all ruff settings.)

Looking at the overview docs for ruff formatting config:

[tool.ruff]
line-length = 100

[tool.ruff.format]
quote-style = "single"
indent-style = "tab"
docstring-code-format = true

Defaults:

[tool.ruff]
line-length = 88

[tool.ruff.format]
quote-style = "double"
indent-style = "space"
indent-width = 4
docstring-code-format = false

Homework: read through the settings docs and see if there's more that would be nice to tweak away from the default.

[hmpf]

1. Let's keep it in pyproject.toml
2. indent-style should be "space", non-negotiable
3. Let's wait with choosing a docstyle-format, we're not good enough with adding docstrings as it is
4. I prefer single quotes if I have to choose, so quote-style = "single"
5. Line-length, I prefer shorter more than longer

[podliashanyk]

All sound good to me

[hmpf]

I'd like to turn off complaints about annotations, or at least set

[tool.ruff.lint.flake8-annotations]
allow-star-arg-any = true
ignore-fully-untyped = true
suppress-dummy-args = true
suppress-none-returning = true

[hmpf]

Here's more:

[tool.ruff.lint.flake8-unused-arguments]
ignore-variadic-names = true

[hmpf]

Should we sort imports? Lots of flags for that: Config for sorting imports

[podliashanyk]

Yes please

[podliashanyk]

Homework: read through the settings docs and see if there's more that would be nice to tweak away from the default.

1. Add exclude and/or respect-gitignore?

[tool.ruff]
exclude = [".venv"]
respect-gitignore = true