Add --check option #278
Add --check option #278
Conversation
README.rst
Outdated
| @@ -118,6 +118,7 @@ It also has the below extra options: | |||
|
|
|||
| * ``-E`` / ``--skip-errors`` - Don’t exit non-zero for errors from Black (normally syntax errors). | |||
| * ``--rst-literal-blocks`` - Also format literal blocks in reStructuredText files (more below). | |||
| * ``--check`` - [Similar behaviour to Black's check flag.](https://black.readthedocs.io/en/stable/usage_and_configuration/the_basics.html#check) | |||
There was a problem hiding this comment.
Please write a description of the option rather than just link and say "it's like that". The link is still useful though, but don’t link a whole sentence, just a couple words.
Also alphabetize by moving to line 119.
There was a problem hiding this comment.
Should be fixed in f01c5ab
Do tell me if you're unhappy with the phrasing.
src/blacken_docs/__init__.py
Outdated
| return 0 | ||
| if check_only: | ||
| print(f"Error: Would have been re-written - {filename}") |
There was a problem hiding this comment.
Let’s match the formatting of the existing message.
| print(f"Error: Would have been re-written - {filename}") | |
| print(f"{filename}: Would rewrite.") |
There was a problem hiding this comment.
Done in: f01c5ab
I did use a different error message:
print(f"{filename}: Requires a rewrite.")I feel like it reads better; but if you're unhappy I can always just do the one you suggest.
|
Sorry for the delay; was on holiday. I also added the tests and the changelog. From context I think that the changelog requires a version bump; I did so in the setup.cfg but do warn me if I've done it wrong. |
|
Dear @adamchainz, Anything else you'd like to see before merging? Sorry to be a bother; but since it's been a while so I decided to ping |
There was a problem hiding this comment.
Anything else you'd like to see before merging?
You should rollback the version number bump and remove the release date and version from the changelog (and also bring back the bitwise operator if the usage of max is not required)
I can't commit, but it will be easier to merge once it's done.
Thanks
setup.cfg
Outdated
| @@ -1,6 +1,6 @@ | |||
| [metadata] | |||
| name = blacken_docs | |||
| version = 1.16.0 | |||
| version = 1.17.0 | |||
There was a problem hiding this comment.
This change is usually decided by the release manager depending on the changelog at release time: see example
CHANGELOG.rst
Outdated
| 1.17.0 (2023-09-11) | ||
| ------------------- |
There was a problem hiding this comment.
It seems this line is added at release time usually (visible on this release PR)
| 1.17.0 (2023-09-11) | |
| ------------------- |
✨ New argument: --check
As the name indicates this will merely check if the code would have
been re-written.
A further change is that the return value of blacken-docs is now the
largest error for each file. Previously if file 2 failed with an error
but file 1 would be re-written then the exit code would have been 1 as
opposed to the more severe 2.
Closes #277