Autocompletion for the CodeMirror code editor
[ WEBSITE | DOCS | ISSUES | FORUM | CHANGELOG ]
This package implements autocompletion for the CodeMirror code editor.
The project page has more information, a number of examples and the documentation.
This code is released under an MIT license.
We aim to be an inclusive, welcoming community. To make that explicit, we have a code of conduct that applies to communication around the project.
Align the behavior of snippet completions with text completions in that they overwrite the selected text.
Backspacing to the start of the completed range will no longer close the completion tooltip when it was triggered implicitly by typing the character before that range.
Don't immediately show synchronously updated completions when there are some sources that still need to return.
Fix an issue where insertCompletionText would get confused about the length of the inserted text when it contained CRLF line breaks, and create an invalid selection.
Add Alt-Backtick as additional binding on macOS, where IME can take over Ctrl-Space.
Style the info element so that newlines are preserved, to make it easier to display multi-line info from a string source.
When registering an abort handler for a completion query, you can now use the onDocChange option to indicate that your query should be aborted as soon as the document changes while it is running.
Fix an issue where completions weren't properly reset when starting a new completion through activateOnCompletion.
CompletionContext objects now have a view property that holds the editor view when the query context has a view available.
Avoid adding an aria-autocomplete attribute to the editor when there are no active sources active.
Allow backslash-escaped closing braces inside snippet field names/content.
Fix a bug where multiple backslashes before a brace in a snippet were all removed.
The new activateOnCompletion option allows autocompletion to be configured to chain completion activation for some types of completions.
The new filterStrict option can be used to turn off fuzzy matching of completions.
Completion results can now define a map method that can be used to adjust position-dependent information for document changes.
Completions may now provide 'commit characters' that, when typed, commit the completion before inserting the character.
Make sure snippet completions also set userEvent to input.complete.
Fix a crash when the editor lost focus during an update and autocompletion was active.
Fix a crash when using a snippet that has only one field, but multiple instances of that field.
The new activateOnTypingDelay option allows control over the debounce time before the completions are queried when the user types.
Fix a bug that caused typing over closed brackets after pressing enter to still not work in many situations.
Fix an issue that would prevent typing over closed brackets after starting a new line with enter.
Additional elements rendered in completion options with addToOptions are now given access to the editor view.
Fix a bug that caused updateSyncTime to always delay the initial population of the tooltip.
Fix a bug where picking a selection with the mouse could use the wrong completion if the completion list was updated after being opened.
The new autocompletion configuration option updateSyncTime allows control over how long fast sources are held back waiting for slower completion sources.
Fix a bug in completeAnyWord that could cause it to generate invalid regular expressions and crash.
Make sure the cursor is scrolled into view after inserting completion text.
Make sure scrolling completions into view doesn't get confused when the tooltip is scaled.
Completions may now provide a displayLabel property that overrides the way they are displayed in the completion list.
acceptCompletion now returns false (allowing other handlers to take effect) when the completion popup is open but disabled.
The result of Completion.info may now include a destroy method that will be called when the tooltip is removed.
Fix a bug that cause incorrect ordering of completions when some results covered input text and others didn't.
The new hasNextSnippetField and hasPrevSnippetField functions can be used to figure out if the snippet-field-motion commands apply to a given state.
Fix a bug that made the editor use the completion's original position, rather than its current position, when changes happened in the document while a result was active.
Fix a bug in insertCompletionText that caused it to replace the wrong range when a result set's to fell after the cursor.
Functions returned by snippet can now be called without a completion object.
Keep completions open when interaction with an info tooltip moves focus out of the editor.
When closeBrackets skips a bracket, it now generates a change that overwrites the bracket.
Replace the entire selected range when picking a completion with a non-cursor selection active.
Completions can now provide a section field that is used to group them into sections.
The new positionInfo option can be used to provide custom logic for positioning the info tooltips.
Fix a bug where the apply method created by snippet didn't add a pickedCompletion annotation to the transactions it created.
Don't consider node names in trees that aren't the same language as the one at the completion position in ifIn and ifNotIn.
Make sure completions that exactly match the input get a higher score than those that don't (so that even if the latter has a score boost, it ends up lower in the list).
Fix an issue where the extension would sometimes try to draw a disabled dialog at an outdated position, leading to plugin crashes.
A tooltipClass option to autocompletion can now be used to add additional CSS classes to the completion tooltip.
Fix an issue where completion lists could end up being higher than the tooltip they were in.
Set an explicit box-sizing style on completion icons so CSS resets don't mess them up.
Allow closing braces in templates to be escaped with a backslash.
Fix a regression that could cause the completion dialog to stick around when it should be hidden.
Fix a regression where transactions for picking a completion (without custom apply method) no longer had the pickedCompletion annotation.
Reduce flickering for completion sources without validFor info by temporarily showing a disabled tooltip while the completion updates.
Make sure completion info tooltips are kept within the space provided by the tooltipSpace option.
Close bracket configuration now supports a stringPrefixes property that can be used to allow autoclosing of prefixed strings.
Autocompletion now takes an interactionDelay option that can be used to control the delay between the time where completion opens and the time where commands like acceptCompletion affect it.
Fix a bug that prevented transactions produced by deleteBracketPair from being marked as deletion user events.
Improve positioning of completion info tooltips so they are less likely to stick out of the screen on small displays.
You can now provide a compareCompletions option to autocompletion to influence the way completions with the same match score are sorted.
The selectOnOpen option to autocompletion can be used to require explicitly selecting a completion option before acceptCompletion does anything.
Remove a leftover console.log in bracket closing code.
Fix a bug that caused closeBrackets to not close quotes when at the end of a syntactic construct that starts with a similar quote.
Declare package dependencies as peer dependencies as an attempt to avoid duplicated package issues.
Support escaping ${ or #{ in snippets.
Scroll the cursor into view when inserting a snippet.
Add an aria-label to the completion listbox.
Fix a regression that caused transactions generated for completion to not have a userEvent annotation.
The package now exports an insertCompletionText helper that implements the default behavior for applying a completion.
The new closeOnBlur option determines whether the completion tooltip is closed when the editor loses focus.
CompletionResult objects with filter: false may now have a getMatch property that determines the matched range in the options.
CompletionResult.span has been renamed to validFor, and may now hold a function as well as a regular expression.
Remove code that dropped any options beyond the 300th one when matching and sorting option lists.
Completion will now apply to all cursors when there are multiple cursors.
CompletionResult.update can now be used to implement quick autocompletion updates in a synchronous way.
The @codemirror/closebrackets package was merged into this one.
The selectedCompletionIndex function tells you the position of the currently selected completion.
The new setSelectionCompletion function creates a state effect that moves the selected completion to a given index.
A completion's info method may now return null to indicate that no further info is available.
Make the ARIA attributes added to the editor during autocompletion spec-compliant.
Fix an issue where the completion tooltip stayed open if it was explicitly opened and the user backspaced past its start.
Stop snippet filling when a change happens across one of the snippet fields' boundaries.
Fix completion navigation with PageUp/Down when the completion tooltip isn't part of the view DOM.
Fix a bug that caused page up/down to only move the selection by two options in the completion tooltip.
Make sure the info tooltip is hidden when the selected option is scrolled out of view.
Fix a bug in the completion ranking that would sometimes give options that match the input by word start chars higher scores than appropriate.
Options are now sorted (ascending) by length when their match score is otherwise identical.
Fix an issue where info tooltips would be visible in an inappropriate position when there was no room to place them properly.
Give the completion tooltip a minimal width, and show ellipsis when completions overflow the tooltip width.
autocompletion now accepts an aboveCursor option to make the completion tooltip show up above the cursor.
Make option deduplication less aggressive, so that options with different type or apply fields don't get merged.
Fix an issue where parsing a snippet with a field that was labeled only by a number crashed.
Make sure info tooltips don't stick out of the bottom of the page.
The package exports a new function selectedCompletion, which can be used to find out which completion is currently selected.
Transactions created by picking a completion now have an annotation (pickedCompletion) holding the original completion.
Don't rely on the platform's highlight colors for the active completion, since those are inconsistent and may not be appropriate for the theme.
Fix incorrect match underline for some kinds of matched completions.
Improve the sorting of completions by using localeCompare.
Fix reading of autocompletions in NVDA screen reader.
The new icons option can be used to turn off icons in the completion list.
The optionClass option can now be used to add CSS classes to the options in the completion list.
It is now possible to inject additional content into rendered completion options with the addToOptions configuration option.
Fix an issue where completeAnyWord would return results when there was no query and explicit was false.
Fix incorrect versions for @lezer dependencies.
Update dependencies to 0.19.0
Add an ifIn helper function that constrains a completion source to only fire when in a given syntax node. Add support for unfiltered completions
A completion result can now set a filter: false property to disable filtering and sorting of completions, when it already did so itself.
Don't treat continued completions when typing after an explicit completion as explicit.
Adding or reconfiguring completion sources will now cause them to be activated right away if a completion was active.
You can now specify multiple types in Completion.type by separating them by spaces. Small doc comment tweak for Completion.type
Fix a regression where snippet field selection didn't work with @codemirror/state 0.18.6.
Fix a bug where snippet fields with different position numbers were inappropriately merged.
Fix a crash in Safari when moving the selection during composition.
Adjust to updated @codemirror/tooltip interface.
Fix unintended ES2020 output (the package contains ES6 code again).
Stop active completion when all sources resolve without producing any matches.
Completion.info may now return a promise.
Only preserve selected option across updates when it isn't the first option.
Fix a styling issue where the selection had become invisible inside snippet fields (when using drawSelection).
Snippet fields can now be selected with the pointing device (so that they are usable on touch devices).
Fix a bug where uppercase completions would be incorrectly matched against the typed input.
Don't bind Cmd-Space on macOS, since that already has a system default binding. Use Ctrl-Space for autocompletion.
The package now also exports a CommonJS module.
First numbered release.
codemirror