18
18
19
19
20
20
- - -
21
- 1 . [ Introduction] ( #introduction )
22
- 2 . [ Installation] ( #installation )
23
- 2.1. [ Requirements] ( #requirements )
24
- 2.2. [ Installing syntastic with Pathogen] ( #installpathogen )
25
- 3 . [ Recommended settings] ( #settings )
26
- 4 . [ FAQ] ( #faq )
27
- 4.1. [ I installed syntastic but it isn't reporting any errors...] ( #faqinfo )
28
- 4.2. [ Syntastic supports several checkers for my filetype, how do I tell it which one(s) to use?] ( #faqcheckers )
29
- 4.3. [ How can I run checkers for "foreign" filetypes against the current file?] ( #faqforeign )
30
- 4.4. [ I have enabled multiple checkers for the current filetype. How can I display all errors from all checkers together?] ( #faqaggregate )
31
- 4.5. [ How can I pass additional arguments to a checker?] ( #faqargs )
32
- 4.6. [ I run a checker and the location list is not updated...] ( #faqloclist )
33
- 4.6. [ I run` :lopen ` or ` :lwindow ` and the error window is empty...] ( #faqloclist )
34
- 4.7. [ How can I jump between the different errors without using the location list at the bottom of the window?] ( #faqlnext )
35
- 4.8. [ The error window is closed automatically when I ` :quit ` the current buffer but not when I ` :bdelete ` it?] ( #faqbdelete )
36
- 4.9. [ My favourite checker needs to load a configuration file from the project's root rather than the current directory...] ( #faqconfig )
37
- 4.10. [ What is the difference between syntax checkers and style checkers?] ( #faqstyle )
38
- 4.11. [ How can I check scripts written for different versions of Python?] ( #faqpython )
39
- 4.12. [ How can I check scripts written for different versions of Ruby?] ( #faqruby )
40
- 4.13. [ The ` perl ` checker has stopped working...] ( #faqperl )
41
- 4.14. [ What happened to the ` rustc ` checker?] ( #faqrust )
42
- 4.15. [ What happened to the ` tsc ` checker?] ( #faqtsc )
43
- 4.16. [ What happened to the ` xcrun ` checker?] ( #faqxcrun )
44
- 4.17. [ What happened to the ` valac ` checker?] ( #faqvalac )
45
- 4.18. [ What happened to the Julia ` lint ` checker?] ( #faqjulialint )
46
- 5 . [ Resources] ( #otherresources )
21
+ 1 . [ Deprecation note] ( #deprecation )
22
+ 2 . [ Introduction] ( #introduction )
23
+ 3 . [ Installation] ( #installation )
24
+ 3.1. [ Requirements] ( #requirements )
25
+ 3.2. [ Installing syntastic with Pathogen] ( #installpathogen )
26
+ 4 . [ Recommended settings] ( #settings )
27
+ 5 . [ FAQ] ( #faq )
28
+ 5.1. [ I installed syntastic but it isn't reporting any errors...] ( #faqinfo )
29
+ 5.2. [ Syntastic supports several checkers for my filetype, how do I tell it which one(s) to use?] ( #faqcheckers )
30
+ 5.3. [ How can I run checkers for "foreign" filetypes against the current file?] ( #faqforeign )
31
+ 5.4. [ I have enabled multiple checkers for the current filetype. How can I display all errors from all checkers together?] ( #faqaggregate )
32
+ 5.5. [ How can I pass additional arguments to a checker?] ( #faqargs )
33
+ 5.6. [ I run a checker and the location list is not updated...] ( #faqloclist )
34
+ 5.6. [ I run` :lopen ` or ` :lwindow ` and the error window is empty...] ( #faqloclist )
35
+ 5.7. [ How can I jump between the different errors without using the location list at the bottom of the window?] ( #faqlnext )
36
+ 5.8. [ The error window is closed automatically when I ` :quit ` the current buffer but not when I ` :bdelete ` it?] ( #faqbdelete )
37
+ 5.9. [ My favourite checker needs to load a configuration file from the project's root rather than the current directory...] ( #faqconfig )
38
+ 5.10. [ What is the difference between syntax checkers and style checkers?] ( #faqstyle )
39
+ 5.11. [ How can I check scripts written for different versions of Python?] ( #faqpython )
40
+ 5.12. [ How can I check scripts written for different versions of Ruby?] ( #faqruby )
41
+ 5.13. [ The ` perl ` checker has stopped working...] ( #faqperl )
42
+ 5.14. [ What happened to the ` rustc ` checker?] ( #faqrust )
43
+ 5.15. [ What happened to the ` tsc ` checker?] ( #faqtsc )
44
+ 5.16. [ What happened to the ` xcrun ` checker?] ( #faqxcrun )
45
+ 5.17. [ What happened to the ` valac ` checker?] ( #faqvalac )
46
+ 5.18. [ What happened to the Julia ` lint ` checker?] ( #faqjulialint )
47
+ 6 . [ Resources] ( #otherresources )
47
48
48
49
- - -
49
50
51
+ <a name =" deprecation " ></a >
52
+
53
+ ## 1\. Deprecation note
54
+
55
+ This project is no longer maintained. If you need a syntax checking plugin
56
+ for [ Vim] [ vim ] you might be interested in Syntastic's spiritual succesor,
57
+ [ ALE] [ ale ] . Although it shares no code with syntastic and it takes a very
58
+ different approach to design, [ ALE] [ ale ] can be considered a natural evolution
59
+ of syntastic in terms of goals and functionality. Check it out, you probably
60
+ won't be disappointed.
61
+
50
62
<a name =" introduction " ></a >
51
63
52
- ## 1 \. Introduction
64
+ ## 2 \. Introduction
53
65
54
66
Syntastic is a syntax checking plugin for [ Vim] [ vim ] created by
55
67
[ Martin Grenfell] [ scrooloose ] . It runs files through external syntax checkers
@@ -95,11 +107,11 @@ enabled.
95
107
96
108
<a name =" installation " ></a >
97
109
98
- ## 2 \. Installation
110
+ ## 3 \. Installation
99
111
100
112
<a name =" requirements " ></a >
101
113
102
- ### 2 .1\. Requirements
114
+ ### 3 .1\. Requirements
103
115
104
116
Syntastic itself has rather relaxed requirements: it doesn't have any external
105
117
dependencies, and it needs a version of [ Vim] [ vim ] compiled with a few common
@@ -128,14 +140,14 @@ checkers.
128
140
129
141
<a name =" installpathogen " ></a >
130
142
131
- ### 2 .2\. Installing syntastic with Pathogen
143
+ ### 3 .2\. Installing syntastic with Pathogen
132
144
133
145
If you already have [ Pathogen] [ pathogen ] working then skip [ Step 1] ( #step1 ) and go to
134
146
[ Step 2] ( #step2 ) .
135
147
136
148
<a name =" step1 " ></a >
137
149
138
- #### 2 .2.1\. Step 1: Install pathogen.vim
150
+ #### 3 .2.1\. Step 1: Install pathogen.vim
139
151
140
152
First I'll show you how to install Tim Pope's [ Pathogen] [ pathogen ] so that it's easy to
141
153
install syntastic. Do this in your terminal so that you get the ` pathogen.vim `
@@ -151,7 +163,7 @@ execute pathogen#infect()
151
163
152
164
<a name =" step2 " ></a >
153
165
154
- #### 2 .2.2\. Step 2: Install syntastic as a Pathogen bundle
166
+ #### 3 .2.2\. Step 2: Install syntastic as a Pathogen bundle
155
167
156
168
You now have pathogen installed and can put syntastic into ` ~/.vim/bundle ` like
157
169
this:
@@ -174,7 +186,7 @@ following:
174
186
175
187
<a name =" settings " ></a >
176
188
177
- ## 3 \. Recommended settings
189
+ ## 4 \. Recommended settings
178
190
179
191
Syntastic has numerous options that can be configured, and the defaults
180
192
are not particularly well suitable for new users. It is recommended
@@ -193,11 +205,11 @@ let g:syntastic_check_on_wq = 0
193
205
194
206
<a name =" faq " ></a >
195
207
196
- ## 4 \. FAQ
208
+ ## 5 \. FAQ
197
209
198
210
<a name =" faqinfo " ></a >
199
211
200
- __ 4 .1. Q. I installed syntastic but it isn't reporting any errors...__
212
+ __ 5 .1. Q. I installed syntastic but it isn't reporting any errors...__
201
213
202
214
A. The most likely reason is that none of the syntax checkers that it requires
203
215
are installed. For example: by default, python requires either ` flake8 ` or
@@ -236,7 +248,7 @@ fails then post an [issue][bug_tracker] - or better yet, create a pull request.
236
248
237
249
<a name =" faqcheckers " ></a >
238
250
239
- __ 4 .2. Q. Syntastic supports several checkers for my filetype, how do I tell it
251
+ __ 5 .2. Q. Syntastic supports several checkers for my filetype, how do I tell it
240
252
which one(s) to use?__
241
253
242
254
A. Add a line like this to your ` vimrc ` :
@@ -273,7 +285,7 @@ aren't listed in `g:syntastic_<filetype>_checkers`.
273
285
274
286
<a name =" faqforeign " ></a >
275
287
276
- __ 4 .3. Q. How can I run checkers for "foreign" filetypes against the current
288
+ __ 5 .3. Q. How can I run checkers for "foreign" filetypes against the current
277
289
file?__
278
290
279
291
A. You need to qualify the name of the "foreign" checker with the name
@@ -298,7 +310,7 @@ work as a checker.
298
310
299
311
<a name =" faqaggregate " ></a >
300
312
301
- __ 4 .4. Q. I have enabled multiple checkers for the current filetype. How can I
313
+ __ 5 .4. Q. I have enabled multiple checkers for the current filetype. How can I
302
314
display all errors from all checkers together?__
303
315
304
316
A. Set ` g:syntastic_aggregate_errors ` to 1 in your ` vimrc ` :
@@ -310,7 +322,7 @@ See `:help syntastic-aggregating-errors` for more details.
310
322
311
323
<a name =" faqargs " ></a >
312
324
313
- __ 4 .5. Q. How can I pass additional arguments to a checker?__
325
+ __ 5 .5. Q. How can I pass additional arguments to a checker?__
314
326
315
327
A. In most cases a command line is constructed using an internal function
316
328
named ` makeprgBuild() ` , which provides a number of options that allow you to
@@ -334,8 +346,8 @@ list of options should be included in the [manual][checkers]
334
346
335
347
<a name =" faqloclist " ></a >
336
348
337
- __ 4 .6. Q. I run a checker and the location list is not updated...__
338
- __ 4 .6. Q. I run` :lopen ` or ` :lwindow ` and the error window is empty...__
349
+ __ 5 .6. Q. I run a checker and the location list is not updated...__
350
+ __ 5 .6. Q. I run` :lopen ` or ` :lwindow ` and the error window is empty...__
339
351
340
352
A. By default the location list is changed only when you run the ` :Errors `
341
353
command, in order to minimise conflicts with other plugins. If you want the
@@ -347,7 +359,7 @@ let g:syntastic_always_populate_loc_list = 1
347
359
348
360
<a name =" faqlnext " ></a >
349
361
350
- __ 4 .7. Q. How can I jump between the different errors without using the location
362
+ __ 5 .7. Q. How can I jump between the different errors without using the location
351
363
list at the bottom of the window?__
352
364
353
365
A. Vim provides several built-in commands for this. See ` :help :lnext ` and
@@ -359,7 +371,7 @@ mappings (among other things).
359
371
360
372
<a name =" faqbdelete " ></a >
361
373
362
- __ 4 .8. Q. The error window is closed automatically when I ` :quit ` the current buffer
374
+ __ 5 .8. Q. The error window is closed automatically when I ` :quit ` the current buffer
363
375
but not when I ` :bdelete ` it?__
364
376
365
377
A. There is no safe way to handle that situation automatically, but you can
@@ -371,7 +383,7 @@ cabbrev <silent> bd <C-r>=(getcmdtype()==#':' && getcmdpos()==1 ? 'lclose\|bdele
371
383
372
384
<a name =" faqconfig " ></a >
373
385
374
- __ 4 .9. My favourite checker needs to load a configuration file from the
386
+ __ 5 .9. My favourite checker needs to load a configuration file from the
375
387
project's root rather than the current directory...__
376
388
377
389
A. You can set up an ` autocmd ` to search for the configuration file in the
@@ -391,7 +403,7 @@ autocmd FileType javascript let b:syntastic_javascript_jscs_args =
391
403
392
404
<a name =" faqstyle " ></a >
393
405
394
- __ 4 .10. Q. What is the difference between syntax checkers and style checkers?__
406
+ __ 5 .10. Q. What is the difference between syntax checkers and style checkers?__
395
407
396
408
A. The errors and warnings they produce are highlighted differently and can
397
409
be filtered by different rules, but otherwise the distinction is pretty much
@@ -421,7 +433,7 @@ See `:help syntastic_quiet_messages` for more information.
421
433
422
434
<a name =" faqpython " ></a >
423
435
424
- __ 4 .11. Q. How can I check scripts written for different versions of Python?__
436
+ __ 5 .11. Q. How can I check scripts written for different versions of Python?__
425
437
426
438
A. Install a Python version manager such as [ virtualenv] [ virtualenv ]
427
439
or [ pyenv] [ pyenv ] , activate the environment for the relevant version
@@ -437,7 +449,7 @@ scripts.
437
449
438
450
<a name =" faqruby " ></a >
439
451
440
- __ 4 .12. Q. How can I check scripts written for different versions of Ruby?__
452
+ __ 5 .12. Q. How can I check scripts written for different versions of Ruby?__
441
453
442
454
A. Install a Ruby version manager such as [ rvm] [ rvm ] or [ rbenv] [ rbenv ] ,
443
455
activate the relevant version of Ruby, and install in it the checkers you want
@@ -452,7 +464,7 @@ before running the actual checks. Then you'll need to point the relevant
452
464
453
465
<a name =" faqperl " ></a >
454
466
455
- __ 4 .13. Q. The ` perl ` checker has stopped working...__
467
+ __ 5 .13. Q. The ` perl ` checker has stopped working...__
456
468
457
469
A. The ` perl ` checker runs ` perl -c ` against your file, which in turn
458
470
__ executes__ any ` BEGIN ` , ` UNITCHECK ` , and ` CHECK ` blocks, and any ` use `
@@ -468,44 +480,44 @@ let g:syntastic_enable_perl_checker = 1
468
480
469
481
<a name =" faqrust " ></a >
470
482
471
- __ 4 .14. Q. What happened to the ` rustc ` checker?__
483
+ __ 5 .14. Q. What happened to the ` rustc ` checker?__
472
484
473
485
A. It is now part of the [ rust.vim] [ rust ] plugin. If you install this plugin the
474
486
checker should be picked up automatically by syntastic.
475
487
476
488
<a name =" faqtsc " ></a >
477
489
478
- __ 4 .15. Q. What happened to the ` tsc ` checker?__
490
+ __ 5 .15. Q. What happened to the ` tsc ` checker?__
479
491
480
492
A. It didn't meet people's expectations and it has been removed. The plugin
481
493
[ tsuquyomi] [ tsuquyomi ] comes packaged with a checker for TypeScript. If you
482
494
install this plugin the checker should be picked up automatically by syntastic.
483
495
484
496
<a name =" faqxcrun " ></a >
485
497
486
- __ 4 .16. Q. What happened to the ` xcrun ` checker?__
498
+ __ 5 .16. Q. What happened to the ` xcrun ` checker?__
487
499
488
500
A. The ` xcrun ` checker used to have a security problem and it has been removed.
489
501
A better checker for __ Swift__ is part of the [ vim-swift] [ swift ] plugin. If you
490
502
install this plugin the checker should be picked up automatically by syntastic.
491
503
492
504
<a name =" faqvalac " ></a >
493
505
494
- __ 4 .17. Q. What happened to the ` valac ` checker?__
506
+ __ 5 .17. Q. What happened to the ` valac ` checker?__
495
507
496
508
A. It is now part of the [ vala.vim] [ vala ] plugin. If you install this plugin the
497
509
checker should be picked up automatically by syntastic.
498
510
499
511
<a name =" julialint " ></a >
500
512
501
- __ 4 .18. Q. What happened to the Julia ` lint ` checker?__
513
+ __ 5 .18. Q. What happened to the Julia ` lint ` checker?__
502
514
503
515
A. It was removed, since the ` Lint.jl ` package [ has been deprecated] [ julialint ]
504
516
and no longer works with recent Julia versions.
505
517
506
518
<a name =" otherresources " ></a >
507
519
508
- ## 5 \. Resources
520
+ ## 6 \. Resources
509
521
510
522
The preferred place for posting suggestions, reporting bugs, and general
511
523
discussions related to syntastic is the [ issue tracker at GitHub] [ bug_tracker ] .
@@ -522,6 +534,8 @@ a look at [ghcmod-vim][ghcmod], [jedi-vim][jedi], [python-mode][python_mode], [v
522
534
[ scrooloose ] : https://github.com/scrooloose
523
535
[ screenshot ] : https://github.com/vim-syntastic/syntastic/raw/master/_assets/screenshot_1.png
524
536
537
+ [ ale ] : https://github.com/dense-analysis/ale
538
+
525
539
[ bug_tracker ] : https://github.com/vim-syntastic/syntastic/issues
526
540
[ checkers ] : https://github.com/vim-syntastic/syntastic/blob/master/doc/syntastic-checkers.txt
527
541
[ crystal ] : https://github.com/rhysd/vim-crystal
0 commit comments