vim-apathy

Ⅰ. 插件描述

apathy.vim: Set the 'path' option for miscellaneous file types

Ⅱ. 基本信息

创建日期：  2018-05-09
使用用户：  49
Github星：  149
插件作者：  Tim Pope

Ⅲ. 安装方法

使用Vundle管理器安装

在你的.vimrc下添加: 
Plugin 'tpope/vim-apathy'
… 然后在Vim中运行以下命令: 
:source %
:PluginInstall

对于Vundle版本 < 0.10.2，请用上面的Bundle替换Plugin。

使用NeoBundle管理器安装

在你的.vimrc下添加: 
NeoBundle 'tpope/vim-apathy'
… 然后在Vim中运行以下命令: 
:source %
:NeoBundleInstall

使用VimPlug管理器安装

在你的.vimrc下添加: 
Plug 'tpope/vim-apathy'
… 然后在Vim中运行以下命令: 
:source %
:PlugInstall

使用Pathogen管理器安装

在终端中运行以下命令: 
cd ~/.vim/bundle
git clone https://github.com/tpope/vim-apathy

Ⅳ. 文档说明

# apathy.vim

Apathy sets the five path searching options — 'path', 'suffixesadd',
'include', 'includeexpr', and 'define' — for file types I don't care
about enough to bother with creating a proper plugin.

Rationale

As you might have guessed from /usr/include being in the default, the
original purpose of the 'path' option was to house the C preprocessor
include path. This enabled Vim to parse a preprocessor declaration like
#include <stdio.h> and determine that the file being included was
/usr/include/stdio.h. Several features are built-in on this groundwork:

  • gf, <C-W>f, <C-W>gf: jump to the included file under the cursor.
  • :find, :sfind, :tabfind: jump to the specified included file.
  • [i: display the first line in the current file or an included file
    containing the keyword under the cursor.
  • ]i: like above, but start searching after the cursor.
  • :isearch: like above, but give your own line range and search pattern.
  • [I, ]I, :ilist: like above, but display all matches.
  • [<C-I>, ]<C-I>, <C-W>i, :ijump, :isplit: like above, but jump to
    the match.
  • <C-X><C-I>: complete keywords from included files.
  • [d, ]d, :dsearch, [D, ]D, :dlist, [<C-D>, ]<C-D>, <C-W>d,
    :djump, :dsplit, <C-X><C-D>: like their i equivalents, but for macro

definitions.

  • :checkpath: list missing included files.

I list these exhaustively to stress that included files aren't just a
potential use of 'path', they are the very purpose of 'path'. If you've
been using 'path' to contain a list of commonly accessed directories or
something like **/*, you're precluding yourself from using 38 different

  1. Oops! (Try one of the many fuzzy finder plugins instead.)

While Vim is set up for C by default, it provides a few options to use these
features for other languages:

  • 'include' is a pattern for matching include declarations, defaulting to
    ^\s*#\s*include. A value for JavaScript imports might look like

\<require\|\<from.

  • 'includeexpr' is a simple function for converting an include to a

    1. In languages like Java, Lua, and Python, this could be used to
    2. foo.bar into foo/bar.
  • 'suffixesadd' is a list of file extensions to try. JavaScript might use
    something like .js,.coffee.
  • 'define' is a pattern for matching macro definitions, defaulting to
    ^\s*#\s*define. This doesn't serve much purpose for languages without a

preprocessor, but sometimes it is helpful to make it match function and/or
variable declarations.

These, along with 'path', make up the purview of Apathy.

Supported file types

Additionally, the C related defaults are stripped out of the global config, so
you don't have to worry about /usr/include tainting everything.

Related plugins

  • [vim-ruby][], [rails.vim][], [rake.vim][], [bundler.vim][], [rbenv.vim][],
    and [rvm.vim][] all work together to replicate Ruby's $LOAD_PATH.

Notably, rails.vim's intelligent gf map is built on 'path'.

  • [vim-perl][] (included with Vim) uses Perl's @INC.
  • [classpath.vim][] extracts the JVM class path from tools like Maven and
    Leiningen.
  • [fireplace.vim][] mimics Vim's macro definition maps, and optionally
    synergizes with classpath.vim.
  • [scriptease.vim][] brings support to VimL by using 'runtimepath'.
  • [projectionist.vim][] provides for project specific 'path' modification.

Installation

Install using your favorite package manager, or use Vim's built-in package
support:

mkdir -p ~/.vim/pack/tpope/start
cd ~/.vim/pack/tpope/start
git clone https://tpope.io/vim/apathy.git

License

Copyright © Tim Pope. Distributed under the same terms as Vim itself.
See :help license.

添加新评论