[Code Style] [merge after #565] add pre-commit tool #566
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
…gnore to be compatible with CLion IDE.
… for C++. Cancel YAML formatter because its bad behavior.
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.
What is this
This PR introduces a plugin, pre-commit, which can check coding styles and format the code automatically.
Details
To install, please read doc in ./docs folder. In general, there are only two commands needed to be executed.
pip3 install pre-commit pre-commit installThen this plugin will automatically triggered before each commit. I have included several check items inside the .pre-commit-config.yaml. Now I use black to format Python code and clang to format C++.
If the commit cannot pass the check, just run commit again. The plugin will format the code automatically and then the second commit will pass.
The C++ code style follows ROS guidance: http://wiki.ros.org/CppStyleGuide.