Pre-commit hook

[gdalle]

Would it be possible to define a pre-commit hook for Aqua?

Other similar packages have done it:

• JuliaFormatter (https://domluna.github.io/JuliaFormatter.jl/stable/integrations/#pre-commit)
• Runic (https://github.com/fredrikekre/Runic.jl?tab=readme-ov-file#git-hooks)
• ExplicitImports (https://github.com/JuliaTesting/ExplicitImports.jl?tab=readme-ov-file#pre-commit-hooks)

[jonas-schulze]

I think we should find a proper solution to pre-commit/pre-commit#3497 first. 😕

[jonas-schulze]

For the time being, I would recommend that we pursue the Runic approach with one difference. While runic-pre-commit is versioned independently from Runic, I recommend that the (yet to be created) project aqua-pre-commit has releases matching the one's of Aqua. This way, users can use pre-commit autoupdate on smth like this:

repos:
  - repo: https://github.com/JuliaTesting/aqua-pre-commit # yet to be created
    rev: v0.8.14
    hooks:
      - id: aqua

and don't have to maintain additional_dependencies:

repos:
  - repo: https://github.com/JuliaTesting/aqua-pre-commit
    rev: v1.0.0 # versioned independently
    hooks:
      - id: aqua
        additional_dependencies:
          - Aqua@0.8.14 # most likely not managed by `pre-commit autoupdate`

To automate the version update, option 1 is that everything is handled by Aqua's CI. That is, whenever a new version of Aqua is released, Aqua's CI should update the [compat] entry in aqua-pre-commit/Project.toml to match Aqua's version exactly, and release a new version of aqua-pre-commit. Option 2 would be that aqua-pre-commit's CI polls the latest release of Aqua.jl on a weekly basis (or so) and updates itself.