Add eclim
This commit is contained in:
parent
41d88859c6
commit
000e1a1263
210 changed files with 31990 additions and 0 deletions
61
.vim/bundle/eclim/eclim/doc/vim/php/buildpath.txt
Normal file
61
.vim/bundle/eclim/eclim/doc/vim/php/buildpath.txt
Normal file
|
|
@ -0,0 +1,61 @@
|
|||
*vim-php-buildpath*
|
||||
|
||||
Php Build Path
|
||||
**************
|
||||
|
||||
Source code completion, searching, and other features make use of the
|
||||
eclipse dltk's (http://eclipse.org/dltk/) .buildpath to locate
|
||||
resources. When you first create a dltk project (currently php
|
||||
(|vim-php-index|) or ruby (|vim-ruby-index|)), a .buildpath file is
|
||||
created in the project's root directory. If your project depends on
|
||||
any source files located outside your project or in another project,
|
||||
then you'll need to edit your .buildpath accordingly.
|
||||
|
||||
To help you do this, eclim provides several commands to ease the
|
||||
creation of new build path entries and variables, all of which are
|
||||
made available when you edit your .buildpath file in vim. Also when
|
||||
you write the .buildpath file, Vim will issue a command to the eclim
|
||||
server to update the project's build path, and will report any errors
|
||||
via vim's location list (:help location-list).
|
||||
|
||||
The following is a list of commands that eclim provides while editing
|
||||
your .buildpath.
|
||||
|
||||
*:NewSrcEntry_dltk_php*
|
||||
|
||||
- :NewSrcEntry <dir> [<dir> ...] - Adds one or more new entries which
|
||||
reference source directories in your project.
|
||||
|
||||
>
|
||||
<buildpathentry external="true" kind="lib" path="src/php"/>
|
||||
|
||||
<
|
||||
|
||||
This command supports command completion of project relative
|
||||
directories.
|
||||
|
||||
*:NewLibEntry_dltk_php*
|
||||
|
||||
- :NewLibEntry <dir> [<dir> ...] - Adds one or more new entries which
|
||||
reference external source directories.
|
||||
|
||||
>
|
||||
<buildpathentry external="true" kind="lib" path="/usr/local/php/cake_1.1.16.5421"/>
|
||||
|
||||
<
|
||||
|
||||
This command supports command completion of directories.
|
||||
|
||||
*:NewProjectEntry_dltk_php*
|
||||
|
||||
- :NewProjectEntry <project> [<project> ...] - Adds one or more new
|
||||
entries which reference other projects.
|
||||
|
||||
>
|
||||
<buildpathentry combineaccessrules="false" kind="prj" path="/test_project"/>
|
||||
|
||||
<
|
||||
|
||||
This command supports command completion of project names.
|
||||
|
||||
vim:ft=eclimhelp
|
||||
27
.vim/bundle/eclim/eclim/doc/vim/php/complete.txt
Normal file
27
.vim/bundle/eclim/eclim/doc/vim/php/complete.txt
Normal file
|
|
@ -0,0 +1,27 @@
|
|||
*vim-php-complete*
|
||||
|
||||
Php Code Completion
|
||||
*******************
|
||||
|
||||
Php code completion uses the standard Vim code completion mechanism
|
||||
(|vim-code_completion|) like so:
|
||||
|
||||
>
|
||||
|
||||
<?php
|
||||
class Test {
|
||||
function getName () {
|
||||
}
|
||||
function getValue () {
|
||||
}
|
||||
}
|
||||
|
||||
$test = new Test();
|
||||
|
||||
$test->get<C-X><C-U>
|
||||
$test->getName()
|
||||
?>
|
||||
|
||||
<
|
||||
|
||||
vim:ft=eclimhelp
|
||||
30
.vim/bundle/eclim/eclim/doc/vim/php/index.txt
Normal file
30
.vim/bundle/eclim/eclim/doc/vim/php/index.txt
Normal file
|
|
@ -0,0 +1,30 @@
|
|||
*vim-php-index*
|
||||
|
||||
Php
|
||||
***
|
||||
|
||||
|
||||
Features
|
||||
========
|
||||
|
||||
- Php Build Path (vim-php-buildpath)
|
||||
- Php Code Completion (vim-php-complete)
|
||||
- Php Validation (vim-php-validate)
|
||||
- Php Search (vim-php-search)
|
||||
|
||||
Suggested Mappings
|
||||
==================
|
||||
|
||||
Here are some mappings for the php funtionality provided by eclim. To
|
||||
make use of these mappings, simply create a ftplugin file for php and
|
||||
place your mappings there (:help ftplugin-name).
|
||||
|
||||
- The following mapping allows you to simply hit <enter> on an element
|
||||
to perform a search to find it.
|
||||
|
||||
>
|
||||
nnoremap <silent> <buffer> <cr> :PhpSearchContext<cr>
|
||||
|
||||
<
|
||||
|
||||
vim:ft=eclimhelp
|
||||
123
.vim/bundle/eclim/eclim/doc/vim/php/search.txt
Normal file
123
.vim/bundle/eclim/eclim/doc/vim/php/search.txt
Normal file
|
|
@ -0,0 +1,123 @@
|
|||
*vim-php-search*
|
||||
|
||||
Php Search
|
||||
**********
|
||||
|
||||
*:PhpSearch*
|
||||
|
||||
|
||||
Pattern Search
|
||||
==============
|
||||
|
||||
Pattern searching provides a means to widen a search beyond a single
|
||||
element. A pattern search can be executed using the command
|
||||
|
||||
:PhpSearch -p <pattern> [-t <type> -s <scope> -i]
|
||||
|
||||
All of the results will be placed into the current window's location
|
||||
list (:help location-list) so that you can easily navigate the
|
||||
results.
|
||||
|
||||
Vim command completion is supported through out the command with the
|
||||
exception of the pattern to search for.
|
||||
|
||||
>
|
||||
|
||||
:PhpSearch <Tab>
|
||||
:PhpSearch -p MyClass* <Tab>
|
||||
:PhpSearch -p MyClass* -t <Tab>
|
||||
:PhpSearch -p MyClass* -t class <Tab>
|
||||
:PhpSearch -p MyClass* -t class -s <Tab>
|
||||
:PhpSearch -p MyClass* -t class -s project
|
||||
|
||||
<
|
||||
|
||||
|
||||
- -p <pattern>: The pattern to search for.
|
||||
|
||||
Ex.
|
||||
|
||||
>
|
||||
MyClass
|
||||
myFunction
|
||||
my*
|
||||
|
||||
<
|
||||
|
||||
- -t <type> (Default: all): The type of element to search for where
|
||||
possible types include
|
||||
|
||||
- class
|
||||
|
||||
- function
|
||||
|
||||
- field
|
||||
|
||||
- -s <scope> (Default: all): The scope of the search where possible
|
||||
values include
|
||||
|
||||
- all - Search the whole workspace.
|
||||
|
||||
- project - Search the current project, dependent projects, and
|
||||
libraries.
|
||||
|
||||
- -i: Ignore case when searching.
|
||||
|
||||
|
||||
Element Search
|
||||
==============
|
||||
|
||||
Element searching allows you to place the cursor over just about any
|
||||
element in a source file (method call, class name, constant) and
|
||||
perform a search for that element. Performing an element search is
|
||||
the same as performing a pattern search with the exception that you do
|
||||
not specify the -p option since the element under the cursor will be
|
||||
searched for instead.
|
||||
|
||||
If only one result is found and that result is in the current source
|
||||
file, the cursor will be moved to the element found. Otherwise, on
|
||||
single result matches, the value of |g:EclimPhpSearchSingleResult|
|
||||
will be consulted for the action to take. If there are multiple
|
||||
results, the location list will be opened with the list of results.
|
||||
|
||||
*:PhpSearchContext*
|
||||
|
||||
As a convenience eclim also provides the command :PhpSearchContext.
|
||||
This command accepts no arguments and will perform the appropriate
|
||||
search depending on the context of the element.
|
||||
|
||||
- If the cursor is on the file name in a require or include call, it
|
||||
will search the configured include path for the file.
|
||||
|
||||
- Otherwise, it will search for the declaration of the element.
|
||||
|
||||
|
||||
Configuration
|
||||
=============
|
||||
|
||||
Vim Settings (|vim-settings|)
|
||||
|
||||
*g:EclimPhpSearchSingleResult*
|
||||
|
||||
- g:EclimPhpSearchSingleResult (Default: 'split') - Determines what
|
||||
action to take when a only a single result is found.
|
||||
|
||||
Possible values include:
|
||||
|
||||
- 'split' - open the result in a new window via "split".
|
||||
|
||||
- 'edit' - open the result in the current window.
|
||||
|
||||
- 'tabnew' - open the result in a new tab.
|
||||
|
||||
- 'lopen' - open the location list to display the result.
|
||||
|
||||
This setting overrides the global default for all supported language
|
||||
types which can be set using the g:EclimDefaultFileOpenAction
|
||||
setting which accepts the same possible values.
|
||||
|
||||
- g:EclimLocationListHeight (Default: 10) - Sets the height in lines
|
||||
of the location list window when eclim opens it to display search
|
||||
results.
|
||||
|
||||
vim:ft=eclimhelp
|
||||
13
.vim/bundle/eclim/eclim/doc/vim/php/tags
Normal file
13
.vim/bundle/eclim/eclim/doc/vim/php/tags
Normal file
|
|
@ -0,0 +1,13 @@
|
|||
:NewLibEntry_dltk_php buildpath.txt /*:NewLibEntry_dltk_php*
|
||||
:NewProjectEntry_dltk_php buildpath.txt /*:NewProjectEntry_dltk_php*
|
||||
:NewSrcEntry_dltk_php buildpath.txt /*:NewSrcEntry_dltk_php*
|
||||
:PhpSearch search.txt /*:PhpSearch*
|
||||
:PhpSearchContext search.txt /*:PhpSearchContext*
|
||||
:Validate_php validate.txt /*:Validate_php*
|
||||
g:EclimPhpSearchSingleResult search.txt /*g:EclimPhpSearchSingleResult*
|
||||
g:EclimPhpValidate validate.txt /*g:EclimPhpValidate*
|
||||
vim-php-buildpath buildpath.txt /*vim-php-buildpath*
|
||||
vim-php-complete complete.txt /*vim-php-complete*
|
||||
vim-php-index index.txt /*vim-php-index*
|
||||
vim-php-search search.txt /*vim-php-search*
|
||||
vim-php-validate validate.txt /*vim-php-validate*
|
||||
46
.vim/bundle/eclim/eclim/doc/vim/php/validate.txt
Normal file
46
.vim/bundle/eclim/eclim/doc/vim/php/validate.txt
Normal file
|
|
@ -0,0 +1,46 @@
|
|||
*vim-php-validate*
|
||||
|
||||
*:Validate_php*
|
||||
|
||||
|
||||
Php Validation
|
||||
**************
|
||||
|
||||
When saving a php source file that resides in a project, eclim will
|
||||
update that source file in Eclipse and will report any validation
|
||||
errors found. Any errors will be placed in the current window's
|
||||
location list (:help location-list) and the corresponding lines in the
|
||||
source file will be marked via Vim's :sign functionality with '>>'
|
||||
markers in the left margin.
|
||||
|
||||
Automatic validation of php source files can be disabled via the
|
||||
g:EclimPhpValidate variable (described below). If you choose to
|
||||
disable automatic validation, you can still use the :Validate command
|
||||
to manually validate the current file.
|
||||
|
||||
|
||||
Configuration
|
||||
=============
|
||||
|
||||
Vim Settings (|vim-settings|)
|
||||
|
||||
*g:EclimPhpValidate*
|
||||
|
||||
- g:EclimPhpValidate (Default: 1) - If set to 0, disables source code
|
||||
validation.
|
||||
|
||||
- g:EclimPhpHtmlValidate (Default: 0) - If set to a non 0 value,
|
||||
enables validating html markup in the php file. Enabling of html
|
||||
validation can also be enabled on a per buffer basis using a buffer
|
||||
local setting:
|
||||
|
||||
>
|
||||
let b:EclimPhpHtmlValidate = 1
|
||||
|
||||
<
|
||||
|
||||
- g:EclimValidateSortResults (Default: 'occurrence') - If set to
|
||||
'severity', the validation results will be sorted by severity
|
||||
(errors > warnings > info > etc.)
|
||||
|
||||
vim:ft=eclimhelp
|
||||
Loading…
Add table
Add a link
Reference in a new issue