Re: Rewrite merlin-completion-at-point integration to be faster and better #1827
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
The merlin-completion-at-point integration before was simple and slow. The new version is much faster and much more featureful: - Completions are requested for an entire module at once and filtered locally in Emacs rather than doing the filtering on the Merlin side. - Completions are cached based on the OCaml atom being completed, so they are re-used instead of re-requested when a new character is typed. - Those completions are cached for a given position inside an OCaml atom, so that if a user types Li<TAB>ma<TAB> to complete "List.map" and then decides they actually want the module "Labels", when they delete the "ist.map" part and hit <TAB>, they'll use the previously-requested completions. - We avoid updating Merlin with the new buffer contents as completion proceeds, so that Merlin doesn't need to re-parse and re-type-check, substantially improving performance in expensive files. (merlin-cap--omit-bounds) - Completion requests are handled asynchronously and reused, so that if completion is interrupted and then resumed, we're able to use the results of the previous completion request. This makes completion UIs which use while-no-input (like corfu-mode) much more performant. - Completion is wrapped in while-no-input when non-essential is set; this makes completion UIs which don't use while-no-input (like company-mode) much more responsive. - Completions are sorted more intelligently: if they're a constructor or variant or label, they're likely to be more relevant to the user, so they're sorted first. - Module names in completions are suffixed with a ., matching Emacs behavior for file name completion (where directories are suffixed with a /); this makes completion of module paths much more fluent, since there's no need to hit . after every module name. - We use completion boundaries, so the built-in Emacs partial-completion feature now works: if the user types "Li.ma<TAB>", it will complete to "List.map". - Likewise, partial-completion will expand * as a glob, so if the user types "Deferred.*.map<TAB>" they will be presented with every module in "Deferred." which contains the method "map" There are also several tests now, testing the new functionality.
Replace pos-eol from Emacs 29 with older line-end-position function that exists in Emacs 28 and older.
- Rename position-symbol local value - Make merlin-cap require the compat package. - Add compat to merlin mode
This was referenced Sep 18, 2024
purcell
reviewed
Sep 18, 2024
emacs/check.sh
Outdated
|
|
||
| ELS_TO_CHECK=*.el | ||
| # To reduce the amount of false positives we only package-lint files | ||
| # that are actual installable packages. | ||
| PKGS_TO_CHECK="merlin.el merlin-ac.el merlin-company.el merlin-iedit.el" | ||
| PKGS_TO_CHECK="merlin.el merlin-ac.el merlin-company.el merlin-iedit.el merlin-cap.el tests/merlin-cap-test.el" |
There was a problem hiding this comment.
I don't think this is right any more. From a packaging point of view, merlin, merlin-ac, merlin-company and merlin-iedit are separate packages, because their dependencies are different. Each is built into a separate MELPA package, for granular installation.
However, presumably the intention is that merlin-cap will be part of the base merlin package, since it doesn't depend on anything opinionated that ships separately from Emacs. So it wouldn't be appropriate to run package-lint on merlin-cap separately: instead, run package-lint on both merlin-cap.el and merlin.el together, with the package-lint-main-file variable set to merlin.el.
And merlin-cap-test.el doesn't need package-linting, because it's not shipped in the package.
There was a problem hiding this comment.
Thanks, I did that in a72fd55.
There a still spurious merlin-cap.el: error: You should depend on (emacs "28.1") if you need string-search'.` even if we use the compat module.
merlin.el:477:0: error: `merlin/unmake-point' contains a non-standard separator `/', use hyphens instead (see Elisp Coding Conventions).
merlin.el:608:0: error: `merlin/call' contains a non-standard separator `/', use hyphens instead (see Elisp Coding Conventions).
merlin.el:1194:0: error: `merlin/display-in-type-buffer' contains a non-standard separator `/', use hyphens instead (see Elisp Coding Conventions).
merlin-cap.el:10:0: error: Package-Requires outside the main file have no effect.
merlin-cap.el:341:13: error: You should depend on (emacs "28.1") if you need `string-search'.
merlin-cap.el:356:19: error: You should depend on (emacs "28.1") if you need `string-search'.
merlin-cap.el:376:18: error: You should depend on (emacs "28.1") if you need `string-search'.
There was a problem hiding this comment.
Ah, I was overdue to tag a new package-lint release, so this spurious message was due to the build picking up an old version. Once MELPA has rebuilt the new package-lint version this complaint should go away.
| request was for and whose cdr is the request buffer. Return nil | ||
| if no pending request exists, or its inputs do not match." | ||
| (let ((buf (current-buffer))) | ||
| (with-current-buffer (get-buffer-create " *merlin-async-proc-stdout*" t) |
| (with-current-buffer messages-buffer-name | ||
| (save-excursion | ||
| (forward-line -1) | ||
| (buffer-substring (point) (line-end-position))))) |
There was a problem hiding this comment.
I changed pos-eol to line-end-position this might not be necessary with compat package?
Suggested change
| (buffer-substring (point) (line-end-position))))) | |
| (buffer-substring (point) (pos-eol))))) |
Co-authored-by: Steve Purcell <[email protected]>
Suggested-by: Steve Purcell <[email protected]>
voodoos
force-pushed
the
emacs-cap-wip
branch
from
e1d8d33
to
a72fd55
Compare
Co-authored-by: Steve Purcell <[email protected]>
Co-authored-by: Steve Purcell <[email protected]>
| emacs_version: | ||
| - '27.2' | ||
| - '28.2' | ||
| - '29.1' | ||
| - '29.3' |
There was a problem hiding this comment.
Suggested change
| - '29.3' | |
| - '29.4' |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
The first merge tentative of @catern's rewrite of completion-at-point (CAP) lead us to discover a few issues that need fixing before we release it. I reverted the commits and this PR reintroduces changes made by @tmcgilchrist and myself to move the tests in a separate file, fix linting issues and enable testing on version 27 to 29.
There are two issues with the current status of this PR:
compatmodule breaks the assumption made byopam user-setupthat packages are standalone.This last issue could be fixed by: 1. shipping the compat package with Merlin or 2. Rewriting our own replacement for the missing features.