bundesAPI / deutschland

Die wichtigsten APIs Deutschlands in einem Python Paket.
Apache License 2.0
1.23k stars 67 forks source link

Add ruff as a linter in pre-commit #106

Open baniasbaabe opened 1 year ago

baniasbaabe commented 1 year ago

I noticed there is no linter. ruff is a great option to use.

OtenMoten commented 1 year ago

First, let's talk about Linter and Ruff.

A linter, in the context of programming, is a tool that analyzes source code to flag programming errors, bugs, stylistic errors, and suspicious constructs. The term originates from a Unix utility that examined C language source code.

In Python, linters are used to enforce a consistent coding style and to catch certain types of errors before the code is even run. Using a linter can help to identify syntax errors, structural problems, code smells, and even more complex issues such as detecting unused variables or imports.

The most modern Linter in context of Python is Ruff.

wirthual commented 1 year ago

Great idea, what config is needed so it plays nicely with isort and black? Does it replace one or the other?

wirthual commented 1 year ago

From a quick look it seems like it should just work:

Ruff and Black: https://beta.ruff.rs/docs/faq/#is-ruff-compatible-with-black Ruff and Isort: https://beta.ruff.rs/docs/faq/#how-does-ruffs-import-sorting-compare-to-isort

christoph-teichmeister commented 8 months ago

You could also entirely replace black with ruff. We've done that multiple times and, subjectively, results stayed the same

LilithWittmann commented 8 months ago

Isn't black basically doing the job of an opinionated linter already for us? But in a style thats encouraged by the psf?

christoph-teichmeister commented 8 months ago

Isn't black basically doing the job of an opinionated linter already for us? But in a style thats encouraged by the psf?

I'm not sure that ruff can not be configured to mimic black-formatter behaviour - so you'd keep the style encouraged by the psf!

On top of that, I think the main advantages are, that it comes with so much more than just formatting (black and isort).

Configured correctly, it can, among much more, inform you on upgrade-compitability - one of my personal favourites.

BobMcFry commented 8 months ago

As of version 0.1.2 ruff also comes with a formatter that should serve as a drop-in replacement for black. In our company, we have gotten rid of black and isort and just use ruff now as it reduces dependencies and also the pain of having compatibility issues between these tools (import sorting usually gets conflicts). There are rare differences between black and ruff formatting, but these were neglegible in the cases I encountered.