Skip to content
This repository
Newer
Older
100644 124 lines (97 sloc) 5.488 kb
3e732826 »
2011-12-27 update readme and add a screenshot
1 ,
2 / \,,_ .'|
5413e9d8 »
2011-12-27 make a cosmetic update to readme/screenshot
3 ,{{| /}}}}/_.' _____________________________________________
3e732826 »
2011-12-27 update readme and add a screenshot
4 }}}}` '{{' '. / \
5413e9d8 »
2011-12-27 make a cosmetic update to readme/screenshot
5 {{{{{ _ ;, \ / Gentlemen, \
3e732826 »
2011-12-27 update readme and add a screenshot
6 ,}}}}}} /o`\ ` ;) | |
7 {{{{{{ / ( | this is ... |
8 }}}}}} | \ | |
9 {{{{{{{{ \ \ | |
10 }}}}}}}}} '.__ _ | | _____ __ __ _ |
11 {{{{{{{{ /`._ (_\ / | / ___/__ ______ / /_____ ______/ /_(_)____ |
12 }}}}}}' | //___/ --=: \__ \/ / / / __ \/ __/ __ `/ ___/ __/ / ___/ |
13 jgs `{{{{` | '--' | ___/ / /_/ / / / / /_/ /_/ (__ ) /_/ / /__ |
14 }}}` | /____/\__, /_/ /_/\__/\__,_/____/\__/_/\___/ |
15 | /____/ |
5413e9d8 »
2011-12-27 make a cosmetic update to readme/screenshot
16 | /
17 \_____________________________________________/
3e732826 »
2011-12-27 update readme and add a screenshot
18
19
20
21
22 Syntastic is a syntax checking plugin that runs files through external syntax
23 checkers and displays any resulting errors to the user. This can be done on
24 demand, or automatically as files are saved. If syntax errors are detected, the
25 user is notified and is happy because they didn't have to compile their code or
26 execute their script to find them.
27
28 At the time of this writing, syntax checking plugins exist for applescript, c,
29 coffee, cpp, css, cucumber, cuda, docbk, erlang, eruby, fortran,
30 gentoo_metadata, go, haml, haskell, html, javascript, json, less, lua, matlab,
31 perl, php, puppet, python, rst, ruby, sass/scss, sh, tcl, tex, vala, xhtml,
32 xml, xslt, yaml, zpt
33
34 Screenshot
35 ----------
36
37 Below is a screenshot showing the methods that Syntastic uses to display syntax
38 errors. Note that, in practise, you will only have a subset of these methods
39 enabled.
40
41 ![Screenshot 1](https://github.com/scrooloose/syntastic/raw/master/_assets/screenshot_1.png)
42
c8dc739e »
2011-12-27 update the readme
43 1. Errors are loaded into the location list for the corresponding window.
44 2. When the cursor is on a line containing an error, the error message is echoed in the command window.
45 3. Signs are placed beside lines with errors - note that warnings are displayed in a different color.
46 4. There is a configurable statusline flag you can include in your statusline config.
47 5. Hover the mouse over a line containing an error and the error message is displayed as a balloon.
48 6. (not shown) Highlighting errors with syntax highlighting. Erroneous parts of lines can be highlighted.
f2b9d24e »
2011-11-30 add README
49
50 Installation
51 ------------
52
53 [pathogen.vim](https://github.com/tpope/vim-pathogen) is the recommended way to install syntastic.
54
55 cd ~/.vim/bundle
56 git clone https://github.com/scrooloose/syntastic.git
57
66e69dc3 »
2012-02-27 Revert "Revert "Spent a while trying to figure out why :helptags wasn…
58 Then reload vim, run `:Helptags`, and check out `:help syntastic.txt`.
1a20c871 »
2011-12-13 add a note about the google group to the readme
59
60
61 Google group
62 ------------
63
64 To get information or make suggestions check out the [google group](https://groups.google.com/group/vim-syntastic).
e34f8dfc »
2011-12-13 insert the changelog (from 2.0.0) into the readme
65
66
de9f81b7 »
2012-03-01 add an FAQ to the readme
67 FAQ
68 ---
69
70 __Q. I installed syntastic but it isn't reporting any errors ...__
71
72 A. The most likely reason is that the syntax checker that it requires isn't installed. For example: python requires either `flake8`, `pyflakes` or `pylint` to be installed and in `$PATH`. To see which executable is required, just look in `syntax_checkers/<filetype>.vim`.
73
74 Another reason it could fail is that the error output for the syntax checker may have changed. In this case, make sure you have the latest version of the syntax checker installed. If it still fails then create an issue - or better yet, create a pull request.
75
76
e34f8dfc »
2011-12-13 insert the changelog (from 2.0.0) into the readme
77 Changelog
78 ---------
3e80184d »
2012-02-16 bump to v2.3.0 and update changelog and credits
79 2.3.0 (16-feb-2012)
80
81 * Add syntastic_loc_list_height option
82 * Allow errors to have a "subtype" that is signed differently to standard
83 errors. Currently geared towards differentiating style errors from
84 syntax errors. Currently implemented for phpcs (technosophos).
85 * New checkers for:
86 * yaml
87 * haxe (davidB)
88 * ocaml (edwintorok)
89 * pylint (parantapa)
90 * rust (cjab)
91 * Updates to existing checkers:
92 * jslint
93 * jshint (gillesruppert)
94 * fortran (bmattern)
95 * sass
96 * html (darcyparker)
97 * coffee (darcyparker)
98 * docbk (darcyparker)
99 * xml
100 * xslt
101 * less (irrationalfab)
102 * php (AD7six, technosophos)
103 * cuda
104 * python (mitchellh, pneff)
105 * perl (Anthony Carapetis)
106 * c (naoina, zsprackett)
107 * puppet (frimik)
e34f8dfc »
2011-12-13 insert the changelog (from 2.0.0) into the readme
108
54896bec »
2011-12-24 bump to 2.2.0 and update changelog
109 2.2.0 (24-dec-2011)
110
111 * only do syntax checks when files are saved (not when first opened) - add g:syntastic_check_on_open option to get the old behavior back
112 * bug fix with echoing error messages; fixes incompatability with cmd-t (datanoise)
113 * dont allow warnings to mask errors when signing/echoing errors (ashikase)
114 * auto close location list when leaving buffer. (millermedeiros)
115 * update errors appropriately when :SyntasticToggleMode is called
116 * updates/fixes to existing checkers:
117 * javascript/jshint (millermedeiros)
118 * javascript/jslint
119 * c (kongo2002)
120 * Support for new filetypes:
121 * JSON (millermedeiros, tocer)
122 * rst (reStructuredText files) (JNRowe)
123 * gentoo-metadata (JNRowe)
Something went wrong with that request. Please try again.