Apply black code formatter to the python codebase
#286
Conversation
.pre-commit-config.yaml
Outdated
| # pre-commit's default_language_version, see | ||
| # https://pre-commit.com/#top_level-default_language_version | ||
| language_version: python3.8 | ||
| exclude: "python/gherkin/parser.py" |
There was a problem hiding this comment.
Ideally this is kept in the python folder.
youtux
force-pushed
the
python-use-black-style
branch
from
167c796
to
bec0869
Compare
youtux
force-pushed
the
python-use-black-style
branch
from
f6ecef7
to
02ce5bf
Compare
yes |
by running `pre-commit run --all-files` and reverting `parser.py`
youtux
force-pushed
the
python-use-black-style
branch
from
02ce5bf
to
f473cbe
Compare
|
I'm assuming the GitHub actions work will be in separate PR |
|
One thing to bare in mind (I'm doing the same in ruby), is some long methods in gherkin are written in a way that is almost language agnostic, so it reads the same in every language. |
| @@ -0,0 +1,9 @@ | |||
| # See https://pre-commit.com for more information | |||
| # See https://pre-commit.com/hooks.html for more hooks | |||
| repos: | |||
There was a problem hiding this comment.
Would it be possible to keep this whole file in the python folder?
Right now, if I have the pre-commit plugin installed, it looks like it will activate black regardless of whether or not I have python.
This poses a problem for contributors seeking to contribute to languages other than python, they may not have it installed.
There was a problem hiding this comment.
pre-commit installs hooks in a completely isolated environment that does not affect global packages. If other contributors don't touch the python folder, the black hook won't even run at all.
There was a problem hiding this comment.
I tried putting .pre-commit-config.yaml under the python directory, but it won't allow any other .pre-commit-config.yaml to be used if anyone decides to have one under java/ or any other folder.
Seems like a limitation of pre-commit.
So the only way is to keep it on the root dir, and explicitly whitelist the dirs that each hook should handle.
not sure how this applies in this PR @luke-hill |
🤔 What's changed?
blackcode formatter to the python codebase, to enforce a standard formatting.pre-commit-config.yamlto the project, so that we can enforce this conventionadd github action to check the pre-commit hooks have been appliedWill add pre-commit.ci app once this lands⚡️ What's your motivation?
The python codebase does not really use a standard formatting, this is arguably widely accepted as "annoying".
🏷️ What kind of change is this?
♻️ Anything particular you want feedback on?
📋 Checklist:
This text was originally generated from a template, then edited by hand. You can modify the template here.