diff options
Diffstat (limited to 'runtime/autoload/health.vim')
| -rw-r--r-- | runtime/autoload/health.vim | 534 |
1 files changed, 139 insertions, 395 deletions
diff --git a/runtime/autoload/health.vim b/runtime/autoload/health.vim index dc362577a6..56ae2071e9 100644 --- a/runtime/autoload/health.vim +++ b/runtime/autoload/health.vim @@ -1,433 +1,177 @@ -function! s:trim(s) abort - return substitute(a:s, '^\_s*\|\_s*$', '', 'g') -endfunction - +function! s:enhance_syntax() abort + syntax case match -" Simple version comparison. -function! s:version_cmp(a, b) abort - let a = split(a:a, '\.') - let b = split(a:b, '\.') - - for i in range(len(a)) - if a[i] > b[i] - return 1 - elseif a[i] < b[i] - return -1 - endif - endfor - - return 0 -endfunction + syntax keyword healthError ERROR[:] + \ containedin=markdownCodeBlock,mkdListItemLine + highlight default link healthError Error + syntax keyword healthWarning WARNING[:] + \ containedin=markdownCodeBlock,mkdListItemLine + highlight default link healthWarning WarningMsg -" Fetch the contents of a URL. -function! s:download(url) abort - let content = '' - if executable('curl') - let content = system('curl -sL "'.a:url.'"') - endif + syntax keyword healthSuccess OK[:] + \ containedin=markdownCodeBlock,mkdListItemLine + highlight default healthSuccess guibg=#5fff00 guifg=#080808 ctermbg=82 ctermfg=232 - if empty(content) && executable('python') - let script = " - \try:\n - \ from urllib.request import urlopen\n - \except ImportError:\n - \ from urllib2 import urlopen\n - \\n - \try:\n - \ response = urlopen('".a:url."')\n - \ print(response.read().decode('utf8'))\n - \except Exception:\n - \ pass\n - \" - let content = system('python -c "'.script.'" 2>/dev/null') - endif + syntax match healthHelp "|.\{-}|" contains=healthBar + \ containedin=markdownCodeBlock,mkdListItemLine + syntax match healthBar "|" contained conceal + highlight default link healthHelp Identifier - return content + " We do not care about markdown syntax errors in :checkhealth output. + highlight! link markdownError Normal endfunction - -" Get the latest Neovim Python client version from PyPI. The result is -" cached. -function! s:latest_pypi_version() - if exists('s:pypi_version') - return s:pypi_version - endif - - let s:pypi_version = 'unknown' - let pypi_info = s:download('https://pypi.python.org/pypi/neovim/json') - if !empty(pypi_info) - let pypi_data = json_decode(pypi_info) - let s:pypi_version = get(get(pypi_data, 'info', {}), 'version', 'unknown') - return s:pypi_version - endif -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. -function! s:version_info(python) abort - let pypi_version = s:latest_pypi_version() - let python_version = s:trim(system( - \ printf('"%s" -c "import sys; print(''.''.join(str(x) ' - \ . 'for x in sys.version_info[:3]))"', a:python))) - if empty(python_version) - let python_version = 'unknown' - endif - - let nvim_path = s:trim(system(printf('"%s" -c "import sys, neovim;' - \ . 'print(neovim.__file__)" 2>/dev/null', a:python))) - if empty(nvim_path) - return [python_version, 'not found', pypi_version, 'unknown'] - endif - - let nvim_version = 'unknown' - let base = fnamemodify(nvim_path, ':h') - for meta in glob(base.'-*/METADATA', 1, 1) + glob(base.'-*/PKG-INFO', 1, 1) - for meta_line in readfile(meta) - if meta_line =~# '^Version:' - let nvim_version = matchstr(meta_line, '^Version: \zs\S\+') - endif +" Runs the specified healthchecks. +" Runs all discovered healthchecks if a:plugin_names is empty. +function! health#check(plugin_names) abort + let healthchecks = empty(a:plugin_names) + \ ? s:discover_health_checks() + \ : s:to_fn_names(a:plugin_names) + + tabnew + setlocal wrap breakindent + setlocal filetype=markdown + setlocal conceallevel=2 concealcursor=nc + setlocal keywordprg=:help + let &l:iskeyword='!-~,^*,^|,^",192-255' + call s:enhance_syntax() + + if empty(healthchecks) + call setline(1, 'ERROR: No healthchecks found.') + else + redraw|echo 'Running healthchecks...' + for c in healthchecks + let output = '' + call append('$', split(printf("\n%s\n%s", c, repeat('=',72)), "\n")) + try + let output = "\n\n".execute('call '.c.'()') + catch + if v:exception =~# '^Vim\%((\a\+)\)\=:E117.*\V'.c + let output = execute( + \ 'call health#report_error(''No healthcheck found for "' + \ .s:to_plugin_name(c) + \ .'" plugin.'')') + else + let output = execute( + \ 'call health#report_error(''Failed to run healthcheck for "' + \ .s:to_plugin_name(c) + \ .'" plugin. Exception:''."\n".v:throwpoint."\n".v:exception)') + endif + endtry + call append('$', split(output, "\n") + ['']) + redraw endfor - endfor - - let version_status = 'unknown' - if nvim_version != 'unknown' && pypi_version != 'unknown' - if s:version_cmp(nvim_version, pypi_version) == -1 - let version_status = 'outdated' - else - let version_status = 'up to date' - endif endif - return [python_version, nvim_version, pypi_version, version_status] + " needed for plasticboy/vim-markdown, because it uses fdm=expr + normal! zR + setlocal nomodified + setlocal bufhidden=hide + redraw|echo '' endfunction - -" Check the Python interpreter's usability. -function! s:check_bin(bin, notes) abort - if !filereadable(a:bin) - call add(a:notes, printf('Error: "%s" was not found.', a:bin)) - return 0 - elseif executable(a:bin) != 1 - call add(a:notes, printf('Error: "%s" is not executable.', a:bin)) - return 0 - endif - return 1 +" Starts a new report. +function! health#report_start(name) abort + echo "\n## " . a:name endfunction - -" Text wrapping that returns a list of lines -function! s:textwrap(text, width) abort - let pattern = '.*\%(\s\+\|\_$\)\zs\%<'.a:width.'c' - return map(split(a:text, pattern), 's:trim(v:val)') -endfunction - - -" Echo wrapped notes -function! s:echo_notes(notes) abort - if empty(a:notes) - return +" Indents lines *except* line 1 of a string if it contains newlines. +function! s:indent_after_line1(s, columns) abort + let lines = split(a:s, "\n", 0) + if len(lines) < 2 " We do not indent line 1, so nothing to do. + return a:s endif - - echo ' Messages:' - for msg in a:notes - if msg =~# "\n" - let msg_lines = [] - for msgl in filter(split(msg, "\n"), 'v:val !~# ''^\s*$''') - call extend(msg_lines, s:textwrap(msgl, 74)) - endfor - else - let msg_lines = s:textwrap(msg, 74) - endif - - if !len(msg_lines) - continue - endif - echo ' *' msg_lines[0] - if len(msg_lines) > 1 - echo join(map(msg_lines[1:], '" ".v:val'), "\n") - endif + for i in range(1, len(lines)-1) " Indent lines after the first. + let lines[i] = substitute(lines[i], '^\s*', repeat(' ', a:columns), 'g') endfor + return join(lines, "\n") endfunction - -" Load the remote plugin manifest file and check for unregistered plugins -function! s:diagnose_manifest() abort - echo 'Checking: Remote Plugins' - let existing_rplugins = {} - - for item in remote#host#PluginsForHost('python') - let existing_rplugins[item.path] = 'python' - endfor - - for item in remote#host#PluginsForHost('python3') - let existing_rplugins[item.path] = 'python3' - endfor - - let require_update = 0 - let notes = [] - - for path in map(split(&rtp, ','), 'resolve(v:val)') - let python_glob = glob(path.'/rplugin/python*', 1, 1) - if empty(python_glob) - continue - endif - - let python_dir = python_glob[0] - let python_version = fnamemodify(python_dir, ':t') - - for script in glob(python_dir.'/*.py', 1, 1) - \ + glob(python_dir.'/*/__init__.py', 1, 1) - let contents = join(readfile(script)) - if contents =~# '\<\%(from\|import\)\s\+neovim\>' - if script =~# '/__init__\.py$' - let script = fnamemodify(script, ':h') - endif - - if !has_key(existing_rplugins, script) - let msg = printf('"%s" is not registered.', fnamemodify(path, ':t')) - if python_version == 'pythonx' - if !has('python2') && !has('python3') - let msg .= ' (python2 and python3 not available)' - endif - elseif !has(python_version) - let msg .= printf(' (%s not available)', python_version) - else - let require_update = 1 - endif - - call add(notes, msg) - endif - - break - endif - endfor - endfor - - echo ' Status: ' - if require_update - echon 'Out of date' - call add(notes, 'Run :UpdateRemotePlugins') - else - echon 'Up to date' - endif - - call s:echo_notes(notes) +" Changes ':h clipboard' to ':help |clipboard|'. +function! s:help_to_link(s) abort + return substitute(a:s, '\v:h%[elp] ([^|][^"\r\n ]+)', ':help |\1|', 'g') endfunction +" Format a message for a specific report item. +" a:1: Optional advice (string or list) +function! s:format_report_message(status, msg, ...) abort " {{{ + let output = ' - ' . a:status . ': ' . s:indent_after_line1(a:msg, 4) -function! s:diagnose_python(version) abort - let python_bin_name = '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 = python_bin_name.'_host_prog' - let host_skip_var = python_bin_name.'_host_skip_check' - let python_bin = '' - let python_multiple = [] - let notes = [] - - if exists('g:'.host_prog_var) - call add(notes, printf('Using: g:%s = "%s"', host_prog_var, get(g:, host_prog_var))) - endif - - let [python_bin_name, pythonx_errs] = provider#pythonx#Detect(a:version) - if empty(python_bin_name) - call add(notes, 'Warning: No Python interpreter was found with the neovim ' - \ . 'module. Using the first available for diagnostics.') - if !empty(pythonx_errs) - call add(notes, pythonx_errs) - endif - let old_skip = get(g:, host_skip_var, 0) - let g:[host_skip_var] = 1 - let [python_bin_name, pythonx_errs] = provider#pythonx#Detect(a:version) - let g:[host_skip_var] = old_skip - endif - - if !empty(python_bin_name) - if exists('g:'.host_prog_var) - let python_bin = exepath(python_bin_name) + " Optional parameters + if a:0 > 0 + let advice = type(a:1) == type('') ? [a:1] : a:1 + if type(advice) != type([]) + throw 'a:1: expected String or List' endif - let python_bin_name = fnamemodify(python_bin_name, ':t') - endif - - if !empty(pythonx_errs) - call add(notes, pythonx_errs) - endif - - if !empty(python_bin_name) && empty(python_bin) && empty(pythonx_errs) - if !exists('g:'.host_prog_var) - call add(notes, printf('Warning: "g:%s" is not set. Searching for ' - \ . '%s in the environment.', host_prog_var, python_bin_name)) - endif - - if !empty(pyenv) - if empty(pyenv_root) - call add(notes, 'Warning: pyenv was found, but $PYENV_ROOT ' - \ . 'is not set. Did you follow the final install ' - \ . 'instructions?') - else - call add(notes, printf('Notice: pyenv found: "%s"', pyenv)) - endif - - let python_bin = s:trim(system( - \ printf('"%s" which %s 2>/dev/null', pyenv, python_bin_name))) - - if empty(python_bin) - call add(notes, printf('Warning: pyenv couldn''t find %s.', python_bin_name)) - endif - endif - - if empty(python_bin) - let python_bin = exepath(python_bin_name) - - if exists('$PATH') - for path in split($PATH, ':') - let path_bin = path.'/'.python_bin_name - if path_bin != 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 add(notes, printf('Suggestion: There are multiple %s executables found. ' - \ . 'Set "g:%s" to avoid surprises.', python_bin_name, host_prog_var)) - endif - - if python_bin =~# '\<shims\>' - call add(notes, printf('Warning: "%s" appears to be a pyenv shim. ' - \ . 'This could mean that a) the "pyenv" executable is not in ' - \ . '$PATH, b) your pyenv installation is broken. ' - \ . 'You should set "g:%s" to avoid surprises.', - \ python_bin, host_prog_var)) - endif - endif - endif - endif - if !empty(python_bin) - if !empty(pyenv) && !exists('g:'.host_prog_var) && !empty(pyenv_root) - \ && resolve(python_bin) !~# '^'.pyenv_root.'/' - call add(notes, printf('Suggestion: Create a virtualenv specifically ' - \ . 'for Neovim using pyenv and use "g:%s". This will avoid ' - \ . 'the need to install Neovim''s Python client in each ' - \ . 'version/virtualenv.', host_prog_var)) - endif - - if !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 add(notes, printf('Suggestion: Create a virtualenv specifically ' - \ . 'for Neovim and use "g:%s". This will avoid ' - \ . 'the need to install Neovim''s Python client in each ' - \ . 'virtualenv.', host_prog_var)) - endif + " Report each suggestion + if !empty(advice) + let output .= "\n - ADVICE:" + for suggestion in advice + let output .= "\n - " . s:indent_after_line1(suggestion, 10) + endfor endif endif - if empty(python_bin) && !empty(python_bin_name) - " An error message should have already printed. - call add(notes, printf('Error: "%s" was not found.', python_bin_name)) - elseif !empty(python_bin) && !s:check_bin(python_bin, notes) - let python_bin = '' - endif + return s:help_to_link(output) +endfunction " }}} - " Check if $VIRTUAL_ENV is active - let virtualenv_inactive = 0 +" Use {msg} to report information in the current section +function! health#report_info(msg) abort " {{{ + echo s:format_report_message('INFO', a:msg) +endfunction " }}} - if exists('$VIRTUAL_ENV') - if !empty(pyenv) - let pyenv_prefix = resolve(s:trim(system(printf('"%s" prefix', pyenv)))) - if $VIRTUAL_ENV != pyenv_prefix - let virtualenv_inactive = 1 - endif - elseif !empty(python_bin_name) && exepath(python_bin_name) !~# '^'.$VIRTUAL_ENV.'/' - let virtualenv_inactive = 1 - endif - endif +" Reports a successful healthcheck. +function! health#report_ok(msg) abort " {{{ + echo s:format_report_message('OK', a:msg) +endfunction " }}} - if virtualenv_inactive - call add(notes, 'Warning: $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 - echo 'Checking: Python' a:version - echo ' Executable:' (empty(python_bin) ? 'Not found' : python_bin) - if len(python_multiple) - for path_bin in python_multiple - echo ' (other):' path_bin - endfor +" Reports a health warning. +" a:1: Optional advice (string or list) +function! health#report_warn(msg, ...) abort " {{{ + if a:0 > 0 + echo s:format_report_message('WARNING', a:msg, a:1) + else + echo s:format_report_message('WARNING', a:msg) endif +endfunction " }}} - if !empty(python_bin) - let [pyversion, current, latest, status] = s:version_info(python_bin) - if a:version != str2nr(pyversion) - call add(notes, 'Warning: Got an unexpected version of Python. ' - \ . 'This could lead to confusing error messages. Please ' - \ . 'consider this before reporting bugs to plugin developers.') - endif - if a:version == 3 && str2float(pyversion) < 3.3 - call add(notes, 'Warning: Python 3.3+ is recommended.') - endif - - echo ' Python Version:' pyversion - echo printf(' %s-neovim Version: %s', python_bin_name, current) - - if current == 'not found' - call add(notes, 'Error: Neovim Python client is not installed.') - endif - - if latest == 'unknown' - call add(notes, 'Warning: Unable to fetch latest Neovim Python client version.') - endif - - if status == 'outdated' - echon ' (latest: '.latest.')' - else - echon ' ('.status.')' - endif +" Reports a failed healthcheck. +" a:1: Optional advice (string or list) +function! health#report_error(msg, ...) abort " {{{ + if a:0 > 0 + echo s:format_report_message('ERROR', a:msg, a:1) + else + echo s:format_report_message('ERROR', a:msg) endif +endfunction " }}} - call s:echo_notes(notes) +function! s:filepath_to_function(name) abort + return substitute(substitute(substitute(a:name, '.*autoload[\/]', '', ''), + \ '\.vim', '#check', ''), '[\/]', '#', 'g') endfunction +function! s:discover_health_checks() abort + let healthchecks = globpath(&runtimepath, 'autoload/health/*.vim', 1, 1) + let healthchecks = map(healthchecks, '<SID>filepath_to_function(v:val)') + return healthchecks +endfunction -function! health#check(bang) abort - redir => report - try - silent call s:diagnose_python(2) - silent echo '' - silent call s:diagnose_python(3) - silent echo '' - silent call s:diagnose_manifest() - silent echo '' - finally - redir END - endtry +" Translates a list of plugin names to healthcheck function names. +function! s:to_fn_names(plugin_names) abort + let healthchecks = [] + let plugin_names = type('') ==# type(a:plugin_names) + \ ? split(a:plugin_names, '', v:false) + \ : a:plugin_names + for p in plugin_names + call add(healthchecks, 'health#'.p.'#check') + endfor + return healthchecks +endfunction - if a:bang - new - setlocal bufhidden=wipe - call setline(1, split(report, "\n")) - setlocal nomodified - else - echo report - echo "\nTip: Use " - echohl Identifier - echon ":CheckHealth!" - echohl None - echon " to open this in a new buffer." - endif +" Extracts 'foo' from 'health#foo#check'. +function! s:to_plugin_name(fn_name) abort + return substitute(a:fn_name, + \ '\v.*health\#(.+)\#check.*', '\1', '') endfunction |