blob: 3078ad1fd0fb543ae13c959665f2d93adfb2f572 (
plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
|
CIDER provides intelligent code completion for both source buffers (powered by
`cider-mode`) and REPL buffers.
## Standard completion
Out-of-the box CIDER uses the standard Emacs tooling for code completion. When you
press <kbd>TAB</kbd> or <kbd>M-TAB</kbd> you'll get completion candidates in a
dedicated buffer.
## Auto-completion
CIDER users are advised to use [`company-mode`](http://company-mode.github.io/)
to enable auto-completion inside of source code and REPL buffers. To install
`company-mode` do:
<kbd>M-x</kbd> `package-install` <kbd>RET</kbd> `company` <kbd>RET</kbd>
After installation, company can be turned on globally, like so --
```el
(global-company-mode)
```
-- or through mode-specific hooks:
```el
(add-hook 'cider-repl-mode-hook #'company-mode)
(add-hook 'cider-mode-hook #'company-mode)
```
When `company-mode` is thus enabled, it will receive completion information
from `cider-complete-at-point`, and requires no additional setup or plugins.
If you'd prefer to trigger completions manually you can add this to you config:
```el
(setq company-idle-delay nil) ; never start completions automatically
(global-set-key (kbd "M-TAB") #'company-complete) ; use M-TAB, a.k.a. C-M-i, as manual trigger
```
To make <kbd>TAB</kbd> complete, without losing the ability to manually indent,
you can add this to your config:
```el
(global-set-key (kbd "TAB") #'company-indent-or-complete-common)
```
`company-indent-or-complete-common` is available only in `company-mode` 0.9+ (at
the time of this writing it's still in development).
### Fuzzy candidate matching
By default `company-mode` will provide completion candidates with the assumption
that whatever you've typed so far (e.g. `map-`) is a completion prefix (meaning
you'd get only candidates that have `map-` in the beginnings of their names).
You can get enhanced fuzzy completion with `company-mode` if you install the
additional package [company-flx](https://github.com/PythonNut/company-flx).
This is powered internally by [flx](https://github.com/lewang/flx).
Basically with `company-flx` enabled typing something like `mp` will show you
`map-indexed` as one of the possible completion candidates.
### Migrating from `auto-complete-mode`
In case you have some `auto-complete-mode` configuration lying around and you
want to switch to `company-mode` there are a few steps you have to take:
* Disable `ac-cider-setup` or `ac-nrepl-setup` from running on CIDER hooks
* Remove `cider-mode` and `cider-repl-mode` from the `ac-modes` list
### Completion annotations
Completion candidates will be annotated by default with an abbreviation
corresponding to their type, and (contextually) their namespace. The function
used to format the annotation can be configured by
`cider-annotate-completion-function.` The abbreviations used are configured by
`cider-completion-annotations-alist` and the context in which their namespace is
included is configured by `cider-completion-annotations-include-ns.`
Completion annotations can be disabled by setting
`cider-annotate-completion-candidates` to `nil`.
|
