Introduce pre-commit hooks (ruff + clang-format) - #239
Open
jonasleitner wants to merge 12 commits into
Open
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
This PR sets up
pre-commitfor automatic linting and formatting usingruff(python) andclang-format(C++) and applies the hook to the code base. Therefore most of the changes introduced were automatically generated byrufforclang-format.Configuration
ruffdefault 88) are often a bit short. This choice also decreased the number ofrufferrors requiring manual fixes (see below).ruffare not configured and thus the default set of rules is applied, which might change in futureruffversions.ruffandclang-formatversions are pinned in thepre-commitconfiguration. They can be updated by runningpre-commit autoupdate, which should be done every now and then. Note that every version update will probably require a (hopefully smaller!) PR similar to this one to apply the new rules and reformat the code base.pre-commithook.While this PR contains mostly changes introduced by
ruffandclang-format, a few commits involved manual changes:pre-commithook and its incorporation in the CI.rufferrors (mostly shebangs in non-executable files).fmt: skipcomments to avoid the reformatting of already nicely formatted equations. Probably I missed some places here...