python-cookiecutter/ruff.toml at 9aad8ed6b3b6bc1ce7dd12e26f92cb5cd25e96dd · par-tec/python-cookiecutter · 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
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
# ===================================================================================
# HEY! Are you using `ruff` for the first time in a hundreds years old project?
# USE `ruff --add-noqa` to automatically add `noqa` directives where they are needed!
# See: https://docs.astral.sh/ruff/linter/#inserting-necessary-suppression-comments
# ===================================================================================

# Exclude a variety of commonly ignored directories.
exclude = [
    ".bzr",
    ".direnv",
    ".eggs",
    ".git",
    ".git-rewrite",
    ".hg",
    ".ipynb_checkpoints",
    ".mypy_cache",
    ".nox",
    ".pants.d",
    ".pyenv",
    ".pytest_cache",
    ".pytype",
    ".ruff_cache",
    ".svn",
    ".tox",
    ".venv",
    ".vscode",
    "__pypackages__",
    "_build",
    "buck-out",
    "build",
    "dist",
    "node_modules",
    "site-packages",
    "venv",
]

# Same as Black.
line-length = 88
indent-width = 4

show-fixes = true

[lint]
select = ["ALL"]

ignore = [
    # Some rules are ignored to not conflict with formatter.
    #   See: https://docs.astral.sh/ruff/formatter/#conflicting-lint-rules
    "W191", "E111", "E114","E117", "D206","D300", "Q000", "Q001", "Q002",
    "Q003", "COM812", "COM819",
    "D203", # conflicts with "D211"
    "D213", # conflicts with "D212"
]

[lint.per-file-ignores]
"__init__.py" = ["E402"]
"**/{tests,docs,tools}/*" = ["E402"]
"**/tests/*" = ["S101"]

[format]
# Like Black, use double quotes for strings.
quote-style = "double"

# Like Black, indent with spaces, rather than tabs.
indent-style = "space"

# Like Black, respect magic trailing commas.
skip-magic-trailing-comma = false

# Like Black, automatically detect the appropriate line ending.
line-ending = "auto"

# Enable auto-formatting of code examples in docstrings. Markdown,
# reStructuredText code/literal blocks and doctests are all supported.
#
# This is currently disabled by default, but it is planned for this
# to be opt-out in the future.
docstring-code-format = false

# Set the line length limit used when formatting code snippets in
# docstrings.
#
# This only has an effect when the `docstring-code-format` setting is
# enabled.
docstring-code-line-length = "dynamic"