Introduce cider-enable-flex-completion
#3509
Conversation
cider-completion.el
Outdated
| (setq-local completion-styles '(cider))) | ||
|
|
||
| (make-obsolete 'cider-company-enable-fuzzy-completion 'cider-company-enable-fuzzy-completion-globally "1.8.0") | ||
|
|
||
| (defun cider-company-enable-fuzzy-completion-globally () |
There was a problem hiding this comment.
The old cider-company-enable-fuzzy-completion worked on a per-buffer fashion, which isn't necessarily the best UX.
cider-company-enable-fuzzy-completion-globally can afford to work globally instead, because completion-category-overrides works on our own cider category, which allows us to operate "globally within a namespace" i.e. safely.
There was a problem hiding this comment.
Yeah, I get this, although for the end users it'd be more or less the same (as the hook would be triggered in any cider-mode buffer), so I'm big concerned the name might be confusing. That was part of the reason I suggested the use of flex instead of fuzzy. I'm also thinking that is not company specific, so we should probably drop company from the name.
|
As mentioned on Slack my main concern is whether this should be used via a hook, given that it seems to be modifying some global settings and functions triggered by hooks usually are buffer-local. I'm guessing this can just be some function that users can trigger manually in their setups. Perhaps something like |
| (interactive) | ||
| (when (< emacs-major-version 27) | ||
| (user-error "`cider-company-enable-fuzzy-completion-globally' requires Emacs 27 or later")) | ||
| (let ((found-styles (when-let ((cider (assq 'cider completion-category-overrides))) |
There was a problem hiding this comment.
This you base this code on something from another mode? I'm a bit surprised the that setting those completion-category-overrides has so many steps, but I'm also not very familiar with the modern completion engine in Emacs.
There was a problem hiding this comment.
This is simply for updating a nested structure like ((foo (styles bar) (cycle t)) (cider (styles basic flex))) in a way that preserves other entries.
Sadly we don't have something as handy as update-in, it seems!
cider-completion.el
Outdated
| ;; note that there's already a completion category named `cider' (grep for `(metadata (category . cider))` in this file), | ||
| ;; which can be confusing given the identical name. | ||
| ;; The `cider' completion style should be removed because the `flex' style is essentially equivalent. | ||
| ;; (`flex' was introduced 3 years later, to be fair) |
There was a problem hiding this comment.
It's best to use specific years (e.g. 2020 or even better - Emacs 27) here, as comments become outdated at some point.
| Now, `company-mode` will accept certain fuzziness when matching | ||
| candidates against the prefix. For example, typing `mi` will show you | ||
| `map-indexed` as one of the possible completion candidates and `cji` | ||
| will complete to `clojure.java.io`. Different completion examples are | ||
| shown | ||
| https://github.com/alexander-yakushev/compliment/wiki/Examples[here]. | ||
|
|
||
| NOTE: `cider-company-enable-fuzzy-completion` (now depreecated) should be used for Emacs < 27. |
There was a problem hiding this comment.
Ah, you already had that note that I suggested elsewhere. :-)
|
Perhaps it would be a bad idea to check what other modes that support |
Replaces `cider-company-enable-fuzzy-completion`, which is now deprecated. This way, the `flex` completion style becomes opt-in (7e68df had inadverntently enabled it unconditionally).
There was a problem hiding this comment.
Perhaps it would be a bad idea to check what other modes that support flex are doing in terms of init code.
The best thing we could do is to implement completion comprehensively such that all styles will work OOTB. It just happens to not be so easy.
That way we could remove the completion-category-overrides customizations, I'd consider it a temporary measure for having control of what really intend to be functional as of today.
In a future, there would be no cider-company-enable-fuzzy-completion-globally or any similar function - users would just add flex in a standard fashion.
| (interactive) | ||
| (when (< emacs-major-version 27) | ||
| (user-error "`cider-company-enable-fuzzy-completion-globally' requires Emacs 27 or later")) | ||
| (let ((found-styles (when-let ((cider (assq 'cider completion-category-overrides))) |
There was a problem hiding this comment.
This is simply for updating a nested structure like ((foo (styles bar) (cycle t)) (cider (styles basic flex))) in a way that preserves other entries.
Sadly we don't have something as handy as update-in, it seems!
| @@ -140,17 +141,21 @@ CIDER-specific "fuzzy completion" by adding: | |||
|
|
|||
| [source,lisp] | |||
| ---- | |||
| (add-hook 'cider-repl-mode-hook #'cider-company-enable-fuzzy-completion) | |||
| (add-hook 'cider-mode-hook #'cider-company-enable-fuzzy-completion) | |||
| (add-hook 'cider-repl-mode-hook #'cider-company-enable-fuzzy-completion-globally) | |||
There was a problem hiding this comment.
I don't think this needs to be a hook, given what the function does - it should just be something the users add to their CIDER config.
vemv
changed the title
cider-company-enable-fuzzy-completion-globallycider-enable-flex-completion
|
Ready again! |
cider-completion.el
Outdated
| (defun cider-enable-flex-completion () | ||
| "Enables `flex' (fuzzy) completion for CIDER in all buffers. | ||
|
|
||
| Only affects the `cider' comlpetion category.`" |
|
Other than the small typo I mentioned - looks good to go. |
|
Thanks! |
Replaces
cider-company-enable-fuzzy-completion, which is now deprecated.This way, the
flexcompletion style becomes opt-in (7e68df had inadvertently enabled it unconditionally).I have QAd this and it works as intended:
iteatn<TAB>will complete nothing by defaultM-x cider-enable-flex-completion,iteatn<TAB>will completeiteration.I also added comments so that we better understand things in a future.
Cheers - V