Fork me on GitHub

Eclim Manage / Config

Below is a list of the core commands and configuration for eclim inside of vim.

Commands

  • :PingEclim - Pings eclimd to see if it is up and running.
  • :ShutdownEclim - Shuts down the current running eclimd instance.
  • :VimSettings - Allows you to view and edit all of eclim's vim client settings. Settings edited here will be stored at $HOME/.eclim/.eclim_settings.

    Note

    If you have any g:EclimXXX settings in your vimrc or equivalent, those will take precedence over any settings edited using :VimSettings.

  • :EclimDisable - Allows you to temporarily disable all communication with eclimd for the current vim session. Useful if you need to shutdown eclimd for one reason or another, and would like to disable vim's attempts to communicate with the non-existent server.
  • :EclimEnable - Re-enables communication with eclimd (the converse of :EclimDisable).
  • :EclimHelp [<topic>] - Similar to vim's :help command, with the exception that this command is limited to opening topics for eclim.
  • :EclimHelpGrep /<pattern>/ - Command which allows you to search the eclim help files via vimgrep.

    Ex.

    :EclimHelpGrep /completion/
    

Configuration

Eclim Settings

  • org.eclim.user.name Should be set to your name. Used by various commands that add contact or author information to a file.
  • org.eclim.user.email Should be set to the email address where you can be contacted. Used by various commands that add contact or author information to a file.
  • org.eclim.project.version Should be set to the version number of your project. This is used by various commands that add version info to a file or utilize the version number in some other manner.

    Defaults to "1.0".

Vim Settings

The following is a list of some of the common Vim variables available.

  • g:EclimLogLevel (Default: 'info')

    This variable allows you to control the level of output from eclim as follows:

    • 'trace' - Show all trace, debug, info, warning, and error messages.
    • 'debug' - Show all debug, info, warning, and error messages.
    • 'info' - Show all info, warning, and error messages.
    • 'warning' - Show only warning, and error messages.
    • 'error' - Show only error messages.
    • 'off' - Don't display any messages.

    Each level also has a corresponding variable to set the highlighting group used for the text.

    • g:EclimHighlightError (Default: "Error")
    • g:EclimHighlightWarning (Default: "WarningMsg")
    • g:EclimHighlightInfo (Default: "Statement")
    • g:EclimHighlightDebug (Default: "Normal")
    • g:EclimHighlightTrace (Default: "Normal")
  • g:EclimSignLevel (Default: 'info')

    Behaves just like g:EclimLogLevel except this applies to placing of Vim signs for displaying validation errors / warnings, or marking quickfix/location list entries.

    The resulting signs also use the same highlighting variables above.

  • g:EclimBrowser (Default: Dependent on OS)

    Configures the external web browser to use when opening urls. By default eclim will attempt to set a default browser based on your system, but if it cannot find a compatible browser, you will need to set one in your vimrc.

    • Firefox
      let g:EclimBrowser = 'firefox'
    • Chromium
      let g:EclimBrowser = 'chromium'

    Note: The above examples assume that the browser executable is in your path. On windows machines they won't be by default, so you will need to add them.

  • g:EclimShowCurrentError (Default: 1)

    This variable determines whether or not a CursorHold autocommand is created that will echo the error associated with the current line if any error exists. Setting this variable to 0 disables this feature.

  • g:EclimMakeLCD (Default: 1)

    When set to a non-0 value, all eclim based make commands (:Ant, :Maven, :Mvn, etc) will change to the current file's project root before executing.

    Enabling this has the benefit of allowing you to run these commands from any file regardless of where it was opened from without having to worry about the directory it is executing from. For example if you have a file open from project A and split a file from project B, you can execute :Ant from the project B file and it will utilize project B's build.xml even though your current working directory is in project A.

  • g:EclimMenus (Default: 1)

    When set to a non-0 value, enabled auto generation of gvim menus (under Plugin.eclim) for each eclim command available for the current buffer.

  • ** g:EclimPromptListStartIndex (Default: 0)

    Defines whether to use 0 or 1 based indexing when the user is prompted to choose from a list of choices.