" Open menu :CodeQueryMenu Unite Full " Or query directly :CodeQuery Definition get_user_id
This Vim plugin is built on top of the great tool CodeQuery created by ruben2020, and aims at providing three primary functions to help you to:
- Search source code gracefully within Vim.
- You can find:
definition, call, caller, callee, symbol, class, parent, childand more for a string.
- Convenient menus are created for you.
- Well-formated results are shown in a custom Quickfix window with usable key bindings.
- Support asynchronous search (Vim version >= 8.0)
- You can find:
- Manage your database easily.
- Load, make and move your database file by custom Vim commands.
- Support asynchronous build (Vim version >= 8.0 or NeoVim or by
Note: CodeQuery's SQLite database is built on top of ctags and cscope.
- Know your code more instantly.
Choose a query from menu ➙ Get results
... ➙ Switch to different query ➙ Get results ... ➙ Filter them ➙ Get Results ➙ Undo ➙ Redo
These videos are quite old. Now vim-codequery works better than what you see by using Vim8's async feature.
This project is released.
Use Vim8's new features to enhance usability.
Support NeoVim at a certain level.
- Add explain command in v1.0.0
- Make UI be optional
- Doc it.
Current Version: v0.9.2
Welcome to try it!
1. Make sure these commands are in your system
/bin/sh echo mkdir mv cut find awk stat git(optional)
2. Install CodeQuery
- Linux => Install binaries or build it.
- Mac =>
brew install codequery
🍺(make sure codequery version >= v0.17.0)
3. Install additional ctags/cscope tools for your languages
|Language||Tools||How to install|
C++users do not need to install additional ctags/cscope tools.
Starscope has been packaged for Arch Linux
4. Install Vim plugins
- Use your favorite plugins manager: pathogen, Vundle, Plug, NeoBundle, Dein, ...
- Take Plug as an example:
" Required Plug 'Shougo/unite.vim' Plug 'devjoe/vim-codequery' " Optional " if your vim version < 8.0 Plug 'tpope/vim-dispatch' " if you don't have an :Ack (or :Ag) liked command Plug 'mileszs/ack.vim'
- In case you prefer to use Vim8's native package manager to manage plugins manually. Here comes an installation guide for that:
- Go to
mkdir -p pack/vim-codequery/start/and then go to
git clone https://github.com/devjoe/vim-codequeryto get latest vim-codequery code
- It's done.
vim-codequerywill be loaded when your Vim starts. You can install unite in the same way
- Learn more about Vim8's package system by typing
:help package | only
- Go to
- Go to the (git) root directory of your project. Open vim and type:
- That's all.
- It's recommended that you should use
:CodeQueryMoveDBToGitDir pythonto hide the DB file to
.git/codequery/directory. If you do so, next time you can call
:CodeQueryMakeDBdirectly in any opened Python buffer to rebuild the DB file.
- Find symbol under your cursor
- Find word (by subcommands) under your cursor
:CodeQuery [SubCommand] " Supported SubCommands are: `Symbol, Text, Call, Caller, Callee, Class, Parent, Child, Member, FunctionList, FileImporter`.
- Find arbitrary word
:CodeQuery [SubCommand] [word]
- Find again with the same word
- Use fuzzy Option
:CodeQuery [SubCommand] [word] -f " [word] can be: get_* or *user_info or find_*_by_id
- Use append Option (results will be added to the current Quickfix)
:CodeQuery [SubCommand] [word] -a
- Filter Search Results
:CodeQueryFilter [string] " [string] can be a regex
3. Use Quickfix
- Move your cursor inside Quickfix window to use these key bindings
||Older Quickfix Result|
||Newer Quickfix Result|
#1 You can override
g:codequery_find_text_cmdto change it.
- Show Quickfix with above key bindings
:CodeQueryShowQF " This command can also be used to **patch** standard Quickfix.
4. Open Menu
Currently, vim-codequery only provides Unite menu because I love it ⭐. There are two types of menu:
- Full Unite menu
:CodeQueryMenu Unite Full " The string between :: and :: is the word under cursor " [F] means this action is for 'function variable only' " [C] is for 'class variable only'
- Magic Unite menu
:CodeQueryMenu Unite Magic " This menu changes dynamically: " 1. If the word under your cursor begins with a capital letter (possible be class): show [C] actions " 2. Vice versa (possible be function): show [F] actions " 3. Show reasonable actions within Quickfix
nnoremap <space>c :CodeQueryMenu Unite Full<CR> nnoremap <space>; :CodeQueryMenu Unite Magic<CR> " Or enable typing (to search menu items) by default nnoremap <space>\ :CodeQueryMenu Unite Magic<CR>A
nnoremap <space><CR> :CodeQuery Symbol<CR> " Chain commands to find possible tests (for python) nnoremap <space>t :CodeQuery Caller<CR>:CodeQueryFilter test_<CR>
" Filter reversely by adding '!' :CodeQueryFilter ! [word]
" Trigger db building (in current filetype) when your query fails let g:codequery_trigger_build_db_when_db_not_found = 1
" Custom your `CodeQuery Text` commands let g:codequery_find_text_cmd = 'Ack!' let g:codequery_find_text_from_current_file_dir = 0 " 0 => search from project dir (git root directory -> then the directory containing xxx.db file) " 1 => search from the directory containing current file " If you use ':CodeQuery Symbol' in a txt file, of course, it will fail due to wrong filetype. " With the following option set to 1, ':CodeQuery Text' will be automatically sent when your query fails. let g:codequery_auto_switch_to_find_text_for_wrong_filetype = 0
Load Ctags File
Clean Ctags, Cscope ... Files by Languages
let g:codequery_enable_auto_clean_languages = ['python'] " It accpepts a list of your languages written in lowercase
Custom Database Building
" You can disable key binding within quickfix let g:codequery_disable_qf_key_bindings = 1 " if your function usually begins with a capital letter ..., you can change your magic menu to a not-so-magic one let g:codequery_enable_not_so_magic_menu = 1
Why writing this plugin?
Because I need it.
Why not using Ctags or Cscope directly?
Read what @ruben2020 the author of CodeQuery said: Link
In addittion, vim-codequery provides:
- Good interface.
- Separated Database Management Mechanism.
(You can open as many projects as you wish in a single Vim session without worrying about messing up Ctags or Cscope files or getting wrong result!)
for Vim users.
Ask here or create an issue.
How to Contribute
And give me PR. It would be better if you open an issue and discuss with me before sending PR.
If you like it.
Thank all for working on these great projects!