web-capf derives better completions for web-related modes, such as
html-mode, css-mode and web-mode.
In web-mode, it also supports sub parts in html like below:
- css parts inside
<style>tags - javascript parts inside
<script>tags or<%~%>forms in .ejs file - php parts inside
<?~?>forms in .php file - ruby parts inside
<%~%>forms in .erb file
Note that the completions in script parts require the external capfs suitable for those languages.
It works as a member of completion-at-point-functions,
that is, works with some modern completion frameworks,
Corfu,
Company, and so on.
;;; use corfu-mode and cape
(require 'corfu)
(require 'orderless)
(require 'cape)
(require 'cape-keyword)
(require 'web-capf)
;; setup corfu-mode
(setq corfu-auto t)
(setq corfu-auto-prefix 1)
(setq corfu-on-exact-match nil)
(setq corfu-preselect-first nil)
(setq corfu-cycle t)
(add-hook 'minibuffer-setup-hook
(lambda ()
(when (where-is-internal 'completion-at-point (list (current-local-map)))
(setq-local corfu-auto nil)
(corfu-mode 1))))
(add-hook 'corfu-mode-hook
(lambda ()
(setq completion-styles '(orderless))
(setq completion-category-defaults nil)
(setq completion-category-overrides nil)
(setq tab-always-indent 'complete)
(setq tab-first-completion 'eol)
(setq-local orderless-style-dispatchers
'((lambda (pattern index total)
(and (eq index 0) 'orderless-flex))))))
;; setup capfs; set web-capf and some capfs derived by cape
(let ((setup-capf
(lambda ()
(setq-local completion-at-point-functions
(list (car completion-at-point-functions)
'cape-file 'web-capf 'cape-keyword 'cape-dabbrev)))))
(add-hook 'text-mode-hook setup-capf)
(add-hook 'prog-mode-hook setup-capf)
(add-hook 'web-mode-hook setup-capf))
(add-to-list 'completion-at-point-functions 'cape-file t)
(add-to-list 'completion-at-point-functions 'web-capf t)
(add-to-list 'completion-at-point-functions 'cape-keyword t)
(add-to-list 'completion-at-point-functions 'cape-dabbrev t)
;; use cape for script completion in web-mode
(setq web-capf-javascript-fallback 'cape-keyword)
(setq web-capf-php-fallback 'cape-keyword)
(setq web-capf-ruby-fallback 'cape-keyword)
(global-corfu-mode 1);;; use company (also needs cape)
(require 'company)
(require 'cape)
(require 'web-capf)
;; setup company
(setq company-idle-delay 0)
(setq company-minimum-prefix-length 1)
(setq company-selection-wrap-around t)
(setq completion-ignore-case t)
(setq company-dabbrev-downcase nil)
(setq company-transformers '(company-sort-by-backend-importance))
;; setup company-backends; set web-capf through company-capf,
;; and some backends derived by company
(setq company-backends '((company-capf company-dabbrev-code company-keywords)))
(setq completion-at-point-functions '(web-capf))
;; use company for script completion in web-mode
(let ((capf (cape-company-to-capf
(apply-partially #'company--multi-backend-adapter
'(company-dabbrev-code company-keywords)))))
(setq web-capf-javascript-fallback capf)
(setq web-capf-php-fallback capf)
(setq web-capf-ruby-fallback capf))
(global-company-mode 1)Fallback capf for javascript part in web-mode.
Default is nil, then no completion in javascript part.
Note that the fallback configuration by adding some capfs, for example,
cape-keyword to completion-at-point-functions might not work due
to unmatched major-mode.
Setting this value works well because it makes web-capf call the
fallback capf with masquerading major-mode to javascript-mode.
;;; use corfu-mode and cape
;; cape-keyword might not work inside javascript part in web-mode,
;; but must be set because it works in native javascript-mode
(let ((setup-capf
(lambda ()
(setq-local completion-at-point-functions
(list (car completion-at-point-functions)
'cape-file 'web-capf 'cape-keyword 'cape-dabbrev)))))
(add-hook 'text-mode-hook setup-capf)
(add-hook 'prog-mode-hook setup-capf)
(add-hook 'web-mode-hook setup-capf))
;; cape-keyword works well in web-mode by making web-capf call it
(setq web-capf-javascript-fallback 'cape-keyword);;; use company (also needs cape)
;; company-dabbrev-code and company-keywords might not work inside
;; javascript part in web-mode, but must be set because they work in
;; native javascript-mode
(setq company-backends '((company-capf company-dabbrev-code company-keywords)))
(setq completion-at-point-functions '(web-capf))
;; company-dabbrev-code and company-keywords work well in web-mode by
;; making web-capf call them
(setq web-capf-javascript-fallback
(cape-company-to-capf
(apply-partially #'company--multi-backend-adapter
'(company-dabbrev-code company-keywords))))Fallback capf for php part in web-mode.
See web-capf-javascript-fallback
for detail.
Fallback capf for ruby part in web-mode.
See web-capf-javascript-fallback
for detail.
Set this function as a member of completion-at-point-functions.
web-capf works only in html-mode, css-mode and web-mode, but
harmless to be set in the other modes.
That is all when use with corfu-mode, because it works as a frontend
of the standard completion framework in Emacs.
;;; use corfu-mode and cape
(let ((setup-capf
(lambda ()
(setq-local completion-at-point-functions
(list (car completion-at-point-functions)
'cape-file 'web-capf 'cape-keyword 'cape-dabbrev)))))
(add-hook 'text-mode-hook setup-capf)
(add-hook 'prog-mode-hook setup-capf)
(add-hook 'web-mode-hook setup-capf))To use with company-mode, set company backend to company-capf and
set completion-at-point-functions to include web-capf.
;;; use company
(setq company-backends '((company-capf company-dabbrev-code company-keywords)))
(setq completion-at-point-functions '(web-capf))