Conversation
pmeier
left a comment
There was a problem hiding this comment.
I think the configuration is sufficient, but if you can have a look at the other configuration options.
|
Ping @jreese. |
|
Does this allow other projects to configure support for ufmt via pre-commit? I'm not very familiar with how that works. |
|
Yes. If we have this config in the repository, other repositories can put repos:
- repo: https://github.com/omnilib/ufmt
rev: 1.3.0
hooks:
- id: ufmtIf you now run |
|
I'm confused: I've removed the backticks, but the RTD build is still showing them. Do I need to run something manually for the md -> rst conversion? Edit: something probably gone wrong, but now RTD is showing the correct result. |
As the name implies,
pre-commitis a framework for running programs before a commit is performed. Especially for code formatters likeusortthey are really handy, because you actually want to run them before every commit. After the installation you don't need to worry about forgetting to format your code ever again and CI being the next instance to tell you that something is up.Fortunately, the only thing that needs to added to enable
ufmtas apre-commithook is a minimal configuration file.ToDo:
add a test workflow to make sure the hook can be installed and executed correctly(I no longer think this is needed, since we will rarely change the hook itself).