syntastic git · master
syntastic vim plugin (fork)
Vim Script 99%git clone https://git.christianimmanuel.de/mirrors-forks/syntastic.gitwget https://git.christianimmanuel.de/mirrors-forks/syntastic/archive/syntastic.tar.gzREADME: add deprecation note.
README.markdown | 122 ++++++++++++++++++++++++++++----------------------- plugin/syntastic.vim | 2 +- 2 files changed, 69 insertions(+), 55 deletions(-) diff --git a/README.markdown b/README.markdown index 8f4c956d..334bab6f 100644 --- a/README.markdown +++ b/README.markdown @@ -18,38 +18,50 @@ - - - -1. [Introduction](#introduction) -2. [Installation](#installation) -2.1. [Requirements](#requirements) -2.2. [Installing syntastic with Pathogen](#installpathogen) -3. [Recommended settings](#settings) -4. [FAQ](#faq) -4.1. [I installed syntastic but it isn't reporting any errors...](#faqinfo) -4.2. [Syntastic supports several checkers for my filetype, how do I tell it which one(s) to use?](#faqcheckers) -4.3. [How can I run checkers for "foreign" filetypes against the current file?](#faqforeign) -4.4. [I have enabled multiple checkers for the current filetype. How can I display all errors from all checkers together?](#faqaggregate) -4.5. [How can I pass additional arguments to a checker?](#faqargs) -4.6. [I run a checker and the location list is not updated...](#faqloclist) -4.6. [I run`:lopen` or `:lwindow` and the error window is empty...](#faqloclist) -4.7. [How can I jump between the different errors without using the location list at the bottom of the window?](#faqlnext) -4.8. [The error window is closed automatically when I `:quit` the current buffer but not when I `:bdelete` it?](#faqbdelete) -4.9. [My favourite checker needs to load a configuration file from the project's root rather than the current directory...](#faqconfig) -4.10. [What is the difference between syntax checkers and style checkers?](#faqstyle) -4.11. [How can I check scripts written for different versions of Python?](#faqpython) -4.12. [How can I check scripts written for different versions of Ruby?](#faqruby) -4.13. [The `perl` checker has stopped working...](#faqperl) -4.14. [What happened to the `rustc` checker?](#faqrust) -4.15. [What happened to the `tsc` checker?](#faqtsc) -4.16. [What happened to the `xcrun` checker?](#faqxcrun) -4.17. [What happened to the `valac` checker?](#faqvalac) -4.18. [What happened to the Julia `lint` checker?](#faqjulialint) -5. [Resources](#otherresources) +1. [Deprecation note](#deprecation) +2. [Introduction](#introduction) +3. [Installation](#installation) +3.1. [Requirements](#requirements) +3.2. [Installing syntastic with Pathogen](#installpathogen) +4. [Recommended settings](#settings) +5. [FAQ](#faq) +5.1. [I installed syntastic but it isn't reporting any errors...](#faqinfo) +5.2. [Syntastic supports several checkers for my filetype, how do I tell it which one(s) to use?](#faqcheckers) +5.3. [How can I run checkers for "foreign" filetypes against the current file?](#faqforeign) +5.4. [I have enabled multiple checkers for the current filetype. How can I display all errors from all checkers together?](#faqaggregate) +5.5. [How can I pass additional arguments to a checker?](#faqargs) +5.6. [I run a checker and the location list is not updated...](#faqloclist) +5.6. [I run`:lopen` or `:lwindow` and the error window is empty...](#faqloclist) +5.7. [How can I jump between the different errors without using the location list at the bottom of the window?](#faqlnext) +5.8. [The error window is closed automatically when I `:quit` the current buffer but not when I `:bdelete` it?](#faqbdelete) +5.9. [My favourite checker needs to load a configuration file from the project's root rather than the current directory...](#faqconfig) +5.10. [What is the difference between syntax checkers and style checkers?](#faqstyle) +5.11. [How can I check scripts written for different versions of Python?](#faqpython) +5.12. [How can I check scripts written for different versions of Ruby?](#faqruby) +5.13. [The `perl` checker has stopped working...](#faqperl) +5.14. [What happened to the `rustc` checker?](#faqrust) +5.15. [What happened to the `tsc` checker?](#faqtsc) +5.16. [What happened to the `xcrun` checker?](#faqxcrun) +5.17. [What happened to the `valac` checker?](#faqvalac) +5.18. [What happened to the Julia `lint` checker?](#faqjulialint) +6. [Resources](#otherresources) - - - +<a name="deprecation"></a> + +## 1\. Deprecation note + +This project is no longer maintained. If you need a syntax checking plugin +for [Vim][vim] you might be interested in Syntastic's spiritual succesor, +[ALE][ale]. Although it shares no code with syntastic and it takes a very +different approach to design, [ALE][ale] can be considered a natural evolution +of syntastic in terms of goals and functionality. Check it out, you probably +won't be disappointed. + <a name="introduction"></a> -## 1\. Introduction +## 2\. Introduction Syntastic is a syntax checking plugin for [Vim][vim] created by [Martin Grenfell][scrooloose]. It runs files through external syntax checkers @@ -95,11 +107,11 @@ enabled. <a name="installation"></a> -## 2\. Installation +## 3\. Installation <a name="requirements"></a> -### 2.1\. Requirements +### 3.1\. Requirements Syntastic itself has rather relaxed requirements: it doesn't have any external dependencies, and it needs a version of [Vim][vim] compiled with a few common @@ -128,14 +140,14 @@ checkers. <a name="installpathogen"></a> -### 2.2\. Installing syntastic with Pathogen +### 3.2\. Installing syntastic with Pathogen If you already have [Pathogen][pathogen] working then skip [Step 1](#step1) and go to [Step 2](#step2). <a name="step1"></a> -#### 2.2.1\. Step 1: Install pathogen.vim +#### 3.2.1\. Step 1: Install pathogen.vim First I'll show you how to install Tim Pope's [Pathogen][pathogen] so that it's easy to install syntastic. Do this in your terminal so that you get the `pathogen.vim` @@ -151,7 +163,7 @@ execute pathogen#infect() <a name="step2"></a> -#### 2.2.2\. Step 2: Install syntastic as a Pathogen bundle +#### 3.2.2\. Step 2: Install syntastic as a Pathogen bundle You now have pathogen installed and can put syntastic into `~/.vim/bundle` like this: @@ -174,7 +186,7 @@ following: <a name="settings"></a> -## 3\. Recommended settings +## 4\. Recommended settings Syntastic has numerous options that can be configured, and the defaults are not particularly well suitable for new users. It is recommended @@ -193,11 +205,11 @@ let g:syntastic_check_on_wq = 0 <a name="faq"></a> -## 4\. FAQ +## 5\. FAQ <a name="faqinfo"></a> -__4.1. Q. I installed syntastic but it isn't reporting any errors...__ +__5.1. 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 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. <a name="faqcheckers"></a> -__4.2. Q. Syntastic supports several checkers for my filetype, how do I tell it +__5.2. Q. Syntastic supports several checkers for my filetype, how do I tell it which one(s) to use?__ A. Add a line like this to your `vimrc`: @@ -273,7 +285,7 @@ aren't listed in `g:syntastic_<filetype>_checkers`. <a name="faqforeign"></a> -__4.3. Q. How can I run checkers for "foreign" filetypes against the current +__5.3. Q. How can I run checkers for "foreign" filetypes against the current file?__ A. You need to qualify the name of the "foreign" checker with the name @@ -298,7 +310,7 @@ work as a checker. <a name="faqaggregate"></a> -__4.4. Q. I have enabled multiple checkers for the current filetype. How can I +__5.4. Q. I have enabled multiple checkers for the current filetype. How can I display all errors from all checkers together?__ A. Set `g:syntastic_aggregate_errors` to 1 in your `vimrc`: @@ -310,7 +322,7 @@ See `:help syntastic-aggregating-errors` for more details. <a name="faqargs"></a> -__4.5. Q. How can I pass additional arguments to a checker?__ +__5.5. Q. How can I pass additional arguments to a checker?__ A. In most cases a command line is constructed using an internal function 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] <a name="faqloclist"></a> -__4.6. Q. I run a checker and the location list is not updated...__ -__4.6. Q. I run`:lopen` or `:lwindow` and the error window is empty...__ +__5.6. Q. I run a checker and the location list is not updated...__ +__5.6. Q. I run`:lopen` or `:lwindow` and the error window is empty...__ 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 @@ -347,7 +359,7 @@ let g:syntastic_always_populate_loc_list = 1 <a name="faqlnext"></a> -__4.7. Q. How can I jump between the different errors without using the location +__5.7. Q. How can I jump between the different errors without using the location list at the bottom of the window?__ A. Vim provides several built-in commands for this. See `:help :lnext` and @@ -359,7 +371,7 @@ mappings (among other things). <a name="faqbdelete"></a> -__4.8. Q. The error window is closed automatically when I `:quit` the current buffer +__5.8. Q. The error window is closed automatically when I `:quit` the current buffer but not when I `:bdelete` it?__ 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 <a name="faqconfig"></a> -__4.9. My favourite checker needs to load a configuration file from the +__5.9. My favourite checker needs to load a configuration file from the project's root rather than the current directory...__ 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 = <a name="faqstyle"></a> -__4.10. Q. What is the difference between syntax checkers and style checkers?__ +__5.10. Q. What is the difference between syntax checkers and style checkers?__ A. The errors and warnings they produce are highlighted differently and can be filtered by different rules, but otherwise the distinction is pretty much @@ -421,7 +433,7 @@ See `:help syntastic_quiet_messages` for more information. <a name="faqpython"></a> -__4.11. Q. How can I check scripts written for different versions of Python?__ +__5.11. Q. How can I check scripts written for different versions of Python?__ A. Install a Python version manager such as [virtualenv][virtualenv] or [pyenv][pyenv], activate the environment for the relevant version @@ -437,7 +449,7 @@ scripts. <a name="faqruby"></a> -__4.12. Q. How can I check scripts written for different versions of Ruby?__ +__5.12. Q. How can I check scripts written for different versions of Ruby?__ A. Install a Ruby version manager such as [rvm][rvm] or [rbenv][rbenv], 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 <a name="faqperl"></a> -__4.13. Q. The `perl` checker has stopped working...__ +__5.13. Q. The `perl` checker has stopped working...__ A. The `perl` checker runs `perl -c` against your file, which in turn __executes__ any `BEGIN`, `UNITCHECK`, and `CHECK` blocks, and any `use` @@ -468,14 +480,14 @@ let g:syntastic_enable_perl_checker = 1 <a name="faqrust"></a> -__4.14. Q. What happened to the `rustc` checker?__ +__5.14. Q. What happened to the `rustc` checker?__ A. It is now part of the [rust.vim][rust] plugin. If you install this plugin the checker should be picked up automatically by syntastic. <a name="faqtsc"></a> -__4.15. Q. What happened to the `tsc` checker?__ +__5.15. Q. What happened to the `tsc` checker?__ A. It didn't meet people's expectations and it has been removed. The plugin [tsuquyomi][tsuquyomi] comes packaged with a checker for TypeScript. If you @@ -483,7 +495,7 @@ install this plugin the checker should be picked up automatically by syntastic. <a name="faqxcrun"></a> -__4.16. Q. What happened to the `xcrun` checker?__ +__5.16. Q. What happened to the `xcrun` checker?__ A. The `xcrun` checker used to have a security problem and it has been removed. A better checker for __Swift__ is part of the [vim-swift][swift] plugin. If you @@ -491,21 +503,21 @@ install this plugin the checker should be picked up automatically by syntastic. <a name="faqvalac"></a> -__4.17. Q. What happened to the `valac` checker?__ +__5.17. Q. What happened to the `valac` checker?__ A. It is now part of the [vala.vim][vala] plugin. If you install this plugin the checker should be picked up automatically by syntastic. <a name="julialint"></a> -__4.18. Q. What happened to the Julia `lint` checker?__ +__5.18. Q. What happened to the Julia `lint` checker?__ A. It was removed, since the `Lint.jl` package [has been deprecated][julialint] and no longer works with recent Julia versions. <a name="otherresources"></a> -## 5\. Resources +## 6\. Resources The preferred place for posting suggestions, reporting bugs, and general 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 [scrooloose]: https://github.com/scrooloose [screenshot]: https://github.com/vim-syntastic/syntastic/raw/master/_assets/screenshot_1.png +[ale]: https://github.com/dense-analysis/ale + [bug_tracker]: https://github.com/vim-syntastic/syntastic/issues [checkers]: https://github.com/vim-syntastic/syntastic/blob/master/doc/syntastic-checkers.txt [crystal]: https://github.com/rhysd/vim-crystal diff --git a/plugin/syntastic.vim b/plugin/syntastic.vim index 415ea080..ba55cfe9 100644 --- a/plugin/syntastic.vim +++ b/plugin/syntastic.vim @@ -19,7 +19,7 @@ if has('reltime') lockvar! g:_SYNTASTIC_START endif -let g:_SYNTASTIC_VERSION = '3.10.0-32' +let g:_SYNTASTIC_VERSION = '3.10.0-34' lockvar g:_SYNTASTIC_VERSION " Sanity checks {{{1