docstring-linter/pyproject.toml at develop · bastgau/docstring-linter · 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
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
[project]
name = "docstring-linter"
version = "0.1.0"
description = "Python linter that checks docstring conformance to Google style."
readme = "README.md"
requires-python = ">=3.14,<3.15"
authors = [
    {name = "Bastien Gautier", email = "contact@bastiengautier.com"}
]
license = {text = "MIT"}
keywords = ["docstring", "linter", "google-style"]
classifiers = [
    "Development Status :: 3 - Alpha",
    "Intended Audience :: Developers",
    "License :: OSI Approved :: MIT License",
    "Programming Language :: Python :: 3.14",
    "Topic :: Software Development :: Libraries :: Python Modules",
    "Topic :: Software Development :: Quality Assurance",
]
dependencies = [
]

[project.urls]
Homepage = "https://github.com/bastgau/docstring-linter"
Repository = "https://github.com/bastgau/docstring-linter.git"
Documentation = "https://github.com/bastgau/docstring-linter#readme"
Issues = "https://github.com/bastgau/docstring-linter/issues"

[tool.docstring-linter]
select = ["ALL"]

[[tool.docstring-linter.overrides]]
ignore=[
  "imperative_mood"
]
paths = ["tests/**"]
args_section="forbidden"
returns_section="forbidden"
yields_section="forbidden"
raises_section="forbidden"
attributes_section="forbidden"
description_section="optional"
examples_section="forbidden"
notes_section="forbidden"
todo_section="forbidden"
blank_lines_before_closing_quotes=0
summary_max_length=120

[[tool.docstring-linter.overrides]]
paths = [
    "src/**",
    "tests/linter/rules/conftest.py"
]

[tool.pytest.ini_options]
testpaths = ["tests"]
pythonpath = ["src"]
addopts = "--cov --cov-branch --cov-report=term-missing --cov-report=xml"

[tool.coverage.run]
source = ["src"]

[tool.coverage.report]
omit = ["tests/*", "example/*"]
fail_under = 85

[tool.ruff]
target-version = "py314"
line-length = 200
src = ["src/linter", "tests"]
exclude = [".vulture"]

[tool.ruff.lint]
select = ["ALL"]
ignore = [
    "D203",   # en conflit avec D211 (on garde D211 : blank-line-before-class)
    "D213",   # en conflit avec D212 (on garde D212 : multi-line-summary-first-line)
    "COM812", # missing-trailing-comma
]

[tool.ruff.lint.per-file-ignores]
"tests/**/*.py" = ["S101", "D104", "PLR2004"] # assert authorized in unit tests
"src/linter/cli.py" = ["T201"] # `print` found
"src/linter/reporter.py" = ["T201"] # `print` found
"src/linter/models.py" = ["PIE807"]

[tool.ruff.format]
quote-style = "double"
indent-style = "space"

[tool.pylint.main]
ignore-paths = []

[tool.pylint.format]
max-line-length = 200
max-module-lines = 1100

[tool.pylint.messages_control]
disable = [
"R0903" # too-few-public-methods
]

[tool.pylint.similarities]
min-similarity-lines = 6 # Default: 4. Minimum lines to trigger duplication.
ignore-comments = true
ignore-docstrings = true
ignore-imports = true
ignore-signatures = true

[tool.uv]
package = true
required-version = ">=0.11.24"

[project.scripts]
docstring-linter = "linter.cli:main"

[dependency-groups]
dev = [
    "prek>=0.4.5",
    "pylint>=4.0.6",
    "pyright>=1.1.411",
    "pytest-cov>=7.1.0",
    "pytest>=9.1.1",
    "ruff>=0.15.20",
    "shellcheck-py>=0.10.0",
    "vulture>=2.16",
]

github-src = [
    "prek>=0.4.5",
    "pylint>=4.0.6",
    "pyright>=1.1.411",
    "ruff>=0.15.20",
    "shellcheck-py>=0.10.0",
]

github-tests = [
    "prek>=0.4.5",
    "pylint>=4.0.6",
    "pytest-cov>=7.1.0",
    "pytest>=9.1.1",
    "ruff>=0.15.20",
    "vulture>=2.16",
]

[tool.sqlfluff.core]
dialect = "mariadb"
templater = "jinja"
sql_file_exts = ".sql,.sql.j2,.dml,.ddl"
max_line_length = 200

[tool.sqlfluff.indentation]
indented_joins = false
indented_using_on = true
template_blocks_indent = false