From 9750835cf0512c1c325a6725008441962415c1cd Mon Sep 17 00:00:00 2001 From: micbou Date: Tue, 28 Apr 2015 13:52:52 +0200 Subject: [PATCH] Add AppVeyor configuration --- README.md | 1 + appveyor.yml | 16 ++++ doc/youcompleteme.txt | 190 +++++++++++++++++++++--------------------- 3 files changed, 113 insertions(+), 94 deletions(-) create mode 100644 appveyor.yml diff --git a/README.md b/README.md index 6370a7c8..26be042e 100644 --- a/README.md +++ b/README.md @@ -2,6 +2,7 @@ YouCompleteMe: a code-completion engine for Vim =============================================== [![Build Status](https://travis-ci.org/Valloric/YouCompleteMe.svg?branch=master)](https://travis-ci.org/Valloric/YouCompleteMe) +[![Build status](https://ci.appveyor.com/api/projects/status/ag9uqwi8s6btwjd8/branch/master?svg=true)](https://ci.appveyor.com/project/Valloric/YouCompleteMe) - [Intro](#intro) - [Installation](#installation) diff --git a/appveyor.yml b/appveyor.yml new file mode 100644 index 00000000..5b500e63 --- /dev/null +++ b/appveyor.yml @@ -0,0 +1,16 @@ +version: '{build}' +environment: + matrix: + - arch: 32 + - arch: 64 +install: + - git submodule update --init --recursive + - ps: $env:python = if ($env:arch -eq 32) { 'C:\Python27' } else { 'C:\Python27-x64' } + - ps: (new-object net.webclient).DownloadFile('https://raw.github.com/pypa/pip/master/contrib/get-pip.py', 'C:\get-pip.py') + - set PATH=%python%;%python%\Scripts;%PATH% + - python C:\get-pip.py + - pip install -r python\test_requirements.txt +build_script: + - run_tests.py +# Disable automatic tests +test: off diff --git a/doc/youcompleteme.txt b/doc/youcompleteme.txt index 703d100c..e88eda4b 100644 --- a/doc/youcompleteme.txt +++ b/doc/youcompleteme.txt @@ -126,7 +126,7 @@ Contents ~ 25. I get weird errors when I press 'Ctrl-C' in Vim |Ctrl-sub-C| 26. Why did YCM stop using Syntastic for diagnostics display? |youcompleteme-why-did-ycm-stop-using-syntastic-for-diagnostics-display| 27. Completion doesn't work with the C++ standard library headers |youcompleteme-completion-doesnt-work-with-c-standard-library-headers| - 28. Install YCM with NeoBundle [37] |youcompleteme-install-ycm-with-neobundle-37| + 28. Install YCM with NeoBundle [39] |youcompleteme-install-ycm-with-neobundle-39| 10. Contact |youcompleteme-contact| 11. License |youcompleteme-license| 12. References |youcompleteme-references| @@ -135,7 +135,7 @@ Contents ~ *youcompleteme-introduction* Introduction ~ - Image: Build Status [1] +Image: Build Status [1] Image: Build status [3] - Intro - Installation @@ -178,23 +178,23 @@ Vim. It has several completion engines: - an identifier-based engine that works with every programming language, -- a Clang [3]-based engine that provides native semantic code completion for +- a Clang [5]-based engine that provides native semantic code completion for C/C++/Objective-C/Objective-C++ (from now on referred to as "the C-family languages"), -- a Jedi [4]-based completion engine for Python, +- a Jedi [6]-based completion engine for Python, -- an OmniSharp [5]-based completion engine for C#, +- an OmniSharp [7]-based completion engine for C#, -- a Gocode [6]-based completion engine for Go, +- a Gocode [8]-based completion engine for Go, -- a TSServer [7]-based completion engine for TypeScript, +- a TSServer [9]-based completion engine for TypeScript, - and an omnifunc-based completer that uses data from Vim's omnicomplete system to provide semantic completions for many other languages (Ruby, PHP etc.). - Image: YouCompleteMe GIF demo (see reference [8]) + Image: YouCompleteMe GIF demo (see reference [10]) Here's an explanation of what happens in the short GIF demo above. @@ -213,7 +213,7 @@ typing to further filter out unwanted completions. A critical thing to notice is that the completion **filtering is NOT based on the input being a string prefix of the completion** (but that works too). The -input needs to be a _subsequence [9] match_ of a completion. This is a fancy +input needs to be a _subsequence [11] match_ of a completion. This is a fancy way of saying that any input characters need to be present in a completion string in the order in which they appear in the input. So 'abc' is a subsequence of 'xaybgc', but not of 'xbyxaxxc'. After the filter, a complicated @@ -232,7 +232,7 @@ with a keyboard shortcut; see the rest of the docs). The last thing that you can see in the demo is YCM's diagnostic display features (the little red X that shows up in the left gutter; inspired by -Syntastic [10]) if you are editing a C-family file. As Clang compiles your file +Syntastic [12]) if you are editing a C-family file. As Clang compiles your file and detects warnings or errors, they will be presented in various ways. You don't need to save your file or press any keyboard shortcut to trigger this, it "just happens" in the background. @@ -250,7 +250,7 @@ languages & Python. Expect more IDE features powered by the various YCM semantic engines in the future. You'll also find that YCM has filepath completers (try typing './' in a file) -and a completer that integrates with UltiSnips [11]. +and a completer that integrates with UltiSnips [13]. =============================================================================== *youcompleteme-installation* @@ -263,16 +263,16 @@ Mac OS X super-quick installation ~ Please refer to the full Installation Guide below; the following commands are provided on a best-effort basis and may not work for you. -Install the latest version of MacVim [12]. Yes, MacVim. And yes, the _latest_. +Install the latest version of MacVim [14]. Yes, MacVim. And yes, the _latest_. If you don't use the MacVim GUI, it is recommended to use the Vim binary that is inside the MacVim.app package ('MacVim.app/Contents/MacOS/Vim'). To ensure -it works correctly copy the 'mvim' script from the MacVim [12] download to your +it works correctly copy the 'mvim' script from the MacVim [14] download to your local binary folder (for example '/usr/local/bin/mvim') and then symlink it: > ln -s /usr/local/bin/mvim vim < -Install YouCompleteMe with Vundle [13]. +Install YouCompleteMe with Vundle [15]. **Remember:** YCM is a plugin with a compiled component. If you **update** YCM using Vundle and the ycm_support_libs library APIs have changed (happens @@ -283,8 +283,8 @@ process. installed along with the latest Command Line Tools (they are installed when you start Xcode for the first time). -Install CMake. Preferably with Homebrew [14], but here's the stand-alone CMake -installer [15]. +Install CMake. Preferably with Homebrew [16], but here's the stand-alone CMake +installer [17]. _If_ you have installed a Homebrew Python and/or Homebrew MacVim, see the _FAQ_ for details. @@ -323,9 +323,9 @@ provided on a best-effort basis and may not work for you. Make sure you have Vim 7.3.598 with python2 support. Ubuntu 14.04 and later have a Vim that's recent enough. You can see the version of Vim installed by running 'vim --version'. If the version is too old, you may need to compile Vim -from source [16] (don't worry, it's easy). +from source [18] (don't worry, it's easy). -Install YouCompleteMe with Vundle [13]. +Install YouCompleteMe with Vundle [15]. **Remember:** YCM is a plugin with a compiled component. If you **update** YCM using Vundle and the ycm_support_libs library APIs have changed (happens @@ -366,7 +366,7 @@ that are conservatively turned off by default that you may want to turn on. Windows Installation ~ YCM has **no official support for Windows**, but that doesn't mean you can't -get it to work there. See the Windows Installation Guide [17] wiki page. Feel +get it to work there. See the Windows Installation Guide [19] wiki page. Feel free to add to it. ------------------------------------------------------------------------------- @@ -387,7 +387,7 @@ FreeBSD 10.x comes with clang compiler but not the libraries needed to install. pkg install llvm35 boost-all boost-python-libs clang35 export LD_LIBRARY_PATH=$LD_LIBRARY_PATH:/usr/local/llvm35/lib/ < -Install YouCompleteMe with Vundle [13]. +Install YouCompleteMe with Vundle [15]. **Remember:** YCM is a plugin with a compiled component. If you **update** YCM using Vundle and the ycm_support_libs library APIs have changed (happens @@ -448,15 +448,15 @@ process. 1-Z', where Z will be some number. That number needs to be 598 or higher. If your version of Vim is not recent enough, you may need to compile Vim - from source [16] (don't worry, it's easy). + from source [18] (don't worry, it's easy). After you have made sure that you have Vim 7.3.598+, type the following in Vim: ":echo has('python')". The output should be 1. If it's 0, then get a version of Vim with Python support. -2. **Install YCM** with Vundle [13] (or Pathogen [18], but Vundle is a +2. **Install YCM** with Vundle [15] (or Pathogen [20], but Vundle is a better idea). With Vundle, this would mean adding a "Plugin - 'Valloric/YouCompleteMe'" line to your vimrc [19]. + 'Valloric/YouCompleteMe'" line to your vimrc [21]. If you don't install YCM with Vundle, make sure you have run 'git submodule update --init --recursive' after checking out the YCM @@ -473,7 +473,7 @@ process. You can use the system libclang _only if you are sure it is version 3.3 or higher_, otherwise don't. Even if it is, we recommend using the - official binaries from llvm.org [20] if at all possible. Make sure you + official binaries from llvm.org [22] if at all possible. Make sure you download the correct archive file for your OS. We **STRONGLY recommend AGAINST use** of the system libclang instead of @@ -486,8 +486,8 @@ process. You will need to have 'cmake' installed in order to generate the required makefiles. Linux users can install cmake with their package manager ('sudo apt-get install cmake' for Ubuntu) whereas other users can - download and install [15] cmake from its project site. Mac users can also - get it through Homebrew [14] with 'brew install cmake'. + download and install [17] cmake from its project site. Mac users can also + get it through Homebrew [16] with 'brew install cmake'. You also need to make sure you have Python headers installed. On a Debian-like Linux distro, this would be 'sudo apt-get install python- @@ -642,7 +642,7 @@ General Usage ~ through the completions. Use Shift-TAB to cycle backwards. Note that if you're using console Vim (that is, not Gvim or MacVim) then it's likely that the Shift-TAB binding will not work because the console will not pass - it to Vim. You can remap the keys; see the _Options [21]_ section below. + it to Vim. You can remap the keys; see the _Options [23]_ section below. Knowing a little bit about how YCM works internally will prevent confusion. YCM has several completion engines: an identifier-based completer that collects all @@ -713,20 +713,20 @@ This system was designed this way so that the user can perform any arbitrary sequence of operations to produce a list of compilation flags YCM should hand to Clang. -See YCM's own '.ycm_extra_conf.py' [22] for details on how this works. You +See YCM's own '.ycm_extra_conf.py' [24] for details on how this works. You should be able to use it _as a starting point_. **Don't** just copy/paste that file somewhere and expect things to magically work; **your project needs different flags**. Hint: just replace the strings in the 'flags' variable with compilation flags necessary for your project. That should be enough for 99% of projects. -Yes, Clang's 'CompilationDatabase' system [23] is also supported. Again, see +Yes, Clang's 'CompilationDatabase' system [25] is also supported. Again, see the above linked example file. You can get CMake to generate this file for you by adding 'set( CMAKE_EXPORT_COMPILE_COMMANDS 1 )' to your project's 'CMakeLists.txt' file (if using CMake). If you're not using CMake, you could -use something like Bear [24] to generate the 'compile_commands.json' file. +use something like Bear [26] to generate the 'compile_commands.json' file. -Consider using YCM-Generator [25] to generate the 'ycm_extra_conf.py' file. +Consider using YCM-Generator [27] to generate the 'ycm_extra_conf.py' file. If Clang encounters errors when compiling the header files that your file includes, then it's probably going to take a long time to get completions. When @@ -744,7 +744,7 @@ your file. Semantic completion for other languages ~ Python, C#, Go, and TypeScript are supported natively by YouCompleteMe using -the Jedi [4], Omnisharp [5], Gocode [6], and TSServer [7] engines, +the Jedi [6], Omnisharp [7], Gocode [8], and TSServer [9] engines, respectively. Check the installation section for instructions to enable these features if desired. @@ -753,7 +753,7 @@ semantic completions if it does not have a native semantic completion engine for your file's filetype. Vim comes with okayish omnifuncs for various languages like Ruby, PHP etc. It depends on the language. -You can get stellar omnifuncs for Java and Ruby with Eclim [26]. Just make sure +You can get stellar omnifuncs for Java and Ruby with Eclim [28]. Just make sure you have the _latest_ Eclim installed and configured (this means Eclim '>= 2.2.*' and Eclipse '>= 4.2.*'). @@ -771,7 +771,7 @@ Writing New Semantic Completers ~ You have two options here: writing an 'omnifunc' for Vim's omnicomplete system that YCM will then use through its omni-completer, or a custom completer for -YCM using the Completer API [27]. +YCM using the Completer API [29]. Here are the differences between the two approaches: @@ -790,7 +790,7 @@ Here are the differences between the two approaches: than VimScript. If you want to use the 'omnifunc' system, see the relevant Vim docs with ':h -complete-functions'. For the Completer API, see the API docs [27]. +complete-functions'. For the Completer API, see the API docs [29]. If you want to upstream your completer into YCM's source, you should use the Completer API. @@ -841,7 +841,7 @@ current file in Vim's 'locationlist', which can be opened with the ':lopen' and ':lclose' commands (make sure you have set 'let g:ycm_always_populate_location_list = 1' in your vimrc). A good way to toggle the display of the 'locationlist' with a single key mapping is provided by -another (very small) Vim plugin called ListToggle [28] (which also makes it +another (very small) Vim plugin called ListToggle [30] (which also makes it possible to change the height of the 'locationlist' window), also written by yours truly. @@ -1179,11 +1179,11 @@ Options ~ All options have reasonable defaults so if the plug-in works after installation you don't need to change any options. These options can be configured in your -vimrc script [19] by including a line like this: +vimrc script [21] by including a line like this: > let g:ycm_min_num_of_chars_for_completion = 1 < -Note that after changing an option in your vimrc script [19] you have to +Note that after changing an option in your vimrc script [21] you have to restart Vim for the changes to take effect. ------------------------------------------------------------------------------- @@ -1504,7 +1504,7 @@ from the 'tagfiles()' Vim function which examines the 'tags' Vim option. See YCM will re-index your tags files if it detects that they have been modified. -The only supported tag format is the Exuberant Ctags format [29]. The format +The only supported tag format is the Exuberant Ctags format [31]. The format from "plain" ctags is NOT supported. Ctags needs to be called with the '-- fields=+l' option (that's a lowercase 'L', not a one) because YCM needs the 'language:' field in the tags output. @@ -1882,7 +1882,7 @@ It's also possible to use a regular expression as a trigger. You have to prefix your trigger with 're!' to signify it's a regex trigger. For instance, 're!\w+\.' would only trigger after the '\w+\.' regex matches. -NOTE: The regex syntax is **NOT** Vim's, it's Python's [30]. +NOTE: The regex syntax is **NOT** Vim's, it's Python's [32]. Default: '[see next line]' > @@ -2065,7 +2065,7 @@ produced. See the full installation guide for help. I'm trying to use a Homebrew Vim with YCM and I'm getting segfaults ~ Something (I don't know what) is wrong with the way that Homebrew configures -and builds Vim. I recommend using MacVim [12]. Even if you don't like the +and builds Vim. I recommend using MacVim [14]. Even if you don't like the MacVim GUI, you can use the Vim binary that is inside the MacVim.app package (it's 'MacVim.app/Contents/MacOS/Vim') and get the Vim console experience. @@ -2075,7 +2075,7 @@ I have a Homebrew Python and/or MacVim; can't compile/SIGABRT when starting ~ You should probably run 'brew rm python; brew install python' to get the latest fixes that should make YCM work with such a configuration. Also rebuild Macvim -then. If you still get problems with this, see issue #18 [31] for suggestions. +then. If you still get problems with this, see issue #18 [33] for suggestions. ------------------------------------------------------------------------------- *youcompleteme-vim-segfaults-when-i-use-semantic-completer-in-ruby-files* @@ -2160,8 +2160,8 @@ YCM does not read identifiers from my tags files ~ First, put 'let g:ycm_collect_identifiers_from_tags_files = 1' in your vimrc. -Make sure you are using Exuberant Ctags [32] to produce your tags files since -the only supported tag format is the Exuberant Ctags format [29]. The format +Make sure you are using Exuberant Ctags [34] to produce your tags files since +the only supported tag format is the Exuberant Ctags format [31]. The format from "plain" ctags is NOT supported. The output of 'ctags --version' should list "Exuberant Ctags". @@ -2235,7 +2235,7 @@ and similar, then just update to Vim 7.4.314 (or later) and they'll go away. *vim-sub-autoclose* Nasty bugs happen if I have the 'vim-autoclose' plugin installed ~ -Use the delimitMate [33] plugin instead. It does the same thing without +Use the delimitMate [35] plugin instead. It does the same thing without conflicting with YCM. ------------------------------------------------------------------------------- @@ -2243,7 +2243,7 @@ conflicting with YCM. Is there some sort of YCM mailing list? I have questions ~ If you have questions about the plugin or need help, please use the ycm-users -[34] mailing list, _don't_ create issues on the tracker. The tracker is for bug +[36] mailing list, _don't_ create issues on the tracker. The tracker is for bug reports and feature requests. ------------------------------------------------------------------------------- @@ -2297,7 +2297,7 @@ mismatch in assumptions causes performance problems since Syntastic code isn't optimized for this use case of constant diagnostic refreshing. Poor support for this use case also led to crash bugs in Vim caused by -Syntastic-Vim interactions (issue #593 [35]) and other problems, like random +Syntastic-Vim interactions (issue #593 [37]) and other problems, like random Vim flickering. Attempts were made to resolve these issues in Syntastic, but ultimately some of them failed (for various reasons). @@ -2333,13 +2333,13 @@ paths, prepend '-isystem' to each individual path and append them all to the list of flags you return from your 'FlagsForFile' function in your '.ycm_extra_conf.py' file. -See issue #303 [36] for details. +See issue #303 [38] for details. ------------------------------------------------------------------------------- - *youcompleteme-install-ycm-with-neobundle-37* -Install YCM with NeoBundle [37] ~ + *youcompleteme-install-ycm-with-neobundle-39* +Install YCM with NeoBundle [39] ~ -NeoBundle [37] can do the compilation for you; just add the following to your +NeoBundle [39] can do the compilation for you; just add the following to your vimrc: > NeoBundle 'Valloric/YouCompleteMe', { @@ -2362,10 +2362,10 @@ the following to your vimrc: Contact ~ If you have questions about the plugin or need help, please use the ycm-users -[34] mailing list. +[36] mailing list. If you have bug reports or feature suggestions, please use the issue tracker -[38]. +[40]. The latest version of the plugin is available at http://valloric.github.io/YouCompleteMe/. @@ -2376,10 +2376,10 @@ The author's homepage is http://val.markovic.io. *youcompleteme-license* License ~ -This software is licensed under the GPL v3 license [39]. © 2015 YouCompleteMe +This software is licensed under the GPL v3 license [41]. © 2015 YouCompleteMe contributors - Image: Bitdeli Badge [40] + Image: Bitdeli Badge [42] =============================================================================== *youcompleteme-references* @@ -2387,44 +2387,46 @@ References ~ [1] https://travis-ci.org/Valloric/YouCompleteMe [2] https://travis-ci.org/Valloric/YouCompleteMe.svg?branch=master -[3] http://clang.llvm.org/ -[4] https://github.com/davidhalter/jedi -[5] https://github.com/nosami/OmniSharpServer -[6] https://github.com/nsf/gocode -[7] https://github.com/Microsoft/TypeScript/tree/master/src/server -[8] http://i.imgur.com/0OP4ood.gif -[9] http://en.wikipedia.org/wiki/Subsequence -[10] https://github.com/scrooloose/syntastic -[11] https://github.com/SirVer/ultisnips/blob/master/doc/UltiSnips.txt -[12] https://github.com/macvim-dev/macvim/releases -[13] https://github.com/gmarik/vundle#about -[14] http://mxcl.github.com/homebrew/ -[15] http://www.cmake.org/cmake/resources/software.html -[16] https://github.com/Valloric/YouCompleteMe/wiki/Building-Vim-from-source -[17] https://github.com/Valloric/YouCompleteMe/wiki/Windows-Installation-Guide -[18] https://github.com/tpope/vim-pathogen#pathogenvim -[19] http://vimhelp.appspot.com/starting.txt.html#vimrc -[20] http://llvm.org/releases/download.html -[21] https://github.com/Valloric/YouCompleteMe#options -[22] https://github.com/Valloric/ycmd/blob/master/cpp/ycm/.ycm_extra_conf.py -[23] http://clang.llvm.org/docs/JSONCompilationDatabase.html -[24] https://github.com/rizsotto/Bear -[25] https://github.com/rdnetto/YCM-Generator -[26] http://eclim.org/ -[27] https://github.com/Valloric/ycmd/blob/master/ycmd/completers/completer.py -[28] https://github.com/Valloric/ListToggle -[29] http://ctags.sourceforge.net/FORMAT -[30] https://docs.python.org/2/library/re.html#regular-expression-syntax -[31] https://github.com/Valloric/YouCompleteMe/issues/18 -[32] http://ctags.sourceforge.net/ -[33] https://github.com/Raimondi/delimitMate -[34] https://groups.google.com/forum/?hl=en#!forum/ycm-users -[35] https://github.com/Valloric/YouCompleteMe/issues/593 -[36] https://github.com/Valloric/YouCompleteMe/issues/303 -[37] https://github.com/Shougo/neobundle.vim -[38] https://github.com/Valloric/YouCompleteMe/issues?state=open -[39] http://www.gnu.org/copyleft/gpl.html -[40] https://bitdeli.com/free -[41] https://d2weczhvl823v0.cloudfront.net/Valloric/youcompleteme/trend.png +[3] https://ci.appveyor.com/project/Valloric/YouCompleteMe +[4] https://ci.appveyor.com/api/projects/status/ag9uqwi8s6btwjd8/branch/master?svg=true +[5] http://clang.llvm.org/ +[6] https://github.com/davidhalter/jedi +[7] https://github.com/nosami/OmniSharpServer +[8] https://github.com/nsf/gocode +[9] https://github.com/Microsoft/TypeScript/tree/master/src/server +[10] http://i.imgur.com/0OP4ood.gif +[11] http://en.wikipedia.org/wiki/Subsequence +[12] https://github.com/scrooloose/syntastic +[13] https://github.com/SirVer/ultisnips/blob/master/doc/UltiSnips.txt +[14] https://github.com/macvim-dev/macvim/releases +[15] https://github.com/gmarik/vundle#about +[16] http://mxcl.github.com/homebrew/ +[17] http://www.cmake.org/cmake/resources/software.html +[18] https://github.com/Valloric/YouCompleteMe/wiki/Building-Vim-from-source +[19] https://github.com/Valloric/YouCompleteMe/wiki/Windows-Installation-Guide +[20] https://github.com/tpope/vim-pathogen#pathogenvim +[21] http://vimhelp.appspot.com/starting.txt.html#vimrc +[22] http://llvm.org/releases/download.html +[23] https://github.com/Valloric/YouCompleteMe#options +[24] https://github.com/Valloric/ycmd/blob/master/cpp/ycm/.ycm_extra_conf.py +[25] http://clang.llvm.org/docs/JSONCompilationDatabase.html +[26] https://github.com/rizsotto/Bear +[27] https://github.com/rdnetto/YCM-Generator +[28] http://eclim.org/ +[29] https://github.com/Valloric/ycmd/blob/master/ycmd/completers/completer.py +[30] https://github.com/Valloric/ListToggle +[31] http://ctags.sourceforge.net/FORMAT +[32] https://docs.python.org/2/library/re.html#regular-expression-syntax +[33] https://github.com/Valloric/YouCompleteMe/issues/18 +[34] http://ctags.sourceforge.net/ +[35] https://github.com/Raimondi/delimitMate +[36] https://groups.google.com/forum/?hl=en#!forum/ycm-users +[37] https://github.com/Valloric/YouCompleteMe/issues/593 +[38] https://github.com/Valloric/YouCompleteMe/issues/303 +[39] https://github.com/Shougo/neobundle.vim +[40] https://github.com/Valloric/YouCompleteMe/issues?state=open +[41] http://www.gnu.org/copyleft/gpl.html +[42] https://bitdeli.com/free +[43] https://d2weczhvl823v0.cloudfront.net/Valloric/youcompleteme/trend.png vim: ft=help