Introduce pre-commit hooks

[Radonirinaunimi]

My initial idea was to introduce pre-commit hooks to lint and format the python files, but then I stumbled upon #180 and decided to introduce some minimal hooks for Rust and all the other files.

The configuration is kept to be very minimal in order to only perform the most necessary steps before pushing commits.

Left to do:

• fixing pineappl_cli/src/plot.py

[felixhekhorn]

In eko we have cargo clippy but not cargo check - which one is better? will either fmt or clippy run check along the way?

[alecandido]

They are different: cargo check is essentially running the compiler, without generating code. cargo clippy is statically analyzing the code (i.e. the equivalent of Pylint).

There is a non-negligible change that cargo clippy is a superset of cargo check, but it's also possible that they only partially overlap. But this you can search for (or even try: run cargo clippy on something that cargo check was flagging, and see if it's complaining - even a missing ; or unmatched {).
The opposite is definitely impossible: cargo clippy may do strictly more, but certainly not strictly less.

[Radonirinaunimi]

They are different: cargo check is essentially running the compiler, without generating code. cargo clippy is statically analyzing the code (i.e. the equivalent of Pylint).

Yes, exactly. I did not include clippy before because it is very noisy but there is actually some ways to suppress warnings and only show errors.

[alecandido]

Well: that's certainly an option, but another one is just implementing its suggestions :P

[Radonirinaunimi]

Yes, I agree! I will address this soon #314 😉

[felixhekhorn]

In MaunaKea I also have clang-format https://github.com/felixhekhorn/MaunaKea/blob/d857a363719a9e6f579f156948b483e4cbde3976/.pre-commit-config.yaml#L13

I also have cpplint but that is maybe not installed by default, unlike clang-format which might be available on most systems ...

[felixhekhorn]

I like it if someone else is doing the trivial stuff for me 🙃

[alecandido]

I like it if someone else is doing the trivial stuff for me 🙃

If it's trivial, it would take no time to you as well :P

I.e. use the word trivial with a large amount of caution

[Radonirinaunimi]

It seems trivial indeed but I had to fight with python files which do not actually contain "python codes" (which in the end is time-consuming) 😇.

Btw, @cschwan, is there a reason why pineappl_cli/src/plot.py can't just be modified into plot.txt or something?

[felixhekhorn]

Btw, @cschwan, is there a reason why pineappl_cli/src/plot.py can't just be modified into plot.txt or something?

for sure we want the Python syntax highlight, because it is almost a Python file (so I'd prefer the .py).

However, I would much prefer making this a true Python script as discussed in #249 and split the static stuff in a true Python file and then all the dynamic stuff can either be inlined (in Rust) or could then go to a config_plot.py.txt

[cschwan]

I thought about improving the plot script, but it didn't go anywhere. You're welcome to try to improve it yourself. The only conditions for improving it are:

1. the only dependencies you can rely on are: numpy, matplotlib and the ones already provided by Python.
2. everything has to be in one self-contained file.