doomemacs/modules/completion/company/README.org

44 lines
1.7 KiB
Org Mode
Raw Normal View History

2017-08-22 02:07:07 +08:00
#+TITLE: :completion company
2017-05-26 02:08:50 +08:00
2017-08-22 02:07:07 +08:00
This module adds code-completion support, powered by [[https://github.com/company-mode/company-mode][company]].
2017-05-26 02:08:50 +08:00
+ Uses ~company-quickhelp~ for documentation tooltips
+ Uses ~company-statistics~ to order results by usage frequency
[[/../screenshots/company.png]]
2017-08-22 02:07:07 +08:00
* Table of Contents :TOC:
- [[#install][Install]]
- [[#configure][Configure]]
- [[#auto-completion][Auto-completion]]
- [[#troubleshooting][Troubleshooting]]
2017-05-26 02:08:50 +08:00
2017-08-22 02:07:07 +08:00
* Install
Certain languages may require additional setup, and some languages may have no completion support at all.
2017-05-26 02:08:50 +08:00
2017-08-22 02:07:07 +08:00
Check the README.org in that language's module for details.
2017-05-26 02:08:50 +08:00
2017-08-22 02:07:07 +08:00
* Configure
** Auto-completion
By default, I've disabled auto-completion. This is my preference. I prefer to invoke company when I need it by calling ~company-complete~ manually (typically, bound to =C-SPC= in insert mode). However, some may not share my preference.
2017-05-26 02:08:50 +08:00
2017-08-22 02:07:07 +08:00
To enable auto-completion you must:
2017-05-26 02:08:50 +08:00
1. Load ~company~,
2. and change ~company-idle-delay~ to a non-nil float (the default is 0.5)
2017-08-22 02:07:07 +08:00
For example, add the following to your ~modules/private/<username>/config.el~ module:
2017-05-26 02:08:50 +08:00
#+BEGIN_SRC emacs-lisp
(require 'company)
(setq company-idle-delay 0.2
company-minimum-prefix-length 3)
#+END_SRC
2017-08-22 02:07:07 +08:00
* Troubleshooting
2017-05-26 02:08:50 +08:00
If completion isn't working for you, please consider the following before posting a bug report:
2017-08-22 02:07:07 +08:00
+ If what you are expecting is popup-as-you-type completion (which is disabled by default), see the "Customize" section above; it includes instructions on how to enable this.
+ Certain languages may have extra dependencies in order for auto-completion to work. Please look for that module's README.org for details.
2017-05-26 02:08:50 +08:00
+ Some languages don't have any auto-completion support.