Add ruff format check in pre-commit hook and CI #660
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.
Description
I believe that we will fully format the code anyway, as it is necessary for the maintainability of the project.
This PR adds a CI to check whether the PR is correctly formatted.
It also adds a pre-commit hook to help users perform format check locally
I created a basic formatted configuration and simply modified the default line-length 和 quote-style
The only thing to note is that the ruff format will break our manual alignment of the dictionary，ruff format also doesn't support many customization options, but this seems to be a common issue with formatting tools, and black (a more mature formatter) has the same problem https:github.com/psf/black/issues/4281