Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/neoclide/coc-lists

Common lists for coc.nvim
https://github.com/neoclide/coc-lists

coc list neovim vim

Last synced: 23 days ago
JSON representation

Common lists for coc.nvim

Awesome Lists containing this project

README 

        
# coc-lists



Some basic list sources for [coc.nvim](https://github.com/neoclide/coc.nvim/)



Including:



- [x] `buffers` current buffer list.

- [x] `changes` changes list.

- [x] `cmdhistory` history of commands.

- [x] `colors` colors schemes.

- [x] `files` search files from current cwd.

- [x] `filetypes` file types.

- [x] `grep` grep text from current cwd.

- [x] `helptags` helptags of vim.

- [x] `lines` search lines by regex patterns.

- [x] `locationlist` items from vim's location list.

- [x] `maps` key mappings.

- [x] `marks` marks of vim.

- [x] `mru` most recent used files.

- [x] `quickfix` items from vim's quickfix list.

- [x] `registers` registers of vim.

- [x] `searchhistory` history of search.

- [x] `sessions` session list.

- [x] `tags` search tag files.

- [x] `vimcommands` available vim commands.

- [x] `windows` windows of vim.

- [x] `words` search word in current buffer.

- [x] `functions` available vim functions.



For snippets list, use [coc-snippets](https://github.com/neoclide/coc-snippets).



For git related list, use [coc-git](https://github.com/neoclide/coc-git).



For yank history, use [coc-yank](https://github.com/neoclide/coc-yank).



## Install



In your vim/neovim, run command:



```

:CocInstall coc-lists

```



Checkout `:h coc-list` for usage.



## Options



**Tip:** type `?` on normal mode to get detail help of current list.



Available options for coc-lists:



- `session.saveOnVimLeave` Save session on VimLeavePre., default to `true`

- `session.directory` directory for session files, default to `~/.vim/sessions`

- `session.restartOnSessionLoad` Restart vim with cwd changed on session load, support neovim on iTerm2 only.

- `lists.disabledLists`: List names to disable form load., default: `[]`

- `list.source.files.command`: Command used for search for files, default: `""`

- `list.source.files.args`: Arguments for search command, default: `[]`

- `list.source.files.excludePatterns`: Minimatch patterns that should be excluded., default: `[]`

- `list.source.mru.maxLength`: Max length of mru list., default: `1000`

- `list.source.mru.ignoreGitIgnore`: Ignore git ignored files., default: `false`

- `list.source.mru.excludePatterns`: Minimatch patterns that should be excluded., default: `["**/.git/*","/tmp/*"]`

- `list.source.grep.useLiteral`: Use literal match unless specified regex options, default: true., default: `true`

- `list.source.grep.command`: Command used for grep, default to 'rg'., default: `"rg"` could be `rg` or `ag`.

- `list.source.grep.maxColumns`: Don't print lines longer than this limit in bytes, ripgrep only..

- `list.source.tags.command`: Command used for generate tags., default: `"ctags -R ."`

- `list.source.grep.args`: Arguments for grep command, always used for grep, default: `[]`

- `list.source.grep.excludePatterns`: Minimatch patterns of files that should be excluded, use .ignore file is recommended., default: `[]`



## Commands



- `mru.validate` remove none exists files from mru list.

- `tags.generate` generate tags of current project (in current cwd).

- `session.save` save current vim state to session file.

- `session.load` load exists session file.



## F.A.Q



Q: Hidden files not exists using files source.



A: You have to pass `--hidden` to `ripgrep` by using configuration:



    `list.source.files.args`: ['--hidden', '--files']



Q: How to ignore files using files/grep source.



A: You can add `.ignore` file in your project root, which would be respected by

`ripgrep` or use `list.sourcefiles.excludePatterns` configuration.



Q: How to make grep easier?



A: Create custom command like:



```vim

" grep word under cursor

command! -nargs=+ -complete=custom,s:GrepArgs Rg exe 'CocList grep '.



function! s:GrepArgs(...)

  let list = ['-S', '-smartcase', '-i', '-ignorecase', '-w', '-word',

        \ '-e', '-regex', '-u', '-skip-vcs-ignores', '-t', '-extension']

  return join(list, "\n")

endfunction



" Keymapping for grep word under cursor with interactive mode

nnoremap  cf :exe 'CocList -I --input='.expand('').' grep'

```



Q: How to grep by motion?



A: Create custom keymappings like:



```vim

vnoremap g :call GrepFromSelected(visualmode())

nnoremap g :set operatorfunc=GrepFromSelectedg@



function! s:GrepFromSelected(type)

  let saved_unnamed_register = @@

  if a:type ==# 'v'

    normal! `y

  elseif a:type ==# 'char'

    normal! `[v`]y

  else

    return

  endif

  let word = substitute(@@, '\n$', '', 'g')

  let word = escape(word, '| ')

  let @@ = saved_unnamed_register

  execute 'CocList grep '.word

endfunction

```



Q: How to grep current word in current buffer?



A: Create kep-mapping like:



```vim

nnoremap  w  :exe 'CocList -I --normal --input='.expand('').' words'

```



Q: How to grep word in a specific folder?



A: Pass `-- /folder/to/search/from` to `CocList grep`



```vim

:CocList grep word -- /folder/to/search/from

```



## License



MIT