https://github.com/heavenshell/vim-textlint

Wrapper for textlint
https://github.com/heavenshell/vim-textlint

textlint vim

Last synced: about 21 hours ago
JSON representation

Wrapper for textlint

• Host: GitHub
• URL: https://github.com/heavenshell/vim-textlint
• Owner: heavenshell
• License: bsd-3-clause
• Created: 2016-07-10T12:27:28.000Z (over 8 years ago)
• Default Branch: master
• Last Pushed: 2021-05-15T02:59:20.000Z (over 3 years ago)
• Last Synced: 2023-03-10T20:08:08.168Z (over 1 year ago)
• Topics: textlint, vim
• Language: Vim script
• Size: 2.25 MB
• Stars: 26
• Watchers: 3
• Forks: 2
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# vim-textlint

[![Build Status](https://travis-ci.org/heavenshell/vim-textlint.svg?branch=master)](https://travis-ci.org/heavenshell/vim-textlint)

Wrapper for [textlint](https://textlint.github.io/).

![Asynchronous textlint](./assets/vim-textlint.gif)

## Motivations

I want to load `textlint` config file dynamically.

[Syntastic](https://github.com/scrooloose/syntastic) can use `textlint` but not support config file.

[watchdocs.vim](https://github.com/osyo-manga/vim-watchdogs) also has `textlint` settings but not supporting config file.

## Configure

Add `textlint` config file name to your `.vimrc`.

```viml

" textlint.vim {{{

let g:textlint_configs = [

  \ '@azu/textlint-config-readme',

  \ '@example/textlint-config-example',

  \ ]

" }}}

```

## Usage

```viml

:Textlint

:cwindow

```

If you did not set any args, `vim-textlint` would use `g:textlint_configs`'s first value or `textlintrc`.

```viml

:Textlint -c @example/textlint-config-example

:cwindow

```

You can select `textlint` config file via command line.

## Autofix

If rules are fixable, you can autofix with `TextlintFix`.

## Helpful plugins

[QuickFixstatus](https://github.com/dannyob/quickfixstatus) shows error message at the bottom of the screen.

[Hier](https://github.com/cohama/vim-hier) will highlight `quickfix` errors and location list entries in buffer.

## Sample settings

After run `:Textlint` textlint.vim would show errors if error exists.

- Show QuickFix error in statusline, and highlight QuickFix errors run

  quickfixstatus.vim and vim-hier.

```viml

  function! s:textlint_after(...)

    execute ':QuickfixStatusEnable'

    execute ':HierUpdate'

  endfunction

  let g:textlint_callbacks = {

    \ 'after_run': function('s:textlint_after')

    \ }

  autocmd BufWritePost *.md call textlint#run()

  autocmd InsertLeave *.md call textlint#run()

  " TextChanged triggered very often, turn off if Vim is slow.

  autocmd TextChanged,TextChangedI *.md call textlint#run()

```