https://github.com/xojs/vim-xo

Vim plugin for XO
https://github.com/xojs/vim-xo

editor-plugin formatting linting syntastic vim vim-autoformat vim-plugin xo

Last synced: 3 months ago
JSON representation

Vim plugin for XO

• Host: GitHub
• URL: https://github.com/xojs/vim-xo
• Owner: xojs
• License: mit
• Created: 2017-01-12T09:56:13.000Z (about 8 years ago)
• Default Branch: main
• Last Pushed: 2024-01-29T19:40:27.000Z (12 months ago)
• Last Synced: 2024-03-25T20:07:47.669Z (10 months ago)
• Topics: editor-plugin, formatting, linting, syntastic, vim, vim-autoformat, vim-plugin, xo
• Language: Vim Script
• Homepage: https://github.com/xojs/xo
• Size: 5.86 KB
• Stars: 51
• Watchers: 7
• Forks: 2
• Open Issues: 1
• Metadata Files:
  • Readme: readme.md
  • License: license

Awesome Lists containing this project

README

        
# vim-xo

> Vim plugin for [XO](https://github.com/xojs/xo) that provides [Syntastic](https://github.com/vim-syntastic/syntastic) integration

## Install

### Using [Pathogen](https://github.com/tpope/vim-pathogen)

```

$ git clone --depth=1 https://github.com/xojs/vim-xo ~/.vim/bundle/vim-xo

```

### Using [Vundle](https://github.com/VundleVim/Vundle.vim)

1. Add `Plugin 'xojs/vim-xo'` to `~/.vimrc`

2. `:PluginInstall` or `$ vim +PluginInstall +qall`

### Using [NeoBundle](https://github.com/Shougo/neobundle.vim)

1. Add `NeoBundle 'xojs/vim-xo'` to `~/.vimrc`

2. Re-open vim or execute `:source ~/.vimrc`

### Using [vim-plug](https://github.com/junegunn/vim-plug)

1. Add `Plug 'xojs/vim-xo'` to `~/.vimrc`

2. `:PlugInstall` or `$ vim +PlugInstall +qall`

## Features

### Linting with [Syntastic](https://github.com/vim-syntastic/syntastic)

This plugin automatically registers XO as a syntax checker with Syntastic.

To activate XO, put the following in your `.vimrc` file:

```vim

let g:syntastic_javascript_checkers = ['xo']

let g:syntastic_typescript_checkers = ['xo']

```

See the Syntastic [docs](https://github.com/vim-syntastic/syntastic/blob/master/doc/syntastic.txt) for more.

### Formatting with [vim-autoformat](https://github.com/Chiel92/vim-autoformat)

Formatting with `vim-autoformat` will *just work* (since this plugin uses `npx xo`).

You do not need to install `xo` globally (and if it is installed globally, then please remove it as [global installation is deprecated](https://github.com/xojs/xo/releases/tag/v0.41.0)).

Once you install `vim-autoformat`, you will need to add the following to your `~/.vimrc`:

```diff

+" vim-autoformatter

+" https://github.com/vim-autoformat/vim-autoformat

+let g:autoformat_autoindent = 0

+let g:autoformat_retab = 0

+let g:autoformat_remove_trailing_spaces = 0

+let g:formatters_javascript = [ 'xo_javascript' ]

+let g:formatters_typescript = [ 'xo_typescript' ]

```

If you'd like your code to be formatted on save (instead of typing `:Autoformat` in vim buffer), then also add this line to your `~/.vimrc`:

```diff

+au BufWrite * :Autoformat

```

See [vim-autoformat](https://github.com/vim-autoformat/vim-autoformat#how-to-use)'s "How to use" section for more information.

## License

MIT © [Sindre Sorhus](https://sindresorhus.com)