Vim plugin: prefix messages with "Black: " (#3194)

As mentioned in GH-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.

diff --git a/CHANGES.md b/CHANGES.md
index 94c3bdda68e847d44bc6681e9f6562c1fb904a25..e027b2cae714deb9c04c8903fc309711dc888e55 100644 (file)
--- a/CHANGES.md
+++ b/CHANGES.md
@@ -46,6 +46,8 @@
 
 <!-- For example, Docker, GitHub Actions, pre-commit, editors -->
 
 
 <!-- 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 -->
 ### Output
 
 <!-- Changes to Black's terminal output and error messages -->

diff --git a/autoload/black.vim b/autoload/black.vim
index 6c381b431a36ebb0d03f6d7792b1efe4937652dd..ed657be7bd3aba5b311a798956d9c4a86db26daf 100644 (file)
--- a/autoload/black.vim
+++ b/autoload/black.vim
@@ -158,9 +158,9 @@ def Black(**kwargs):
     )
   except black.NothingChanged:
     if not quiet:
     )
   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:
   except Exception as exc:

-    print(exc)
+    print(f'Black: {exc}')

   else:
     current_buffer = vim.current.window.buffer
     cursors = []
   else:
     current_buffer = vim.current.window.buffer
     cursors = []


@@ -177,7 +177,7 @@ def Black(**kwargs):
       except vim.error:
         window.cursor = (len(window.buffer), 0)
     if not quiet:
       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("@%")
 
 def get_configs():
   filename = vim.eval("@%")