https://github.com/rhysd/vim-healthcheck

Polyfill of Neovim's health-check for Vim
https://github.com/rhysd/vim-healthcheck

healthcheck vim-plugin

Last synced: 18 days ago
JSON representation

Polyfill of Neovim's health-check for Vim

• Host: GitHub
• URL: https://github.com/rhysd/vim-healthcheck
• Owner: rhysd
• License: other
• Created: 2018-01-26T12:01:08.000Z (almost 7 years ago)
• Default Branch: master
• Last Pushed: 2022-07-22T09:21:01.000Z (over 2 years ago)
• Last Synced: 2024-10-05T12:32:45.884Z (29 days ago)
• Topics: healthcheck, vim-plugin
• Language: Vim script
• Homepage:
• Size: 20.5 KB
• Stars: 38
• Watchers: 4
• Forks: 3
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
Polyfill for `:checkhealth` in Vim

==================================

[vim-healthcheck][] is a polyfill plugin for Vim to use a health-check feature in [Neovim][]. Neovim's

health-check feature is a minimal framework to help with troubleshooting user configuration.

[vim-healthcheck][] provides the same feature for Vim.

Plugin authors can write health-checks for their plugins using the APIs. And plugin users can check

if the installation is healthy. By this polyfill, plugin authors can write common health-checks for

both Neovim and Vim. And plugin users can check their configuration using the health-checks which

was written for Neovim. It would be useful for troubleshooting or triaging issues.

This plugin is just a port of Neovim's health-check implementation.

## Usage

Instead of Neovim's standard `:checkhealth` command, it provides `:CheckHealth` command on Vim.

If no argument is given, it runs all health-checks and show the results.

```

:CheckHealth

```

If some plugin names are specified as arguments, it runs health-checks for them.

```

:CheckHealth {plugin1} {plugin2} ...

```

For example, `:CheckHealth vim` runs health-checks for Vim itself.

To know the detail of the command behavior or to know how to implement health-checks for your plugins,

please read a help document.

```

:help health

```

## Installation

If you use a plugin manager, please follow the instruction. Please note that this plugin is needed

only on Vim because Neovim supports health-check feature by default.

### vim-plug

```vim

if !has('nvim')

    Plug 'rhysd/vim-healthcheck'

endif

```

### dein.vim

```vim

if !has('nvim')

    call dein#add('rhysd/vim-healthcheck')

endif

```

### minpac

```vim

if !has('nvim')

    call minpac#add('rhysd/vim-healthcheck')

endif

```

## License

This plugin was created by porting the implementation of health-check feature for Neovim. So this

plugin is distributed under the same license as Neovim. Please read [LICENSE](LICENSE) for the

details.

[vim-healthcheck]: https://github.com/rhysd/vim-healthcheck

[Neovim]: https://github.com/neovim/neovim