https://github.com/machakann/vim-vimhelplint

A lint tool for vim help files.
https://github.com/machakann/vim-vimhelplint

Last synced: 1 day ago
JSON representation

A lint tool for vim help files.

• Host: GitHub
• URL: https://github.com/machakann/vim-vimhelplint
• Owner: machakann
• Created: 2016-02-12T09:04:47.000Z (almost 9 years ago)
• Default Branch: master
• Last Pushed: 2024-12-31T07:11:31.000Z (20 days ago)
• Last Synced: 2024-12-31T08:19:29.744Z (20 days ago)
• Language: Vim Script
• Size: 37.1 KB
• Stars: 34
• Watchers: 5
• Forks: 2
• Open Issues: 1
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

        
# vim-vimhelplint

## How to use

1. Install **vim-vimhelplint**

    - Copy `ftplugin/help_lint.vim` to your `~/.vim/ftplugin/help_lint.vim`.

    - Or you can use your favorite plugin manager ([Vundle](https://github.com/gmarik/Vundle.vim), [Neobundle](https://github.com/Shougo/neobundle.vim), [vim-plug](https://github.com/junegunn/vim-plug)).

    ```vim

    " Vundle

    Plugin 'machakann/vim-vimhelplint'

    " Neobundle

    NeoBundle 'machakann/vim-vimhelplint'

    " vim-plug

    Plug 'machakann/vim-vimhelplint'

    ```

1. Open Vim and edit your help file: `:edit path/to/your_help_file.txt`

1. Execute the ex command `:VimhelpLint`, and it will report errors to the

   quickfix list. You can use e.g. `:copen` to open the list then.

   Use `:VimhelpLint!` to open the quickfix window automatically.

---

Or if you are using [Neomake](https://github.com/neomake/neomake), run the shell command in the root directory of Neomake plugin.

```

make build/vimhelplint

```

Then it automatically downloads vimhelplint, you can run it by:

```

:Neomake vimhelplint

```

## Integration in CI

You can run the plugin automatically as follows, e.g. on Travis CI:

```sh

vim -esN --cmd 'set rtp+=path/to/vim-vimhelplint' -c 'filetype plugin on' \

    -c 'e doc/yourplugin.txt' -c 'verb VimhelpLintEcho' -c q

```