AM - 542: Add custom pre-commit hook #138
Merged
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
Signed-off-by: Karanjot Singh <drquark@duck.com>
cmgrote
reviewed
Oct 4, 2023
|
@ErnestoLoma thoughts? 🙏 |
ErnestoLoma
requested changes
Oct 4, 2023
Signed-off-by: Karanjot Singh <drquark@duck.com>
ErnestoLoma
approved these changes
Oct 5, 2023
Signed-off-by: Karanjot Singh <drquark@duck.com>
This reverts commit 88f33cf.
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.
The problem is that when we run the pre-commit script and there's some reformatting needed, we have to run it and stage the changes repeatedly. I've found a simpler solution: I created a special pre-commit hook in the
.git/hooks/folder. This hook checks for changes and keeps running the pre-commit script until all the necessary reformatting is finished.To use this updated pre-commit hook script, you can create a symbolic link to it in your local .git/hooks directory using this command:
ln -s ../../.git-hooks/pre-commit .git/hooks/pre-commit.I'm also sharing an example of how to use this hook in action:
P.S. I added
autoflaketo the pre-commit-config.yaml file to handleimported but unusederrors that come up when running theclass_generator. Autoflake automatically removes these unnecessary imports (Also might be the reason that it removed the unnecessarypassstatement)Let me know what you think of this solution.