Improve tool configuration and usability #586
Comments
We run pydocstyle on the project at pydocstyle/src/tests/test_integration.py Line 182 in 50894da
|
While I am in favor of some of these changes, others will likely either cause problems with tests or unnecessarily large diffs:
If we really want an easy and short version to run commands with different scopes from the terminal, we can add targets to the Makefile. We would have |
But that specifies its own configuration, right? I have just checked and we could simply run pydocstyle via its CLI as part of the tox pipeline. |
@aphedges Fair points. That leaves:
|
@Mr-Pepe, it looks like different configuration is being used in |
#584 started a little discussion on where to put tool configurations (for mypy, pytest, etc).
I would like to propose the following steps to improve the pipeline:
mypy
The mypy configuration has already been moved to
pyproject.toml
in #584.mypy src/
tomypy .
intox.ini
(this currently leads to two easy to fix issues)pytest
[pytest]
section fromtox.ini
to a[tool.pytest]
section inpyproject.toml
--cache-clear
and-vv
to the[tool.pytest]
section ofpyproject.toml
and remove them as command line arguments intox.ini
src/tests
totests
and changepytest src/tests {posargs}
topytest {posargs}
intox.ini
pydocstyle
[py257]
section fromtox.ini
to a[tool.pydocstyle]
section inpyproject.toml
Where is this configuration used in the pipeline? I don't see pydocstyle being invoked anywhere.
black
black --check src/pydocstyle
toblack --check .
intox.ini
isort
isort --check src/pydocstyle
toisort --check .
intox.ini
The aforementioned changes allow simply running
pytest
,mypy .
,black .
andisort .
in the project folder. Furthermore, the changes facilitate setting up these tools in an IDE (e.g., format on save in VS Code) without having to specify any options.The text was updated successfully, but these errors were encountered: