Ⅰ. 插件描述
The Clojure completion library you deserveⅡ. 基本信息
|
Ⅲ. 安装方法
使用Vundle管理器安装
在你的.vimrc下添加:Plugin 'alexander-yakushev/compliment'
… 然后在Vim中运行以下命令:
:source %
:PluginInstall
对于Vundle版本 < 0.10.2,请用上面的Bundle替换Plugin。
使用NeoBundle管理器安装
在你的.vimrc下添加:NeoBundle 'alexander-yakushev/compliment'
… 然后在Vim中运行以下命令:
:source %
:NeoBundleInstall
使用VimPlug管理器安装
在你的.vimrc下添加:Plug 'alexander-yakushev/compliment'
… 然后在Vim中运行以下命令:
:source %
:PlugInstall
使用Pathogen管理器安装
在终端中运行以下命令:cd ~/.vim/bundle
git clone https://github.com/alexander-yakushev/compliment
Ⅳ. 文档说明
- Compliment [https://circleci.com/gh/alexander-yakushev/compliment] [https://coveralls.io/r/alexander-yakushev/compliment?branch=master] [https://clojars.org/compliment] [https://versions.deps.co/alexander-yakushev/compliment] [CHANGELOG.md]
Compliment is an ultimate Clojure completion library. It provides a fast and
smart solution to complete vars, namespaces, class members, keywords, locals.
It also allows users to implement custom completion sources.
Compliment is used as a completion backend in the following editors/IDEs:
- Emacs --- [https://cider.readthedocs.io/en/latest/code_completion/] (through [http://company-mode.github.io/] or, now deprecated, [https://github.com/clojure-emacs/ac-cider])
- Vim --- [https://github.com/tpope/vim-fireplace]
- Neovim --- [https://github.com/Olical/conjure]
- Atom --- [https://atom.io/packages/proto-repl] and [https://atom.io/packages/chlorine]
- [https://sekao.net/nightcode/]
- [https://sekao.net/nightlight/]
- @bhauman's [https://github.com/bhauman/rebel-readline/]
Also, I am so glad you came here. You look gorgeous today.
** Rationale
I wrote Compliment specifically for you because you are amazing and I believe
you deserve a matching completion lib. Here are the features it boasts:
- Speed. Your time is too precious to wait for completion to happen.
Compliment is designed to be fast and is carefully benchmarked to make sure
no sudden performance drops appear. - Smart completion. Such a smart person like you is entitled to completion
being smart as well. Default Compliment sources use various techniques to
give more meaningful completion depending on the context, and allow some
fuzziness in prefix. - Extensibility. Your insatiable passion for exploration won't be satisfied
by a set in stone completion list. For this reason Compliment allows every
library developer to write custom sources, so later other users of the
library will have better experience utilizing it.
** Installation
If you use Nightcode, vim-fireplace, or Atom, then you don't have to install
anything at all --- Compliment will already be there for you. In case you are
an Emacs+CIDER user you'll also need to install [http://company-mode.github.io/] and
[https://github.com/expez/company-quickhelp]. This [https://cider.readthedocs.io/en/latest/code_completion/] will help you configure it.
If you need Compliment embedded directly into your program then add this to
the =:dependencies=:
[https://clojars.org/compliment]
** Examples
[https://github.com/alexander-yakushev/compliment/wiki/Examples] you can find examples of different completion scenarios
Compliment supports so far.
** For developers
See the test files to get an idea how public API and completion sources work.
To understand what is a context and how it works see [https://github.com/alexander-yakushev/compliment/wiki/Context] wiki
page.
How to write your own sources is explained on [https://github.com/alexander-yakushev/compliment/wiki/Custom-sources] page.
** License
Copyright © 2013-2019 Alexander Yakushev. Distributed under the Eclipse
Public License, the same as Clojure. See [https://github.com/alexander-yakushev/compliment/blob/master/LICENSE].