Skip to content

Commit

Permalink
Vim plugin: prefix messages with "Black: " (psf#3194)
Browse files Browse the repository at this point in the history
As mentioned in psfGH-3185, when using Black as a Vim plugin, especially
automatically on save, the plugin's messages can be confusing, as
nothing indicates that they come from Black.
  • Loading branch information
tobast authored and cibinmathew committed Aug 13, 2022
1 parent 3164cc8 commit 0e07333
Show file tree
Hide file tree
Showing 2 changed files with 5 additions and 3 deletions.
2 changes: 2 additions & 0 deletions CHANGES.md
Expand Up @@ -46,6 +46,8 @@

<!-- For example, Docker, GitHub Actions, pre-commit, editors -->

- Vim plugin: prefix messages with `Black: ` so it's clear they come from Black (#3194)

### Output

<!-- Changes to Black's terminal output and error messages -->
Expand Down
6 changes: 3 additions & 3 deletions autoload/black.vim
Expand Up @@ -158,9 +158,9 @@ def Black(**kwargs):
)
except black.NothingChanged:
if not quiet:
print(f'Already well formatted, good job. (took {time.time() - start:.4f}s)')
print(f'Black: already well formatted, good job. (took {time.time() - start:.4f}s)')
except Exception as exc:
print(exc)
print(f'Black: {exc}')
else:
current_buffer = vim.current.window.buffer
cursors = []
Expand All @@ -177,7 +177,7 @@ def Black(**kwargs):
except vim.error:
window.cursor = (len(window.buffer), 0)
if not quiet:
print(f'Reformatted in {time.time() - start:.4f}s.')
print(f'Black: reformatted in {time.time() - start:.4f}s.')

def get_configs():
filename = vim.eval("@%")
Expand Down

0 comments on commit 0e07333

Please sign in to comment.