Define a pre-commit hook

[wjt]

Currently, our project uses godot-gdscript-toolkit via pre-commit. We have a block like the following in .pre-commit-config.yaml in our repository:

repos:
- repo: https://github.com/Scony/godot-gdscript-toolkit
  rev: 4.3.4
  hooks:
  - id: gdformat
  - id: gdlint

and pre-commit takes care of installing the necessary tools and running them whenever one commits.

The way this works is that https://github.com/Scony/godot-gdscript-toolkit/ contains a .pre-commit-hooks.yaml file which defines the available tools and how to install them. pre-commit has specific support for python modules as hooks.

It also has support for rust hooks but this works by installing them with cargo. I was curious how this is done for ruff, which is a formatter for Python code written in Rust. To my slight surprise https://github.com/astral-sh/ruff-pre-commit defines a Python (not Rust!) module, which depends on the ruff Python package – which is of course a Rust program in a Python's clothing. And because they publish binary wheels for all major platforms, this means you can install ruff without having a Rust compiler...

There's also a system hook type which just relies on the relevant command being installed on the system. That might be OK as a starting point.

[NathanLovato]

It sounds good to me, I'm all for these kinds of additions. Just to be transparent, I'm looking to leave some tasks to contributors, in particular, everything that has to do with customization and support for individual workflows. I'll stay active as a maintainer to get these kinds of contributions merged of course. But I maintain dozens of repositories on top of work so I have to draw a line regarding the workload I take on myself, as I'm sure you'll understand.

[wjt]

Absolutely! If it had been trivial, I would have just proposed a PR. But since it's not immediately obvious what the best way to do it is, I wanted to start by seeing if it's in scope.

[NathanLovato]

If this helps, I would recommend either going with Python first which comes pre-installed on lots of developer workstations or the system version assuming that Unix tools are available to start with if you happen to be working on MacOS or Linux.

Then as part of the hook, you can check if the formatter is available with test and otherwise use the wget program or CURL to download it. There are certainly ways to make it work with the tools that ship by default on windows, linux, and macos.

In any case I'd say it's fine to start with a hook that supports your team's work platform, and people can expand that later to support other platforms that they use if they want to.

[wjt]

Python is guaranteed to be available because pre-commit is written in Python.

[wjt]

I guess we can close this thread in favour of the issue you opened:

• Add a pre-commit hook to easily install and use the formatter as a commit hook #141