vim/syntastic
1
0
Fork 0
Code Issues Pull Requests Releases Wiki Activity

README: minor updates, rewording, and formatting.

Browse Source
This commit is contained in:
LCD 47 2014-03-04 11:13:43 +02:00
parent c18065ea52
commit ae65cbac4f
1 changed files with 56 additions and 50 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

104
README.markdown
View File

@ -43,7 +43,7 @@ LLVM intermediate language, Lua, MATLAB, NASM, Objective-C, Objective-C++,
OCaml, Perl, Perl POD, PHP, gettext Portable Object, Puppet, Python, Racket, OCaml, Perl, Perl POD, PHP, gettext Portable Object, Puppet, Python, Racket,
reStructuredText, Ruby, Rust, SASS/SCSS, Scala, Slim, Tcl, TeX, Texinfo, Twig, reStructuredText, Ruby, Rust, SASS/SCSS, Scala, Slim, Tcl, TeX, Texinfo, Twig,
TypeScript, Vala, Verilog, VHDL, VimL, xHtml, XML, XSLT, YACC, YAML, z80, Zope TypeScript, Vala, Verilog, VHDL, VimL, xHtml, XML, XSLT, YACC, YAML, z80, Zope
page templates, zsh. page templates, and zsh.
Below is a screenshot showing the methods that Syntastic uses to display syntax Below is a screenshot showing the methods that Syntastic uses to display syntax
errors. Note that, in practise, you will only have a subset of these methods errors. Note that, in practise, you will only have a subset of these methods
@ -62,45 +62,48 @@ enabled.
## 2\. Installation ## 2\. Installation
Installing syntastic is easy but first you need to have the pathogen plugin installed. If you already Installing syntastic is easy but first you need to have the [pathogen][1]
have pathogen working then skip Step 1 and go to Step 2. plugin installed. If you already have [pathogen][1] working then skip
[Step 1](#step1) and go to [Step 2](#step2).
<a name="step1"></a> <a name="step1"></a>
### 2.1\. Step 1: Install pathogen.vim ### 2.1\. Step 1: Install pathogen.vim
First I'll show you how to install tpope's [pathogen.vim][1] so that it's First I'll show you how to install Tim Pope's [pathogen][1] so that it's easy to
easy to install syntastic. Do this in your Terminal so that you get the install syntastic. Do this in your terminal so that you get the `pathogen.vim`
pathogen.vim file and the directories it needs: file and the directories it needs:
```sh
mkdir -p ~/.vim/autoload ~/.vim/bundle; \ mkdir -p ~/.vim/autoload ~/.vim/bundle; \
curl -so ~/.vim/autoload/pathogen.vim \ curl -so ~/.vim/autoload/pathogen.vim \
https://raw.github.com/tpope/vim-pathogen/master/autoload/pathogen.vim https://raw.github.com/tpope/vim-pathogen/master/autoload/pathogen.vim
```
Next you *need to add this* to your ~/.vimrc: Next you *need* to add this to your `~/.vimrc`:
```vim
execute pathogen#infect() execute pathogen#infect()
```
<a name="step2"></a> <a name="step2"></a>
### 2.2\. Step 2: Install syntastic as a pathogen bundle ### 2.2\. Step 2: Install syntastic as a pathogen bundle
You now have pathogen installed and can put syntastic into ~/.vim/bundle like this: You now have pathogen installed and can put syntastic into `~/.vim/bundle` like
this:
```sh
cd ~/.vim/bundle cd ~/.vim/bundle
git clone https://github.com/scrooloose/syntastic.git git clone https://github.com/scrooloose/syntastic.git
```
Quit vim and start it back up to reload it, then type: Quit vim and start it back up to reload it, then type:
```vim
:Helptags
```
If you get an error when you do this, then you probably didn't install
[pathogen][1] right. Go back to [Step 1](#step1) and make sure you did the following:
:Helptags 1. Created both the `~/.vim/autoload` and `~/.vim/bundle` directories.
2. Added the `call pathogen#infect()` line to your `~/.vimrc` file
If you get an error when you do this, then you probably didn't install pathogen right. Go back to 3. Did the `git clone` of syntastic inside `~/.vim/bundle`
step 1 and make sure you did the following:
1. Created both the ~/.vim/autoload and ~/.vim/bundle directories.
2. Added the "call pathogen#infect()" line to your ~/.vimrc file
3. Did the git clone of syntastic inside ~/.vim/bundle
4. Have permissions to access all of these directories. 4. Have permissions to access all of these directories.
@ -111,12 +114,11 @@ step 1 and make sure you did the following:
__Q. I installed syntastic but it isn't reporting any errors...__ __Q. I installed syntastic but it isn't reporting any errors...__
A. The most likely reason is that none of the syntax checkers that it requires A. The most likely reason is that none of the syntax checkers that it requires
is installed. For example: python requires either `flake8`, `pyflakes` is installed. For example: python requires either `flake8`, `pyflakes` or
or `pylint` to be installed and in `$PATH`. To see which executables are `pylint` to be installed and in your `$PATH`. To see which executables are
supported, just look in `syntax_checkers/<filetype>/*.vim`. Note that aliases supported, look at the [wiki][3]. Note that aliases do not work; the actual
do not work; the actual executable must be available in your `$PATH`. Symbolic executables must be available in your `$PATH`. Symbolic links are okay though.
links are okay. You can see syntastic's idea of available checkers by running You can see syntastic's idea of available checkers by running `:SyntasticInfo`.
`:SyntasticInfo`.
Another reason it could fail is that either the command line options or the Another reason it could fail is that either the command line options or the
error output for a syntax checker may have changed. In this case, make sure you error output for a syntax checker may have changed. In this case, make sure you
@ -128,37 +130,34 @@ __Q. The `perl` checker has stopped working...__
A. The `perl` checker runs `perl -c` against your file, which in turn A. The `perl` checker runs `perl -c` against your file, which in turn
__executes__ any `BEGIN`, `UNITCHECK`, and `CHECK` blocks, and any `use` __executes__ any `BEGIN`, `UNITCHECK`, and `CHECK` blocks, and any `use`
statements in your file (cf. [perlrun][10]). This is probably fine if you statements in your file (cf. [perlrun][10]). This is probably fine if you
wrote the file yourself, but it's a security hazard if you're checking third wrote the file yourself, but it's a security problem if you're checking third
party files. Since there is currently no way to disable this behaviour while party files. Since there is currently no way to disable this behaviour while
still producing useful results, the checker is now disabled by default. To still producing useful results, the checker is now disabled by default. To
(re-)enable it, set `g:syntastic_enable_perl_checker` to 1 in your vimrc: (re-)enable it, set `g:syntastic_enable_perl_checker` to 1 in your vimrc:
```vim ```vim
let g:syntastic_enable_perl_checker = 1 let g:syntastic_enable_perl_checker = 1
``` ```
__Q. I run a checker and the location list is not updated...__ __Q. I run a checker and the location list is not updated...__
A. By default, the location list is changed only when you run the `:Errors` A. By default the location list is changed only when you run the `:Errors`
command, in order to minimise conflicts with other plugins. If you want the command, in order to minimise conflicts with other plugins. If you want the
location list to always be updated when you run the checkers, add this line to location list to always be updated when you run the checkers, add this line to
your vimrc: your vimrc:
```vim ```vim
let g:syntastic_always_populate_loc_list=1 let g:syntastic_always_populate_loc_list = 1
``` ```
__Q. How can I pass additional arguments to a checker?__ __Q. How can I pass additional arguments to a checker?__
A. Almost all syntax checkers use the `makeprgBuild()` function. Those checkers A. Almost all syntax checkers use the `makeprgBuild()` function. Those checkers
that do can be configured using global variables. The general form of the that do can be configured using global variables. The general form of the
global args variables are: global `args` variables is `syntastic_<filetype>_<checker>_args`.
```vim
syntastic_<filetype>_<subchecker>_args
```
So, If you wanted to pass "--my --args --here" to the ruby mri checker you So, If you wanted to pass "--my --args --here" to the ruby mri checker you
would add this line to your vimrc: would add this line to your vimrc:
```vim ```vim
let g:syntastic_ruby_mri_args="--my --args --here" let g:syntastic_ruby_mri_args = "--my --args --here"
``` ```
See `:help syntastic-checker-options` for more information. See `:help syntastic-checker-options` for more information.
@ -168,24 +167,24 @@ which one(s) to use?__
A. Stick a line like this in your vimrc: A. Stick a line like this in your vimrc:
```vim ```vim
let g:syntastic_<filetype>_checkers=['<checker-name>'] let g:syntastic_<filetype>_checkers = ['<checker-name>']
``` ```
To see the list of checkers for your filetype, look in To see the list of supported checkers for your filetype look at the
`syntax_checkers/<filetype>/`. [wiki][3].
e.g. Python has the following checkers: `flake8`, `pyflakes`, `pylint` and a e.g. Python has the following checkers, among others: `flake8`, `pyflakes`,
native `python` checker. `pylint` and a native `python` checker.
To tell syntastic to use `pylint`, you would use this setting: To tell syntastic to use `pylint`, you would use this setting:
```vim ```vim
let g:syntastic_python_checkers=['pylint'] let g:syntastic_python_checkers = ['pylint']
``` ```
Some filetypes, like PHP, have style checkers as well as syntax checkers. These Some filetypes, like PHP, have style checkers as well as syntax checkers. These
can be chained together like this: can be chained together like this:
```vim ```vim
let g:syntastic_php_checkers=['php', 'phpcs', 'phpmd'] let g:syntastic_php_checkers = ['php', 'phpcs', 'phpmd']
``` ```
This is telling syntastic to run the `php` checker first, and if no errors are This is telling syntastic to run the `php` checker first, and if no errors are
@ -208,6 +207,13 @@ checkers. You can usually configure the options that are passed to the style
checkers, or just disable them. Take a look at the [wiki][3] to see what checkers, or just disable them. Take a look at the [wiki][3] to see what
options are available. options are available.
Alternatively, you can use `g:syntastic_quiet_messages` to filter out the
messages you don't want to see. e.g. To turn off all style messages:
```vim
let g:syntastic_quiet_messages = { "type": "style" }
```
See `:help syntastic_quiet_messages` for details.
__Q. The error window is closed automatically when I :quit the current buffer __Q. The error window is closed automatically when I :quit the current buffer
but not when I :bdelete it?__ but not when I :bdelete it?__