ENH: Initial configuration to introduce pre-commit

[hjmjohnson]

Update SetupForDevelopment to setup pre-commit

Using a temporary repo to hold Kitware hooks with a configuration for
pre-commit. Replaces the system to clone the hook repo/branch into the
.git/hooks directory, which just using pre-commit.

This PR mirrors work from SimpleITK performed by
Bradley Lowekamp [email protected]

The pre-commit python virtual environment can be manually
loaded with: source .git/hooks/venv/bin/activate

which would allow using the pre-commit command prior to
doing an actual commit.

i.e.

source .git/hooks/venv/bin/activate
pre-commit run -a

PR Checklist

• No API changes were made (or the changes have been approved)
• No major design changes were made (or the changes have been approved)

Related to: #4238
Related to: #4565
Related to: #4244

[blowekamp]

I made an upstream pull request for Kitware's GitSetup to support precommit to avoid the code duplication:
https://gitlab.kitware.com/utils/gitsetup/-/issues/18#note_1499602
But it was rejected due to it being more python specific and not as generic and efficient as the shell system infrastructure.

Also in #4651 I started to use clang-format into pre-commit.

Sometimes with big rebases and commit the large number of recommit checks is slower, so perhaps there can be too many checks. However I have found the precommit file easier to maintain.

[hjmjohnson]

I made an upstream pull request for Kitware's GitSetup to support precommit to avoid the code duplication: https://gitlab.kitware.com/utils/gitsetup/-/issues/18#note_1499602 But it was rejected due to it being more python specific and not as generic and efficient as the shell system infrastructure.

Also in #4651 I started to use clang-format into pre-commit.

Sometimes with big rebases and commit the large number of recommit checks is slower, so perhaps there can be too many checks. However I have found the precommit file easier to maintain.

Pre-commit is tremendously easier to maintain. I don't think the performance concerns are that disruptive.

[jhlegarreta]

Thanks for doing this Hans.

Have not tried locally.

A few comments:

• Should this file be deleted?
  https://github.com/InsightSoftwareConsortium/ITK/blob/master/Utilities/GitSetup/setup-hooks

• Should these lines be removed:
  https://github.com/InsightSoftwareConsortium/ITK/blob/master/Utilities/GitSetup/config#L1-L2

• Not sure if I understand the passage "Using a temporary repo to hold Kitware hooks with a configuration for pre-commit.". Which is the temporary repository?

[blowekamp]

I made an upstream pull request for Kitware's GitSetup to support precommit to avoid the code duplication: https://gitlab.kitware.com/utils/gitsetup/-/issues/18#note_1499602 But it was rejected due to it being more python specific and not as generic and efficient as the shell system infrastructure.
Also in #4651 I started to use clang-format into pre-commit.
Sometimes with big rebases and commit the large number of recommit checks is slower, so perhaps there can be too many checks. However I have found the precommit file easier to maintain.

Pre-commit is tremendously easier to maintain. I don't think the performance concerns are that disruptive.

Yes, I agree it's likely worth the switch. Just need to consider ways to reduce code duplication etc.

[hjmjohnson]

@dzenanz @blowekamp This should be ready for final reviews now. I have it working on my Mac, and older testing that I think is the same, worked on windows and linux.

[dzenanz]

@N-Dekker Ahh, with this commit, we will not be required to "know" about existence of clang-format. Except for use in IDEs, such as Visual Studio 😄

[blowekamp]

I just encountered an issue with updating ThirdParty libraries and the precommit setup:

++ git commit --no-gpg-sign -n '--author=OpenJPEG Upstream <[email protected]>' '--date=2024-12-09 17:31:23 +0100' -F -
No .pre-commit-config.yaml file was found
- To temporarily silence this, run `PRE_COMMIT_ALLOW_NO_CONFIG=1 git ...`
- To permanently silence this, install pre-commit with the --allow-missing-config option
- To uninstall pre-commit run `pre-commit uninstall`