[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]
[elpa] externals/orderless e3062280f9: Add note on how to use orderless
From: |
ELPA Syncer |
Subject: |
[elpa] externals/orderless e3062280f9: Add note on how to use orderless from helm (fix #105) |
Date: |
Fri, 23 Dec 2022 17:58:10 -0500 (EST) |
branch: externals/orderless
commit e3062280f924933e9c6f5dd1a71729ed98c8493a
Author: Omar Antolín <omar.antolin@gmail.com>
Commit: Omar Antolín <omar.antolin@gmail.com>
Add note on how to use orderless from helm (fix #105)
---
README.org | 18 +++++++++++++++---
orderless.texi | 40 +++++++++++++++++++++++++++++-----------
2 files changed, 44 insertions(+), 14 deletions(-)
diff --git a/README.org b/README.org
index e9c166d561..eed72022a3 100644
--- a/README.org
+++ b/README.org
@@ -345,6 +345,16 @@ To use =orderless= from Ivy add this to your Ivy
configuration:
(add-to-list 'ivy-highlight-functions-alist '(orderless-ivy-re-builder .
orderless-ivy-highlight))
#+end_src
+** Helm
+
+To use =orderless= from Helm, simply configure =orderless= as you would
+for completion UIs that use Emacs completion stlyes and add this to
+your Helm configuration:
+
+#+begin_src emacs-lisp
+(setq helm-completion-style 'emacs)
+#+end_src
+
** Selectrum
Recent versions of Selectrum default to using whatever completion
@@ -360,6 +370,8 @@ configuration you can use =orderless= just by adding it to
If you use the above configuration, only the visible candidates are
highlighted, which is a litte more efficient.
+Note that Selectrum has been deprecated in favor of Vertico.
+
** Company
Company comes with a =company-capf= backend that uses the
@@ -410,7 +422,6 @@ can add this to your config:
(advice-add 'company-capf :around #'company-completion-styles)
#+end_src
-
* Related packages
** Ivy and Helm
@@ -421,8 +432,9 @@ order. In Ivy, this is done with the
=ivy--regex-ignore-order= matcher.
In Helm, it is the default, called "multi pattern matching".
This package is significantly smaller than either of those because it
-solely defines a completion style, meant to be used with any completion UI
supporting completion styles while both of those provide their own
-completion UI (and many other cool features!).
+solely defines a completion style, meant to be used with any
+completion UI supporting completion styles while both of those provide
+their own completion UI (and many other cool features!).
It is worth pointing out that Helm does provide its multi pattern
matching as a completion style which could be used with default tab
diff --git a/orderless.texi b/orderless.texi
index 80cfb5f4f1..84c8cb0199 100644
--- a/orderless.texi
+++ b/orderless.texi
@@ -49,6 +49,7 @@ Component matching styles
Integration with other completion UIs
* Ivy::
+* Helm::
* Selectrum::
* Company::
@@ -394,6 +395,7 @@ integration.
@menu
* Ivy::
+* Helm::
* Selectrum::
* Company::
@end menu
@@ -408,6 +410,17 @@ To use @samp{orderless} from Ivy add this to your Ivy
configuration:
(add-to-list 'ivy-highlight-functions-alist '(orderless-ivy-re-builder .
orderless-ivy-highlight))
@end lisp
+@node Helm
+@section Helm
+
+To use @samp{orderless} from Helm, simply configure @samp{orderless} as you
would
+for completion UIs that use Emacs completion stlyes and add this to
+your Helm configuration:
+
+@lisp
+(setq helm-completion-style 'emacs)
+@end lisp
+
@node Selectrum
@section Selectrum
@@ -424,6 +437,8 @@ configuration you can use @samp{orderless} just by adding
it to
If you use the above configuration, only the visible candidates are
highlighted, which is a litte more efficient.
+Note that Selectrum has been deprecated in favor of Vertico.
+
@node Company
@section Company
@@ -440,11 +455,13 @@ Pressing SPC takes you out of completion, so with the
default
separator you are limited to one component, which is no fun. To fix
this add a separator that is allowed to occur in identifiers, for
example, for Emacs Lisp code you could use an ampersand:
+@end enumerate
@lisp
(setq orderless-component-separator "[ &]")
@end lisp
+@enumerate
@item
The matching portions of candidates aren't highlighted. That's
because @samp{company-capf} is hard-coded to look for the
@@ -454,6 +471,7 @@ because @samp{company-capf} is hard-coded to look for the
So, while you can't get different faces for different components,
you can at least get the matches highlighted in the sole available
face with this configuration:
+@end enumerate
@lisp
(defun just-one-face (fn &rest args)
@@ -464,7 +482,6 @@ face with this configuration:
@end lisp
(Aren't dynamically scoped variables and the advice system nifty?)
-@end enumerate
If you would like to use different @samp{completion-styles} with
@samp{company-capf} instead, you
can add this to your config:
@@ -497,8 +514,9 @@ order. In Ivy, this is done with the
@samp{ivy--regex-ignore-order} matcher.
In Helm, it is the default, called ``multi pattern matching''.
This package is significantly smaller than either of those because it
-solely defines a completion style, meant to be used with any completion UI
supporting completion styles while both of those provide their own
-completion UI (and many other cool features!).
+solely defines a completion style, meant to be used with any
+completion UI supporting completion styles while both of those provide
+their own completion UI (and many other cool features!).
It is worth pointing out that Helm does provide its multi pattern
matching as a completion style which could be used with default tab
@@ -519,14 +537,14 @@ install Helm and configure Icomplete to use it as follows:
@node Prescient
@section Prescient
-The @uref{https://github.com/raxod502/prescient.el, prescient.el} library also
provides matching of space-separated
-components in any order and it can be used with either the
@uref{https://github.com/raxod502/selectrum, Selectrum} or
-@uref{https://github.com/abo-abo/swiper, Ivy} completion UIs (it does not
offer a completion-style that could be
-used with Emacs' default completion UI, Mct, Vertico or with Icomplete).
-The components can be matched literally, as regexps, as initialisms or
-in the flex style (called ``fuzzy'' in prescient). In addition to
-matching, @samp{prescient.el} also supports sorting of candidates
(@samp{orderless}
-leaves that up to the candidate source and the completion UI).
+The @uref{https://github.com/raxod502/prescient.el, prescient.el} library also
provides matching of space-separated components in
+any order. It offers a completion-style that can be used with Emacs' default
+completion UI, Mct, Vertico or with Icomplete. Furthermore Selectrum and Ivy
are
+supported. The components can be matched literally, as regexps, as initialisms
+or in the flex style (called ``fuzzy'' in prescient). Prescient does not offer
the
+same flexibility as Orderless with its style dispatchers. However in addition
to
+matching, Prescient supports sorting of candidates, while Orderless leaves that
+up to the candidate source and the completion UI@.
@node Restricting to current matches in Icicles Ido and Ivy
@section Restricting to current matches in Icicles, Ido and Ivy
[Prev in Thread] |
Current Thread |
[Next in Thread] |
- [elpa] externals/orderless e3062280f9: Add note on how to use orderless from helm (fix #105),
ELPA Syncer <=