Use ruff for linting - Githubissues

jendrikseipp / vulture

Find dead Python code

MIT License

3.45k stars 152 forks source link

Use ruff for linting #347

Closed tqa236 closed 8 months ago

tqa236 commented 8 months ago

Description

Hello,

This MR configures ruff, an extremely fast Python linter and code formatter to vulture. ruff can potentially replace all the current linting and formatting tools, namely black, flake8 and pyupgrade.

The current config in pyproject.toml is the default one, I put it there for ease of your review and customization.

Let me know if this change is welcome. I can make further adjustments to the config to suit vulture style if needed.

Checklist:

[x] I have updated the documentation in the README.md file or my changes don't require an update.
[ ] I have added an entry in CHANGELOG.md.
[x] I have added or adapted tests to cover my changes.
[x] I have run tox -e fix-style to format my code and checked the result with tox -e style.

jendrikseipp commented 8 months ago

Thanks for the PR! I like the proposed changes. In addition, can you make sure that we enable the same ruff tests as were enabled previously via the other tools? And then remove the other tools?

tqa236 commented 8 months ago

Hi @jendrikseipp, this PR is ready for review.

There are a few things to consider:

ruff can replace all existing linting packages. I have configured it to the same rules and removed the redundant packages.
ruff can even replace black with as a main formatter (some big packages like pandas already migrated, ref). I can do this in the next PR if you think vulture can adopt this change. This is the documentation about the known deviations between ruff and black.
I keep the current tox -e style and tox -e fix-style as the main entry points for now, but they can also be replaced completely with pre-commit. I do that in the next PR if you're ok with the deprecations of these tox commands.

tqa236 commented 8 months ago

@jendrikseipp I updated the code according to your review. Can you take a look again, please? The list of patterns ignored by ruff now is a fuse of .gitignore and the one ignored by black.

Noted about the future improvement of ruff format and pre-commit, I can tackle them in follow-up PRs

jendrikseipp commented 8 months ago

Great, thanks!

In an upcoming PR, please add a changelog entry for this and the other planned changes. And feel free to add your name or nick to the changelog entry.