Add project pre-commit hooks

Question

Add project pre-commit hooks

Opened this issue 7 months ago · 1 comments

alkc commented 7 months ago

Add a pre-commit hook config to project. Useful to have linters for preventing new bugs in the auxiliary scripts.

Suggestions:

python: black, isort, flake8
perl: perltidy ?

Anything else?

nf-core recommends using https://prettier.io/ as a pre-commit hook. i'm not familiar with it at all.

Answer 1 · 2024-02-22T15:27:31.000Z

Prettier is only for styling. It is really nice when working with JS.

I am not sure I think it is a good idea to add it is a pre commit hook. It seems it could cause an extra layer of complications. Making it easily available to run in the repo would be great though (and something that could be in the PR checklist, or even better - automatically run when pushed to GitHub).

Would be happy to discuss though