MNT: Switch from flake8 to ruff for linting

[brendan-ward]

Resolves #341

Similar to changes in GeoPandas #2921 but without needing to configure additional rules.

[martinfleis]

Thanks! We could potentially also consider switching from black to ruff-format. I am using it in some other projects and the transition was flawless.

[brendan-ward]

Switched to ruff-format and removed unnecessary # noqa statements.

[theroggy]

Maybe add ruff as dependency in environment-dev.yml?

[jorisvandenbossche]

Should we put the formatter first? (eg I can imagine that the linter complains about a too long line, which would already be solved by the formatter afterwards)

[brendan-ward]

Sure; was just following the example.

I'm assuming we don't want to auto-fix lint errors, which is where putting the linter first is recommended.

[jorisvandenbossche]

Maybe add ruff as dependency in environment-dev.yml?

pre-commit is included, and then the idea is that you install the pre-commit, which will handle getting ruff (that's also how it went for black and flake8, which aren't included in the yml)

Of course if you don't use pre-commit and want to run ruff manually, you also need it in your env.

[theroggy]

Maybe add ruff as dependency in environment-dev.yml?

pre-commit is included, and then the idea is that you install the pre-commit, which will handle getting ruff (that's also how it went for black and flake8, which aren't included in the yml)

Of course if you don't use pre-commit and want to run ruff manually, you also need it in your env.

I personally use visual studio code and then it is convenient that formatter and linter are installed so the formatting is automatically applied and linting errors are shown in the UI. Once you commit pre-commit will check this as well... but this is later in the process.

But, if this is rather typical for my workflow, no problem not to include it... not problem to install it myself...

[brendan-ward]

Given that we had black in the environment-dev.yml (and I removed here), I have no issues with adding ruff as a development dependency. For vscode, I've been using the ruff extension, which I believe ships with its own install of ruff that would be used to highlight things in the vscode UI.

[jorisvandenbossche]

I don't mind ruff being there in the dev env file (I don't use that anyway, I have a "geo-dev" env that I use for geopandas etc as well), but just a note for those using it: you might have to take care in ensuring the same ruff version is used as in the pre-commit, otherwise you might still get lint failures on CI.