]> git.madduck.net Git - etc/vim.git/blobdiff - plugin/black.vim

madduck's git repository

Every one of the projects in this repository is available at the canonical URL git://git.madduck.net/madduck/pub/<projectpath> — see each project's metadata for the exact URL.

All patches and comments are welcome. Please squash your changes to logical commits before using git-format-patch and git-send-email to patches@git.madduck.net. If you'd read over the Git project's submission guidelines and adhered to them, I'd be especially grateful.

SSH access, as well as push access can be individually arranged.

If you use my repositories frequently, consider adding the following snippet to ~/.gitconfig and using the third clone URL listed for each project:

[url "git://git.madduck.net/madduck/"]
  insteadOf = madduck:

Add .svn to default exclusion list (#965)
[etc/vim.git] / plugin / black.vim
index 9cf5f2dc69bb9fa8261a941591c04362a9058e5a..29b2992448739aa9fe4d2ed2e6960244ee69882f 100644 (file)
@@ -2,7 +2,7 @@
 " Author: Łukasz Langa
 " Created: Mon Mar 26 23:27:53 2018 -0700
 " Requires: Vim Ver7.0+
-" Version:  1.0
+" Version:  1.1
 "
 " Documentation:
 "   This plugin formats Python files.
@@ -10,6 +10,8 @@
 " History:
 "  1.0:
 "    - initial version
+"  1.1:
+"    - restore cursor/window position after formatting
 
 if v:version < 700 || !has('python3')
     echo "This script requires vim7.0+ with Python 3.6 support."
@@ -30,12 +32,22 @@ endif
 if !exists("g:black_linelength")
   let g:black_linelength = 88
 endif
+if !exists("g:black_skip_string_normalization")
+  let g:black_skip_string_normalization = 0
+endif
 
 python3 << endpython3
+import os
 import sys
 import vim
 
 def _get_python_binary(exec_prefix):
+  try:
+    default = vim.eval("g:pymode_python").strip()
+  except vim.error:
+    default = ""
+  if default and os.path.exists(default):
+    return default
   if sys.platform[:3] == "win":
     return exec_prefix / 'python.exe'
   return exec_prefix / 'bin' / 'python3'
@@ -78,7 +90,7 @@ def _initialize_black_env(upgrade=False):
   if upgrade:
     print('Upgrading Black with pip...')
   if first_install or upgrade:
-    subprocess.run([str(_get_pip(virtualenv_path)), 'install', '-U', 'black'])
+    subprocess.run([str(_get_pip(virtualenv_path)), 'install', '-U', 'black'], stdout=subprocess.PIPE)
     print('DONE! You are all set, thanks for waiting ✨ 🍰 ✨')
   if first_install:
     print('Pro-tip: to upgrade Black in the future, use the :BlackUpgrade command and restart Vim.\n')
@@ -93,16 +105,49 @@ if _initialize_black_env():
 def Black():
   start = time.time()
   fast = bool(int(vim.eval("g:black_fast")))
-  line_length = int(vim.eval("g:black_linelength"))
-  buffer_str = '\n'.join(vim.current.buffer) + '\n'
+  mode = black.FileMode(
+    line_length=int(vim.eval("g:black_linelength")),
+    string_normalization=not bool(int(vim.eval("g:black_skip_string_normalization"))),
+    is_pyi=vim.current.buffer.name.endswith('.pyi'),
+  )
+  (cursor_line, cursor_column) = vim.current.window.cursor
+  cb = vim.current.buffer[:]
+  cb_bc = cb[0:cursor_line]
+  # Format all code before the cursor.
+  # Detect unclosed blocks, close them with pass.
+  last_line = cb_bc[-1]
+  if last_line.rstrip().endswith(":"):
+      cb_bc[-1] = last_line + " pass"
+  # Determine old:new cursor location mapping
+  buffer_str_before = '\n'.join(cb_bc)+'\n'
+  try:
+    new_buffer_str_before = black.format_file_contents(buffer_str_before, fast=fast, mode=mode)
+    new_cb = new_buffer_str_before.split('\n')[:-1]
+    new_cursor_line = len(new_cb)
+    new_cursor = (new_cursor_line, cursor_column)
+  except black.NothingChanged:
+    new_cursor_line = cursor_line
+    new_cursor = (new_cursor_line, cursor_column)
+  except Exception as exc:
+    print(exc)
+  # Now we know where the cursor should be
+  # when we format the entire buffer. Do it:
+  buffer_str = '\n'.join(cb) + '\n'
   try:
-    new_buffer_str = black.format_file_contents(buffer_str, line_length=line_length, fast=fast)
+    new_buffer_str = black.format_file_contents(buffer_str, fast=fast, mode=mode)
   except black.NothingChanged:
     print(f'Already well formatted, good job. (took {time.time() - start:.4f}s)')
   except Exception as exc:
     print(exc)
   else:
-    vim.current.buffer[:] = new_buffer_str.split('\n')[:-1]
+    # Replace the buffer
+    new_cb = new_buffer_str.split('\n')[:-1]
+    vim.current.buffer[:] = new_cb
+    # Restore the cursor to its rightful place
+    try:
+      vim.current.window.cursor = new_cursor
+    except vim.error:
+      vim.current.window.cursor = (len(vim.current.buffer), 0)
     print(f'Reformatted in {time.time() - start:.4f}s.')
 
 def BlackUpgrade():
@@ -116,6 +161,3 @@ endpython3
 command! Black :py3 Black()
 command! BlackUpgrade :py3 BlackUpgrade()
 command! BlackVersion :py3 BlackVersion()
-
-nmap ,= :Black<CR>
-vmap ,= :Black<CR>