Skip to content
This repository was archived by the owner on Sep 20, 2023. It is now read-only.

Commit 6f638ed

Browse files
committed
README: add deprecation note.
1 parent b7f4f71 commit 6f638ed

File tree

2 files changed

+69
-55
lines changed

2 files changed

+69
-55
lines changed

Diff for: README.markdown

+68-54
Original file line numberDiff line numberDiff line change
@@ -18,38 +18,50 @@
1818

1919

2020
- - -
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)
4748

4849
- - -
4950

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+
5062
<a name="introduction"></a>
5163

52-
## 1\. Introduction
64+
## 2\. Introduction
5365

5466
Syntastic is a syntax checking plugin for [Vim][vim] created by
5567
[Martin Grenfell][scrooloose]. It runs files through external syntax checkers
@@ -95,11 +107,11 @@ enabled.
95107

96108
<a name="installation"></a>
97109

98-
## 2\. Installation
110+
## 3\. Installation
99111

100112
<a name="requirements"></a>
101113

102-
### 2.1\. Requirements
114+
### 3.1\. Requirements
103115

104116
Syntastic itself has rather relaxed requirements: it doesn't have any external
105117
dependencies, and it needs a version of [Vim][vim] compiled with a few common
@@ -128,14 +140,14 @@ checkers.
128140

129141
<a name="installpathogen"></a>
130142

131-
### 2.2\. Installing syntastic with Pathogen
143+
### 3.2\. Installing syntastic with Pathogen
132144

133145
If you already have [Pathogen][pathogen] working then skip [Step 1](#step1) and go to
134146
[Step 2](#step2).
135147

136148
<a name="step1"></a>
137149

138-
#### 2.2.1\. Step 1: Install pathogen.vim
150+
#### 3.2.1\. Step 1: Install pathogen.vim
139151

140152
First I'll show you how to install Tim Pope's [Pathogen][pathogen] so that it's easy to
141153
install syntastic. Do this in your terminal so that you get the `pathogen.vim`
@@ -151,7 +163,7 @@ execute pathogen#infect()
151163

152164
<a name="step2"></a>
153165

154-
#### 2.2.2\. Step 2: Install syntastic as a Pathogen bundle
166+
#### 3.2.2\. Step 2: Install syntastic as a Pathogen bundle
155167

156168
You now have pathogen installed and can put syntastic into `~/.vim/bundle` like
157169
this:
@@ -174,7 +186,7 @@ following:
174186

175187
<a name="settings"></a>
176188

177-
## 3\. Recommended settings
189+
## 4\. Recommended settings
178190

179191
Syntastic has numerous options that can be configured, and the defaults
180192
are not particularly well suitable for new users. It is recommended
@@ -193,11 +205,11 @@ let g:syntastic_check_on_wq = 0
193205

194206
<a name="faq"></a>
195207

196-
## 4\. FAQ
208+
## 5\. FAQ
197209

198210
<a name="faqinfo"></a>
199211

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...__
201213

202214
A. The most likely reason is that none of the syntax checkers that it requires
203215
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.
236248

237249
<a name="faqcheckers"></a>
238250

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
240252
which one(s) to use?__
241253

242254
A. Add a line like this to your `vimrc`:
@@ -273,7 +285,7 @@ aren't listed in `g:syntastic_<filetype>_checkers`.
273285

274286
<a name="faqforeign"></a>
275287

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
277289
file?__
278290

279291
A. You need to qualify the name of the "foreign" checker with the name
@@ -298,7 +310,7 @@ work as a checker.
298310

299311
<a name="faqaggregate"></a>
300312

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
302314
display all errors from all checkers together?__
303315

304316
A. Set `g:syntastic_aggregate_errors` to 1 in your `vimrc`:
@@ -310,7 +322,7 @@ See `:help syntastic-aggregating-errors` for more details.
310322

311323
<a name="faqargs"></a>
312324

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?__
314326

315327
A. In most cases a command line is constructed using an internal function
316328
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]
334346

335347
<a name="faqloclist"></a>
336348

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...__
339351

340352
A. By default the location list is changed only when you run the `:Errors`
341353
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
347359

348360
<a name="faqlnext"></a>
349361

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
351363
list at the bottom of the window?__
352364

353365
A. Vim provides several built-in commands for this. See `:help :lnext` and
@@ -359,7 +371,7 @@ mappings (among other things).
359371

360372
<a name="faqbdelete"></a>
361373

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
363375
but not when I `:bdelete` it?__
364376

365377
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
371383

372384
<a name="faqconfig"></a>
373385

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
375387
project's root rather than the current directory...__
376388

377389
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 =
391403

392404
<a name="faqstyle"></a>
393405

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?__
395407

396408
A. The errors and warnings they produce are highlighted differently and can
397409
be filtered by different rules, but otherwise the distinction is pretty much
@@ -421,7 +433,7 @@ See `:help syntastic_quiet_messages` for more information.
421433

422434
<a name="faqpython"></a>
423435

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?__
425437

426438
A. Install a Python version manager such as [virtualenv][virtualenv]
427439
or [pyenv][pyenv], activate the environment for the relevant version
@@ -437,7 +449,7 @@ scripts.
437449

438450
<a name="faqruby"></a>
439451

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?__
441453

442454
A. Install a Ruby version manager such as [rvm][rvm] or [rbenv][rbenv],
443455
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
452464

453465
<a name="faqperl"></a>
454466

455-
__4.13. Q. The `perl` checker has stopped working...__
467+
__5.13. Q. The `perl` checker has stopped working...__
456468

457469
A. The `perl` checker runs `perl -c` against your file, which in turn
458470
__executes__ any `BEGIN`, `UNITCHECK`, and `CHECK` blocks, and any `use`
@@ -468,44 +480,44 @@ let g:syntastic_enable_perl_checker = 1
468480

469481
<a name="faqrust"></a>
470482

471-
__4.14. Q. What happened to the `rustc` checker?__
483+
__5.14. Q. What happened to the `rustc` checker?__
472484

473485
A. It is now part of the [rust.vim][rust] plugin. If you install this plugin the
474486
checker should be picked up automatically by syntastic.
475487

476488
<a name="faqtsc"></a>
477489

478-
__4.15. Q. What happened to the `tsc` checker?__
490+
__5.15. Q. What happened to the `tsc` checker?__
479491

480492
A. It didn't meet people's expectations and it has been removed. The plugin
481493
[tsuquyomi][tsuquyomi] comes packaged with a checker for TypeScript. If you
482494
install this plugin the checker should be picked up automatically by syntastic.
483495

484496
<a name="faqxcrun"></a>
485497

486-
__4.16. Q. What happened to the `xcrun` checker?__
498+
__5.16. Q. What happened to the `xcrun` checker?__
487499

488500
A. The `xcrun` checker used to have a security problem and it has been removed.
489501
A better checker for __Swift__ is part of the [vim-swift][swift] plugin. If you
490502
install this plugin the checker should be picked up automatically by syntastic.
491503

492504
<a name="faqvalac"></a>
493505

494-
__4.17. Q. What happened to the `valac` checker?__
506+
__5.17. Q. What happened to the `valac` checker?__
495507

496508
A. It is now part of the [vala.vim][vala] plugin. If you install this plugin the
497509
checker should be picked up automatically by syntastic.
498510

499511
<a name="julialint"></a>
500512

501-
__4.18. Q. What happened to the Julia `lint` checker?__
513+
__5.18. Q. What happened to the Julia `lint` checker?__
502514

503515
A. It was removed, since the `Lint.jl` package [has been deprecated][julialint]
504516
and no longer works with recent Julia versions.
505517

506518
<a name="otherresources"></a>
507519

508-
## 5\. Resources
520+
## 6\. Resources
509521

510522
The preferred place for posting suggestions, reporting bugs, and general
511523
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
522534
[scrooloose]: https://github.com/scrooloose
523535
[screenshot]: https://github.com/vim-syntastic/syntastic/raw/master/_assets/screenshot_1.png
524536

537+
[ale]: https://github.com/dense-analysis/ale
538+
525539
[bug_tracker]: https://github.com/vim-syntastic/syntastic/issues
526540
[checkers]: https://github.com/vim-syntastic/syntastic/blob/master/doc/syntastic-checkers.txt
527541
[crystal]: https://github.com/rhysd/vim-crystal

Diff for: plugin/syntastic.vim

+1-1
Original file line numberDiff line numberDiff line change
@@ -19,7 +19,7 @@ if has('reltime')
1919
lockvar! g:_SYNTASTIC_START
2020
endif
2121

22-
let g:_SYNTASTIC_VERSION = '3.10.0-32'
22+
let g:_SYNTASTIC_VERSION = '3.10.0-34'
2323
lockvar g:_SYNTASTIC_VERSION
2424

2525
" Sanity checks {{{1

0 commit comments

Comments
 (0)