ci: set up lint job using pre-commit/action

[afuetterer]

This is also in preparation of replacing flake8 and black with ruff (#232).

There are a few issues with the code base regarding its own pre-commit config.

black and the end-of-file-fixer want to fix a few files.

Should these changes be a separate PR?

[MaartenGr]

I'm alright with handling that in this PR since it's not that big yet but since it's your PR, you can choose!

[afuetterer]

If you are alright with having one commit in the repository with failed CI, I suggest merging this PR and having another PR to handle the lint issues. That way, you can ignore the commit as suggested in bertopic by @freddyheppell.

[freddyheppell]

I think it would potentially be easier to enable the precommit CI and switch to Ruff all in this PR. Although Ruff and Black/Flake8 will theoretically have quite similar standards, they won't be precisely the same, so I don't see the point of fixing before switching to Ruff.

Also, the blame ignore thing isn't absolute. It will still attribute changes to an ignored commit if the code was genuinely introduced by that commit (e.g. the lint workflow I added to BERTopic will still be attributed to that commit, as there is no alternative). So it's fine to do it all in one PR.

[afuetterer]

I used the same config settings as in Bertopic to achieve similar results.

[afuetterer]

Could you insert the descriptions in the docstrings @MaartenGr? You know best what these parameters are supposed to be.

[MaartenGr]

Added suggestions to the TODO docstrings which you can choose to add directly or adjust accordingly if they are not descriptive enough.

[afuetterer]

If it is alright with you, this can be squashed and merged.

[MaartenGr]

@afuetterer Awesome, thank you for the work on this. It is greatly appreciated 😄