565 lines
19 KiB
VimL
565 lines
19 KiB
VimL
let s:shell_error = 0
|
|
|
|
function! s:is_bad_response(s) abort
|
|
return a:s =~? '\v(^unable)|(^error)|(^outdated)'
|
|
endfunction
|
|
|
|
function! s:trim(s) abort
|
|
return substitute(a:s, '^\_s*\|\_s*$', '', 'g')
|
|
endfunction
|
|
|
|
" Convert '\' to '/'. Collapse '//' and '/./'.
|
|
function! s:normalize_path(s) abort
|
|
return substitute(substitute(a:s, '\', '/', 'g'), '/\./\|/\+', '/', 'g')
|
|
endfunction
|
|
|
|
" Simple version comparison.
|
|
function! s:version_cmp(a, b) abort
|
|
let a = split(a:a, '\.', 0)
|
|
let b = split(a:b, '\.', 0)
|
|
|
|
for i in range(len(a))
|
|
if str2nr(a[i]) > str2nr(b[i])
|
|
return 1
|
|
elseif str2nr(a[i]) < str2nr(b[i])
|
|
return -1
|
|
endif
|
|
endfor
|
|
|
|
return 0
|
|
endfunction
|
|
|
|
" Handler for s:system() function.
|
|
function! s:system_handler(jobid, data, event) dict abort
|
|
if a:event ==# 'stdout' || a:event ==# 'stderr'
|
|
let self.output .= join(a:data, '')
|
|
elseif a:event ==# 'exit'
|
|
let s:shell_error = a:data
|
|
endif
|
|
endfunction
|
|
|
|
" Attempts to construct a shell command from an args list.
|
|
" Only for display, to help users debug a failed command.
|
|
function! s:shellify(cmd) abort
|
|
if type(a:cmd) != type([])
|
|
return a:cmd
|
|
endif
|
|
return join(map(copy(a:cmd),
|
|
\'v:val =~# ''\m[\-.a-zA-Z_/]'' ? shellescape(v:val) : v:val'), ' ')
|
|
endfunction
|
|
|
|
" Run a system command and timeout after 30 seconds.
|
|
function! s:system(cmd, ...) abort
|
|
let stdin = a:0 ? a:1 : ''
|
|
let ignore_stderr = a:0 > 1 ? a:2 : 0
|
|
let ignore_error = a:0 > 2 ? a:3 : 0
|
|
let opts = {
|
|
\ 'output': '',
|
|
\ 'on_stdout': function('s:system_handler'),
|
|
\ 'on_exit': function('s:system_handler'),
|
|
\ }
|
|
if !ignore_stderr
|
|
let opts.on_stderr = function('s:system_handler')
|
|
endif
|
|
let jobid = jobstart(a:cmd, opts)
|
|
|
|
if jobid < 1
|
|
call health#report_error(printf('Command error (job=%d): %s', jobid, s:shellify(a:cmd)))
|
|
let s:shell_error = 1
|
|
return opts.output
|
|
endif
|
|
|
|
if !empty(stdin)
|
|
call jobsend(jobid, stdin)
|
|
endif
|
|
|
|
let res = jobwait([jobid], 30000)
|
|
if res[0] == -1
|
|
call health#report_error(printf('Command timed out: %s', s:shellify(a:cmd)))
|
|
call jobstop(jobid)
|
|
elseif s:shell_error != 0 && !ignore_error
|
|
call health#report_error(printf("Command error (job=%d): %s\nOutput: %s", jobid,
|
|
\ s:shellify(a:cmd), opts.output))
|
|
endif
|
|
|
|
return opts.output
|
|
endfunction
|
|
|
|
function! s:systemlist(cmd, ...) abort
|
|
let stdout = split(s:system(a:cmd, a:0 ? a:1 : ''), "\n")
|
|
if a:0 > 1 && !empty(a:2)
|
|
return filter(stdout, '!empty(v:val)')
|
|
endif
|
|
return stdout
|
|
endfunction
|
|
|
|
" Fetch the contents of a URL.
|
|
function! s:download(url) abort
|
|
if executable('curl')
|
|
let rv = s:system(['curl', '-sL', a:url], '', 1, 1)
|
|
return s:shell_error ? 'curl error with '.a:url.': '.s:shell_error : rv
|
|
elseif executable('python')
|
|
let script = "
|
|
\try:\n
|
|
\ from urllib.request import urlopen\n
|
|
\except ImportError:\n
|
|
\ from urllib2 import urlopen\n
|
|
\\n
|
|
\response = urlopen('".a:url."')\n
|
|
\print(response.read().decode('utf8'))\n
|
|
\"
|
|
let rv = s:system(['python', '-c', script])
|
|
return empty(rv) && s:shell_error
|
|
\ ? 'python urllib.request error: '.s:shell_error
|
|
\ : rv
|
|
endif
|
|
return 'missing `curl` and `python`, cannot make pypi request'
|
|
endfunction
|
|
|
|
" Check for clipboard tools.
|
|
function! s:check_clipboard() abort
|
|
call health#report_start('Clipboard (optional)')
|
|
|
|
let clipboard_tool = provider#clipboard#Executable()
|
|
if exists('g:clipboard') && empty(clipboard_tool)
|
|
call health#report_error(
|
|
\ provider#clipboard#Error(),
|
|
\ ["Use the example in :help g:clipboard as a template, or don't set g:clipboard at all."])
|
|
elseif empty(clipboard_tool)
|
|
call health#report_warn(
|
|
\ 'No clipboard tool found. Clipboard registers (`"+` and `"*`) will not work.',
|
|
\ [':help clipboard'])
|
|
else
|
|
call health#report_ok('Clipboard tool found: '. clipboard_tool)
|
|
endif
|
|
endfunction
|
|
|
|
" Get the latest Neovim Python client version from PyPI.
|
|
function! s:latest_pypi_version() abort
|
|
let pypi_version = 'unable to get pypi response'
|
|
let pypi_response = s:download('https://pypi.python.org/pypi/neovim/json')
|
|
if !empty(pypi_response)
|
|
try
|
|
let pypi_data = json_decode(pypi_response)
|
|
catch /E474/
|
|
return 'error: '.pypi_response
|
|
endtry
|
|
let pypi_version = get(get(pypi_data, 'info', {}), 'version', 'unable to parse')
|
|
endif
|
|
return pypi_version
|
|
endfunction
|
|
|
|
" Get version information using the specified interpreter. The interpreter is
|
|
" used directly in case breaking changes were introduced since the last time
|
|
" Neovim's Python client was updated.
|
|
"
|
|
" Returns: [
|
|
" {python executable version},
|
|
" {current nvim version},
|
|
" {current pypi nvim status},
|
|
" {installed version status}
|
|
" ]
|
|
function! s:version_info(python) abort
|
|
let pypi_version = s:latest_pypi_version()
|
|
let python_version = s:trim(s:system([
|
|
\ a:python,
|
|
\ '-c',
|
|
\ 'import sys; print(".".join(str(x) for x in sys.version_info[:3]))',
|
|
\ ]))
|
|
|
|
if empty(python_version)
|
|
let python_version = 'unable to parse '.a:python.' response'
|
|
endif
|
|
|
|
let nvim_path = s:trim(s:system([
|
|
\ a:python, '-c', 'import neovim; print(neovim.__file__)']))
|
|
if s:shell_error || empty(nvim_path)
|
|
return [python_version, 'unable to load neovim Python module', pypi_version,
|
|
\ nvim_path]
|
|
endif
|
|
|
|
" Assuming that multiple versions of a package are installed, sort them
|
|
" numerically in descending order.
|
|
function! s:compare(metapath1, metapath2) abort
|
|
let a = matchstr(fnamemodify(a:metapath1, ':p:h:t'), '[0-9.]\+')
|
|
let b = matchstr(fnamemodify(a:metapath2, ':p:h:t'), '[0-9.]\+')
|
|
return a == b ? 0 : a > b ? 1 : -1
|
|
endfunction
|
|
|
|
" Try to get neovim.VERSION (added in 0.1.11dev).
|
|
let nvim_version = s:system([a:python, '-c',
|
|
\ 'from neovim import VERSION as v; '.
|
|
\ 'print("{}.{}.{}{}".format(v.major, v.minor, v.patch, v.prerelease))'],
|
|
\ '', 1, 1)
|
|
if empty(nvim_version)
|
|
let nvim_version = 'unable to find neovim Python module version'
|
|
let base = fnamemodify(nvim_path, ':h')
|
|
let metas = glob(base.'-*/METADATA', 1, 1)
|
|
\ + glob(base.'-*/PKG-INFO', 1, 1)
|
|
\ + glob(base.'.egg-info/PKG-INFO', 1, 1)
|
|
let metas = sort(metas, 's:compare')
|
|
|
|
if !empty(metas)
|
|
for meta_line in readfile(metas[0])
|
|
if meta_line =~# '^Version:'
|
|
let nvim_version = matchstr(meta_line, '^Version: \zs\S\+')
|
|
break
|
|
endif
|
|
endfor
|
|
endif
|
|
endif
|
|
|
|
let nvim_path_base = fnamemodify(nvim_path, ':~:h')
|
|
let version_status = 'unknown; '.nvim_path_base
|
|
if !s:is_bad_response(nvim_version) && !s:is_bad_response(pypi_version)
|
|
if s:version_cmp(nvim_version, pypi_version) == -1
|
|
let version_status = 'outdated; from '.nvim_path_base
|
|
else
|
|
let version_status = 'up to date'
|
|
endif
|
|
endif
|
|
|
|
return [python_version, nvim_version, pypi_version, version_status]
|
|
endfunction
|
|
|
|
" Check the Python interpreter's usability.
|
|
function! s:check_bin(bin) abort
|
|
if !filereadable(a:bin) && (!has('win32') || !filereadable(a:bin.'.exe'))
|
|
call health#report_error(printf('"%s" was not found.', a:bin))
|
|
return 0
|
|
elseif executable(a:bin) != 1
|
|
call health#report_error(printf('"%s" is not executable.', a:bin))
|
|
return 0
|
|
endif
|
|
return 1
|
|
endfunction
|
|
|
|
function! s:check_python(version) abort
|
|
call health#report_start('Python ' . a:version . ' provider (optional)')
|
|
|
|
let pyname = 'python'.(a:version == 2 ? '' : '3')
|
|
let pyenv = resolve(exepath('pyenv'))
|
|
let pyenv_root = exists('$PYENV_ROOT') ? resolve($PYENV_ROOT) : ''
|
|
let venv = exists('$VIRTUAL_ENV') ? resolve($VIRTUAL_ENV) : ''
|
|
let host_prog_var = pyname.'_host_prog'
|
|
let loaded_var = 'g:loaded_'.pyname.'_provider'
|
|
let python_bin = ''
|
|
let python_multiple = []
|
|
|
|
if exists(loaded_var) && !exists('*provider#'.pyname.'#Call')
|
|
call health#report_info('Disabled. '.loaded_var.'='.eval(loaded_var))
|
|
return
|
|
endif
|
|
|
|
if !empty(pyenv)
|
|
if empty(pyenv_root)
|
|
call health#report_warn(
|
|
\ 'pyenv was found, but $PYENV_ROOT is not set.',
|
|
\ ['Did you follow the final install instructions?',
|
|
\ 'If you use a shell "framework" like Prezto or Oh My Zsh, try without.',
|
|
\ 'Try a different shell (bash).']
|
|
\ )
|
|
else
|
|
call health#report_ok(printf('pyenv found: "%s"', pyenv))
|
|
endif
|
|
endif
|
|
|
|
if exists('g:'.host_prog_var)
|
|
call health#report_info(printf('Using: g:%s = "%s"', host_prog_var, get(g:, host_prog_var)))
|
|
endif
|
|
|
|
let [pyname, pythonx_errs] = provider#pythonx#Detect(a:version)
|
|
if empty(pyname)
|
|
call health#report_warn('No Python interpreter was found with the neovim '
|
|
\ . 'module. Using the first available for diagnostics.')
|
|
if !empty(pythonx_errs)
|
|
call health#report_warn(pythonx_errs)
|
|
endif
|
|
endif
|
|
|
|
if !empty(pyname)
|
|
if exists('g:'.host_prog_var)
|
|
let python_bin = exepath(pyname)
|
|
endif
|
|
let pyname = fnamemodify(pyname, ':t')
|
|
endif
|
|
|
|
if !empty(pythonx_errs)
|
|
call health#report_error('Python provider error', pythonx_errs)
|
|
endif
|
|
|
|
if !empty(pyname) && empty(python_bin) && empty(pythonx_errs)
|
|
if !exists('g:'.host_prog_var)
|
|
call health#report_info(printf('`g:%s` is not set. Searching for '
|
|
\ . '%s in the environment.', host_prog_var, pyname))
|
|
endif
|
|
|
|
if !empty(pyenv)
|
|
let python_bin = s:trim(s:system([pyenv, 'which', pyname], '', 1))
|
|
|
|
if empty(python_bin)
|
|
call health#report_warn(printf('pyenv could not find %s.', pyname))
|
|
endif
|
|
endif
|
|
|
|
if empty(python_bin)
|
|
let python_bin = exepath(pyname)
|
|
|
|
if exists('$PATH')
|
|
for path in split($PATH, has('win32') ? ';' : ':')
|
|
let path_bin = s:normalize_path(path.'/'.pyname)
|
|
if path_bin != s:normalize_path(python_bin)
|
|
\ && index(python_multiple, path_bin) == -1
|
|
\ && executable(path_bin)
|
|
call add(python_multiple, path_bin)
|
|
endif
|
|
endfor
|
|
|
|
if len(python_multiple)
|
|
" This is worth noting since the user may install something
|
|
" that changes $PATH, like homebrew.
|
|
call health#report_info(printf('Multiple %s executables found. '
|
|
\ . 'Set `g:%s` to avoid surprises.', pyname, host_prog_var))
|
|
endif
|
|
|
|
if python_bin =~# '\<shims\>'
|
|
call health#report_warn(printf('`%s` appears to be a pyenv shim.', python_bin), [
|
|
\ '`pyenv` is not in $PATH, your pyenv installation is broken. '
|
|
\ .'Set `g:'.host_prog_var.'` to avoid surprises.',
|
|
\ ])
|
|
endif
|
|
endif
|
|
endif
|
|
endif
|
|
|
|
if !empty(python_bin)
|
|
if empty(venv) && !empty(pyenv) && !exists('g:'.host_prog_var)
|
|
\ && !empty(pyenv_root) && resolve(python_bin) !~# '^'.pyenv_root.'/'
|
|
call health#report_warn('pyenv is not set up optimally.', [
|
|
\ printf('Create a virtualenv specifically '
|
|
\ . 'for Neovim using pyenv, and set `g:%s`. This will avoid '
|
|
\ . 'the need to install the Neovim Python module in each '
|
|
\ . 'version/virtualenv.', host_prog_var)
|
|
\ ])
|
|
elseif !empty(venv) && exists('g:'.host_prog_var)
|
|
if !empty(pyenv_root)
|
|
let venv_root = pyenv_root
|
|
else
|
|
let venv_root = fnamemodify(venv, ':h')
|
|
endif
|
|
|
|
if resolve(python_bin) !~# '^'.venv_root.'/'
|
|
call health#report_warn('Your virtualenv is not set up optimally.', [
|
|
\ printf('Create a virtualenv specifically '
|
|
\ . 'for Neovim and use `g:%s`. This will avoid '
|
|
\ . 'the need to install Neovim''s Python module in each '
|
|
\ . 'virtualenv.', host_prog_var)
|
|
\ ])
|
|
endif
|
|
endif
|
|
endif
|
|
|
|
if empty(python_bin) && !empty(pyname)
|
|
" An error message should have already printed.
|
|
call health#report_error(printf('`%s` was not found.', pyname))
|
|
elseif !empty(python_bin) && !s:check_bin(python_bin)
|
|
let python_bin = ''
|
|
endif
|
|
|
|
" Check if $VIRTUAL_ENV is active
|
|
let virtualenv_inactive = 0
|
|
|
|
if exists('$VIRTUAL_ENV')
|
|
if !empty(pyenv)
|
|
let pyenv_prefix = resolve(s:trim(s:system([pyenv, 'prefix'])))
|
|
if $VIRTUAL_ENV != pyenv_prefix
|
|
let virtualenv_inactive = 1
|
|
endif
|
|
elseif !empty(pyname) && exepath(pyname) !~# '^'.$VIRTUAL_ENV.'/'
|
|
let virtualenv_inactive = 1
|
|
endif
|
|
endif
|
|
|
|
if virtualenv_inactive
|
|
call health#report_warn(
|
|
\ '$VIRTUAL_ENV exists but appears to be inactive. '
|
|
\ . 'This could lead to unexpected results.',
|
|
\ [ 'If you are using Zsh, see: http://vi.stackexchange.com/a/7654/5229' ])
|
|
endif
|
|
|
|
" Diagnostic output
|
|
call health#report_info('Executable: ' . (empty(python_bin) ? 'Not found' : python_bin))
|
|
if len(python_multiple)
|
|
for path_bin in python_multiple
|
|
call health#report_info('Other python executable: ' . path_bin)
|
|
endfor
|
|
endif
|
|
|
|
if !empty(python_bin)
|
|
let [pyversion, current, latest, status] = s:version_info(python_bin)
|
|
if a:version != str2nr(pyversion)
|
|
call health#report_warn('Unexpected Python version.' .
|
|
\ ' This could lead to confusing error messages.')
|
|
endif
|
|
if a:version == 3 && str2float(pyversion) < 3.3
|
|
call health#report_warn('Python 3.3+ is recommended.')
|
|
endif
|
|
|
|
call health#report_info('Python'.a:version.' version: ' . pyversion)
|
|
if s:is_bad_response(status)
|
|
call health#report_info(printf('%s-neovim version: %s (%s)', pyname, current, status))
|
|
else
|
|
call health#report_info(printf('%s-neovim version: %s', pyname, current))
|
|
endif
|
|
|
|
if s:is_bad_response(current)
|
|
call health#report_error(
|
|
\ "Neovim Python client is not installed.\nError: ".current,
|
|
\ ['Run in shell: pip' . a:version . ' install neovim'])
|
|
endif
|
|
|
|
if s:is_bad_response(latest)
|
|
call health#report_warn('Could not contact PyPI to get latest version.')
|
|
call health#report_error('HTTP request failed: '.latest)
|
|
elseif s:is_bad_response(status)
|
|
call health#report_warn(printf('Latest %s-neovim is NOT installed: %s',
|
|
\ pyname, latest))
|
|
elseif !s:is_bad_response(current)
|
|
call health#report_ok(printf('Latest %s-neovim is installed: %s',
|
|
\ pyname, latest))
|
|
endif
|
|
endif
|
|
|
|
endfunction
|
|
|
|
function! s:check_ruby() abort
|
|
call health#report_start('Ruby provider (optional)')
|
|
|
|
let loaded_var = 'g:loaded_ruby_provider'
|
|
if exists(loaded_var) && !exists('*provider#ruby#Call')
|
|
call health#report_info('Disabled. '.loaded_var.'='.eval(loaded_var))
|
|
return
|
|
endif
|
|
|
|
if !executable('ruby') || !executable('gem')
|
|
call health#report_warn(
|
|
\ '`ruby` and `gem` must be in $PATH.',
|
|
\ ['Install Ruby and verify that `ruby` and `gem` commands work.'])
|
|
return
|
|
endif
|
|
call health#report_info('Ruby: '. s:system('ruby -v'))
|
|
|
|
let host = provider#ruby#Detect()
|
|
if empty(host)
|
|
call health#report_warn('Missing "neovim" gem.',
|
|
\ ['Run in shell: gem install neovim',
|
|
\ 'Is the gem bin directory in $PATH? Check `gem environment`.',
|
|
\ 'If you are using rvm/rbenv/chruby, try "rehashing".'])
|
|
return
|
|
endif
|
|
call health#report_info('Host: '. host)
|
|
|
|
let latest_gem_cmd = has('win32') ? 'cmd /c gem list -ra ^^neovim$' : 'gem list -ra ^neovim$'
|
|
let latest_gem = s:system(split(latest_gem_cmd))
|
|
if s:shell_error || empty(latest_gem)
|
|
call health#report_error('Failed to run: '. latest_gem_cmd,
|
|
\ ["Make sure you're connected to the internet.",
|
|
\ 'Are you behind a firewall or proxy?'])
|
|
return
|
|
endif
|
|
let latest_gem = get(split(latest_gem, 'neovim (\|, \|)$' ), 1, 'not found')
|
|
|
|
let current_gem_cmd = host .' --version'
|
|
let current_gem = s:system(current_gem_cmd)
|
|
if s:shell_error
|
|
call health#report_error('Failed to run: '. current_gem_cmd,
|
|
\ ['Report this issue with the output of: ', current_gem_cmd])
|
|
return
|
|
endif
|
|
|
|
if s:version_cmp(current_gem, latest_gem) == -1
|
|
call health#report_warn(
|
|
\ printf('Gem "neovim" is out-of-date. Installed: %s, latest: %s',
|
|
\ current_gem, latest_gem),
|
|
\ ['Run in shell: gem update neovim'])
|
|
else
|
|
call health#report_ok('Latest "neovim" gem is installed: '. current_gem)
|
|
endif
|
|
endfunction
|
|
|
|
function! s:check_node() abort
|
|
call health#report_start('Node.js provider (optional)')
|
|
|
|
let loaded_var = 'g:loaded_node_provider'
|
|
if exists(loaded_var) && !exists('*provider#node#Call')
|
|
call health#report_info('Disabled. '.loaded_var.'='.eval(loaded_var))
|
|
return
|
|
endif
|
|
|
|
if !executable('node') || !executable('npm')
|
|
call health#report_warn(
|
|
\ '`node` and `npm` must be in $PATH.',
|
|
\ ['Install Node.js and verify that `node` and `npm` commands work.'])
|
|
return
|
|
endif
|
|
let node_v = get(split(s:system('node -v'), "\n"), 0, '')
|
|
call health#report_info('Node.js: '. node_v)
|
|
if !s:shell_error && s:version_cmp(node_v[1:], '6.0.0') < 0
|
|
call health#report_warn('Neovim node.js host does not support '.node_v)
|
|
endif
|
|
if !provider#node#can_inspect()
|
|
call health#report_warn('node.js on this system does not support --inspect-brk so $NVIM_NODE_HOST_DEBUG is ignored.')
|
|
endif
|
|
|
|
let host = provider#node#Detect()
|
|
if empty(host)
|
|
call health#report_warn('Missing "neovim" npm package.',
|
|
\ ['Run in shell: npm install -g neovim',
|
|
\ 'Is the npm bin directory in $PATH?'])
|
|
return
|
|
endif
|
|
call health#report_info('Neovim node.js host: '. host)
|
|
|
|
let latest_npm_cmd = has('win32') ? 'cmd /c npm info neovim --json' : 'npm info neovim --json'
|
|
let latest_npm = s:system(split(latest_npm_cmd))
|
|
if s:shell_error || empty(latest_npm)
|
|
call health#report_error('Failed to run: '. latest_npm_cmd,
|
|
\ ["Make sure you're connected to the internet.",
|
|
\ 'Are you behind a firewall or proxy?'])
|
|
return
|
|
endif
|
|
if !empty(latest_npm)
|
|
try
|
|
let pkg_data = json_decode(latest_npm)
|
|
catch /E474/
|
|
return 'error: '.latest_npm
|
|
endtry
|
|
let latest_npm = get(get(pkg_data, 'dist-tags', {}), 'latest', 'unable to parse')
|
|
endif
|
|
|
|
let current_npm_cmd = ['node', host, '--version']
|
|
let current_npm = s:system(current_npm_cmd)
|
|
if s:shell_error
|
|
call health#report_error('Failed to run: '. current_npm_cmd,
|
|
\ ['Report this issue with the output of: ', current_npm_cmd])
|
|
return
|
|
endif
|
|
|
|
if s:version_cmp(current_npm, latest_npm) == -1
|
|
call health#report_warn(
|
|
\ printf('Package "neovim" is out-of-date. Installed: %s, latest: %s',
|
|
\ current_npm, latest_npm),
|
|
\ ['Run in shell: npm update neovim'])
|
|
else
|
|
call health#report_ok('Latest "neovim" npm is installed: '. current_npm)
|
|
endif
|
|
endfunction
|
|
|
|
function! health#provider#check() abort
|
|
call s:check_clipboard()
|
|
call s:check_python(2)
|
|
call s:check_python(3)
|
|
call s:check_ruby()
|
|
call s:check_node()
|
|
endfunction
|