---

Ⅰ. 插件描述

Makes CtrlP great project management tool!

Ⅱ. 基本信息

创建日期：  2015-02-23 使用用户：  1 Github星：  1 插件作者：  Takatoshi Iwasa

Ⅲ. 安装方法

使用Vundle管理器安装

在你的.vimrc下添加:

Plugin 'iwataka/ctrlproj-vim'

… 然后在Vim中运行以下命令:

:source %
:PluginInstall

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

使用NeoBundle管理器安装

在你的.vimrc下添加:

NeoBundle 'iwataka/ctrlproj-vim'

… 然后在Vim中运行以下命令:

:source %
:NeoBundleInstall

使用VimPlug管理器安装

在你的.vimrc下添加:

Plug 'iwataka/ctrlproj-vim'

… 然后在Vim中运行以下命令:

:source %
:PlugInstall

使用Pathogen管理器安装

在终端中运行以下命令:

cd ~/.vim/bundle
git clone https://github.com/iwataka/ctrlproj.vim

Ⅳ. 文档说明

# ctrlproj.vim

Introduction

Ctrlproj is an abbreviation of "CtrlP + Project" and provides great project
management features powered by CtrlP. This is based on my first Vim's plug-in
ctrlp-quickref.vim and shipped
with a lot of additional features. Though this is an early-stage experimental
project, this aims to import the features of the awesome pair of Emacs's
Projectile and
Helm by utilizing
CtrlP.

At present, this project includes these features:

• switch between projects
• toggle between files with same names but different extensions (i.e.
  .h<->.c/.cpp)
• toggle between code and its test (experimental)
• kill all buffers in working project
• open files in any other projects

Of course Ctrlproj is fully integrated with CtrlP's features.

Installation

You can use your favorite package manager.

• Pathogen

  git clone http://github.com/iwataka/ctrlproj.vim ~/.vim/bundle/ctrlproj.vim

• vim-plug

  Plug 'iwataka/ctrlproj.vim'

• NeoBundle

  NeoBundle 'iwataka/ctrlproj.vim'

• Vundle

  Plugin 'iwataka/ctrlproj.vim'

Usage

After installing this plug-in, you should register some paths to your projects,
libraries or application sources in ~/.vim/.ctrlproj file or
g:ctrlproj_paths variable. If you prefer the former, you should create
.ctrlproj file in ~/.vim and write like below:

# Write
# Some
# Comments
/path/to/specified/project

# Additional comment
/path/to/specified/directory/*

# You can also exclude specified directory by writing like this
! /path/to/project/you/want/to/exclude

If you prefer the latter, write in your .vimrc like this:

let g:ctrlproj_paths = [
  \ '/path/to/specified/project',
  \ '/path/to/specified/directory/*',
  " You want to exclude specified directory, put '!' at the head.
  \ '! /path/to/project/you/want/to/exclude'
]

That's all!
Run the command :Ctrlproj and you get CtrlP interface with paths you registered
before.

You can narrow the choices by typing characters and press <c-j> to scroll
down and <c-k> to scroll up. If you want to see more detail about CtrlP
interface, you should refer to its help

Then you can press these keys to select one of the projects:

• <enter> to get CtrlP interface again in the selected project. You can
  select files by default CtrlP's key-binds in it, but they are opened by

open-command if you select ones which have the extensions like pdf, html or
something like that.

• <c-t> to delete all buffers in the current project and move the current
  directory to the selected project.
• <c-v> to move the current directory to the selected project without removing
  buffers.
• <c-x> to do grep in the selected directory

More additional commands are provided by Ctrlproj:

• :CtrlprojLastDir

Open CtrlP interface in the last selected directory.

• :CtrlprojEdit

Open the file you register the paths.

• :CtrlprojAlternate

Toggle current buffer to the files which have same names but different
extensions.

• :CtrlprojVAlternate

Almost Same as :CtrlprojAlternate, but open files with :vsplit command.

• :CtrlprojSAlternate

Almost Same as :CtrlprojAlternate, but open files with :split command.

• :CtrlprojSwitch

Toggle current focused code to its test or vice versa. First this command try
to switch the current buffer by using g:ctrlproj_src2test variable. If it
fails, applies built-in function which switch between code and its test.

• :CtrlprojVSwitch

Almost Same as :CtrlprojSwitch, but open files with :vsplit command.

• :CtrlprojSSwitch

Almost Same as :CtrlprojSwitch, but open files with :split command.

• :CtrlprojRemoveBuffers

Remove all buffers included in the current project.

• :CtrlprojRooter

Change the current directory to the project root.

The last three commands utilizes the files which are cached by CtrlP.

• :CtrlprojGrep

Do grep in the current directory.

• :CtrlprojGrepLastKeyword

Do grep in the current directory by using the last keyword.

Options

• g:ctrlproj_readonly_enabled

Set this to 0 to open files without readonly flag.

let g:ctrlproj_readonly_enabled = 1

• g:ctrlproj_refresh_enabled

Set this to 0 to disable refreshing cache files when moving the current
directory with removing buffers.

let g:ctrlproj_refresh_enabled = 1

• g:ctrlproj_open_extensions

If you open files which have extensions contained in this list, they are
opened by "open-command".

let g:ctrlproj_open_extensions = ['html', 'pdf']

• g:ctrlproj_configuration_file

If you want to write paths in other file, set this to the path.

if has('win32') || has('win64')
  let g:ctrlproj_configuration_path = '~/vimfiles/.ctrlproj'
else
  let g:ctrlproj_configuration_path = '~/.vim/.ctrlproj'
en

• g:ctrlproj_paths

This list contains paths which are the candidates of this plug-in.

if has('unix')
  let g:ctrlproj_paths = [
    \ '/usr/lib/ruby/[1-9]\+\(\.[1-9]\+\)*',
    \ '/usr/lib/python[1-9]\+\(\.[1-9]\+\)*',
    \ '/usr/lib/perl/[1-9]\+\(\.[1-9]\+\)*'
    \ ]
else
  let g:ctrlproj_paths = []
endif

• g:ctrlproj_src2test

This list contains paris of source and test patterns. By default this contains
sample templates for Java, Scala and Ruby on rails. If you use your
project-specific templates, override this value.

let g:ctrlproj_src2test = {
  \ 'src/main/java/**/*.java': 'src/test/java/**/*Test.java',
  \ 'src/main/scala/**/*.scala': 'src/test/scala/**/*Test.scala',
  \ 'app/admin/*.rb': 'spec/features/admin/*_spec.rb',
  \ 'app/controllers/*_controller.rb': 'spec/controllers/*_controller_spec.rb',
  \ 'app/decorators/*_decorator.rb': 'spec/decorators/*_decorator_spec.rb',
  \ 'app/helpers/*_helper.rb': 'spec/helpers/*_helper_spec.rb',
  \ 'app/mailers/*_mailers.rb': 'spec/mailers/*_mailer_spec.rb',
  \ 'app/models/*.rb': 'spec/models/*_spec.rb',
  \ 'app/workers/*.rb': 'spec/workers/*_spec.rb'
  \ }

• g:ctrlproj_grep_prompt_string

  This string is displayed when trying to do grep.

  let g:ctrlproj_grep_prompt_string = "Keyword? "

Requirement

• Of course ctrlp.vim
• xdg-open command (if you use Linux OS)
• ctrlp-cmatcher(optional, but
  recommended)
• the_silver_searhcer(optional,
  but recommended)

Bugs & Improvements

If you find any bugs or suggestions for improvements, feel free to report them.