Merge pull request #3409 from lyz-code/feat/add-autoimport-support

feat: add autoimport fixer

autoload/ale/fix/registry.vim

@@ -12,6 +12,11 @@ let s:default_registry = {
 \       'suggested_filetypes': ['help'],
 \       'description': 'Align help tags to the right margin',
 \   },
+\   'autoimport': {
+\       'function': 'ale#fixers#autoimport#Fix',
+\       'suggested_filetypes': ['python'],
+\       'description': 'Fix import issues with autoimport.',
+\   },
 \   'autopep8': {
 \       'function': 'ale#fixers#autopep8#Fix',
 \       'suggested_filetypes': ['python'],

autoload/ale/fixers/autoimport.vim

@@ -0,0 +1,25 @@
+" Author: lyz-code
+" Description: Fixing Python imports with autoimport.
+
+call ale#Set('python_autoimport_executable', 'autoimport')
+call ale#Set('python_autoimport_options', '')
+call ale#Set('python_autoimport_use_global', get(g:, 'ale_use_global_executables', 0))
+
+function! ale#fixers#autoimport#Fix(buffer) abort
+    let l:options = ale#Var(a:buffer, 'python_autoimport_options')
+
+    let l:executable = ale#python#FindExecutable(
+    \   a:buffer,
+    \   'python_autoimport',
+    \   ['autoimport'],
+    \)
+
+    if !executable(l:executable)
+        return 0
+    endif
+
+    return {
+    \   'command': ale#path#BufferCdString(a:buffer)
+    \   .   ale#Escape(l:executable) . (!empty(l:options) ? ' ' . l:options : '') . ' -',
+    \}
+endfunction

doc/ale-python.txt

@@ -41,6 +41,32 @@ ALE will look for configuration files with the following filenames. >
 The first directory containing any of the files named above will be used.
 
 
+===============================================================================
+autoimport                                              *ale-python-autoimport*
+
+g:ale_python_autoimport_executable             *g:ale_python_autoimport_executable*
+                                             *b:ale_python_autoimport_executable*
+  Type: |String|
+  Default: `'autoimport'`
+
+  See |ale-integrations-local-executables|
+
+
+g:ale_python_autoimport_options                   *g:ale_python_autoimport_options*
+                                                *b:ale_python_autoimport_options*
+  Type: |String|
+  Default: `''`
+
+  This variable can be set to pass extra options to autoimport.
+
+
+g:ale_python_autoimport_use_global             *g:ale_python_autoimport_use_global*
+                                             *b:ale_python_autoimport_use_global*
+  Type: |Number|
+  Default: `get(g:, 'ale_use_global_executables', 0)`
+
+  See |ale-integrations-local-executables|
+
 ===============================================================================
 autopep8                                                  *ale-python-autopep8*
 

doc/ale-supported-languages-and-tools.txt

@@ -366,6 +366,7 @@ Notes:
   * `purescript-language-server`
   * `purty`
 * Python
+  * `autoimport`
   * `autopep8`
   * `bandit`
   * `black`

doc/ale.txt

@@ -2832,6 +2832,7 @@ documented in additional help files.
   pyrex (cython)..........................|ale-pyrex-options|
     cython................................|ale-pyrex-cython|
   python..................................|ale-python-options|
+    autoimport............................|ale-python-autoimport|
     autopep8..............................|ale-python-autopep8|
     bandit................................|ale-python-bandit|
     black.................................|ale-python-black|

supported-tools.md

@@ -375,6 +375,7 @@ formatting.
   * [purescript-language-server](https://github.com/nwolverson/purescript-language-server)
   * [purty](https://gitlab.com/joneshf/purty)
 * Python
+  * [autoimport](https://lyz-code.github.io/autoimport/)
   * [autopep8](https://github.com/hhatto/autopep8)
   * [bandit](https://github.com/PyCQA/bandit) :warning:
   * [black](https://github.com/ambv/black)

test/fixers/test_autoimport_fixer_callback.vader

@@ -0,0 +1,50 @@
+Before:
+  Save g:ale_python_autoimport_executable
+  Save g:ale_python_autoimport_options
+
+  " Use an invalid global executable, so we don't match it.
+  let g:ale_python_autoimport_executable = 'xxxinvalid'
+  let g:ale_python_autoimport_options = ''
+
+  call ale#test#SetDirectory('/testplugin/test/fixers')
+  silent cd ..
+  silent cd command_callback
+  let g:dir = getcwd()
+
+  let b:bin_dir = has('win32') ? 'Scripts' : 'bin'
+
+After:
+  Restore
+
+  unlet! b:bin_dir
+
+  call ale#test#RestoreDirectory()
+
+Execute(The autoimport callback should return the correct default values):
+  AssertEqual
+  \ 0,
+  \ ale#fixers#autoimport#Fix(bufnr(''))
+
+  silent execute 'file ' . fnameescape(g:dir . '/python_paths/with_virtualenv/subdir/foo/bar.py')
+  AssertEqual
+  \ {
+  \   'command': ale#path#BufferCdString(bufnr(''))
+  \     . ale#Escape(ale#path#Simplify(g:dir . '/python_paths/with_virtualenv/env/' . b:bin_dir . '/autoimport')) . ' -',
+  \ },
+  \ ale#fixers#autoimport#Fix(bufnr(''))
+
+Execute(The autoimport callback should respect custom options):
+  let g:ale_python_autoimport_options = '--multi-line=3 --trailing-comma'
+
+  AssertEqual
+  \ 0,
+  \ ale#fixers#autoimport#Fix(bufnr(''))
+
+  silent execute 'file ' . fnameescape(g:dir . '/python_paths/with_virtualenv/subdir/foo/bar.py')
+  AssertEqual
+  \ {
+  \   'command': ale#path#BufferCdString(bufnr(''))
+  \     . ale#Escape(ale#path#Simplify(g:dir . '/python_paths/with_virtualenv/env/' . b:bin_dir . '/autoimport'))
+  \     . ' --multi-line=3 --trailing-comma -',
+  \ },
+  \ ale#fixers#autoimport#Fix(bufnr(''))