pythonic-structures/ruff.toml at main · NavneetSinghArora/pythonic-structures · GitHub

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
# Set target python version
target-version = "py314"

# Set the maximum line length to 180 characters
line-length = 120

# Ignore the files / paths in .gitignore
respect-gitignore = true

# Set the indentation width to 4 spaces
indent-width = 4

[lint]
# Enable pycodestyle (E), Pyflakes (F) and isort (I)
select = ["E", "F", "I"]


# Extending the rules
extend-select = [
    "UP",  # pyupgrade: shows code deprecation warnings and suggestions
    "D",   # pydocstyle: shows docstring errors
    "ANN", # flake8-annotations (Strict Typing)
]

# Ignore ANN002: Missing type annotation for `*args`
# Ignore ANN003: Missing type annotation for `**kwargs`
# Ignore D104: Missing docstring in public package (__init__.py)
ignore = ["ANN002", "ANN003", "D104"]

# Enabling google docstring convention
[lint.pydocstyle]
convention = "google"

[format]
# Prefer double quotes over single quotes.
quote-style = "double"
# Enable magic trailing comma for better multiline formatting.
skip-magic-trailing-comma = false
# Enable reformatting of code snippets in docstrings.
docstring-code-format = true
# Format all docstring code snippets with a line length of 60.
docstring-code-line-length = 60

# Sorting the imports
[lint.isort]
# Combine as imports
combine-as-imports = true
# Force wrap aliases
force-wrap-aliases = true
# Shorter imports appear first followed by longer imports
length-sort = true

[lint.flake8-annotations]
allow-star-arg-any = true
# ignore-fully-untyped = true