CI: add pre-commit.ci to apply clang-format and clang-tidy fixes #4225
Conversation
This file contains 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
ABACUS uses some functions with a long function name and a long parameter list. Current setup will generates ugly parameter list with each parameters indented by many spaces. Plus, it is unable to use a customized layout for e.g. putting x, y, and z value in the same line. After discussion, we agree to disable those settings, leaving developers free to chose their own flavor.
dyzheng
reviewed
May 29, 2024
dyzheng
approved these changes
May 29, 2024
@dyzheng As I've mentioned, one can change the check rules if current rules mismatch their requirements. It is possible to polish the rules iteratively. |
|
Great job! I need to check every rule in the clang-format and clang-tidy before merging this PR. |
caic99
commented
Jun 11, 2024
mohanchen
approved these changes
Jun 13, 2024
This was referenced Jun 14, 2024
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.
Linked Issue
Fix #3915
What's changed?
This PR add the CI test static checks using
clang-formatandclang-tidy. It uses pre-commit.ci to orchestrate the checks and submit patches. On new commits pushing, it will try to fix the code smells in changed files.For example, a developer modified the code without caring indentations in c17732b. The commit triggered workflow runs, and pre-commit.ci submited a patch for it in 039d5a0.
This PR also updates the config files used by those tools. Please submit an issue if the suggested changes by those rules does not fit the circumstance well.