@adecore/editor-react 0.23.1 → 0.24.0

package/src/rename-model.ts

@@ -1,6 +1,7 @@
 import type { EditorPosition, EditorRange } from '@adecore/editor';
-import type { Location, PrepareRenameResult, TextEdit, WorkspaceEdit } from '@adecore/lsp';
+import type { DocumentSymbol, DocumentSymbolResult, Location, PrepareRenameResult, TextEdit, WorkspaceEdit } from '@adecore/lsp';
 import { isIdentifierCharacter } from './completion-model.ts';
+import { rangeHolds } from './diagnostics-model.ts';
 import { textEntriesOf } from './workspace-edit.ts';
 
 /* The identifier the caret is in or touches; null where there is none. */
@@ -59,6 +60,64 @@ export function occurrencesOf(locations: readonly Location[], uri: string): Occu
     };
 }
 
+/* LSP's SymbolKind in words, indexed by its number. */
+const SYMBOL_KINDS = [
+    '',
+    'file',
+    'module',
+    'namespace',
+    'package',
+    'class',
+    'method',
+    'property',
+    'field',
+    'constructor',
+    'enum',
+    'interface',
+    'function',
+    'variable',
+    'constant',
+    'string',
+    'number',
+    'boolean',
+    'array',
+    'object',
+    'key',
+    'null',
+    'enum member',
+    'struct',
+    'event',
+    'operator',
+    'type parameter'
+];
+
+/*
+ * The kind of the symbol a rename names, in words, from the outline of the open file: the symbol whose name
+ * holds one of the places of the name there. Undefined when the outline does not list it, as with most locals.
+ */
+export function renameKindOf(result: DocumentSymbolResult, name: string, places: readonly EditorRange[]): string | undefined {
+    if (result === null || result.length === 0) {
+        return undefined;
+    }
+    const named = (range: EditorRange) => places.some((place) => rangeHolds(range, place.start));
+    if ('range' in result[0]!) {
+        let found: DocumentSymbol | undefined;
+        const walk = (symbols: readonly DocumentSymbol[]): void => {
+            for (const symbol of symbols) {
+                if (named(symbol.selectionRange)) {
+                    found = symbol;
+                }
+                walk(symbol.children ?? []);
+            }
+        };
+        walk(result as DocumentSymbol[]);
+        return found === undefined ? undefined : SYMBOL_KINDS[found.kind];
+    }
+    // A flat list only gives the whole span of a symbol, so the name has to match as well.
+    const found = result.find((symbol) => 'location' in symbol && symbol.name === name && named(symbol.location.range));
+    return found === undefined ? undefined : SYMBOL_KINDS[found.kind];
+}
+
 /* One line a rename changes: the line as it is and as it will be. */
 export interface RenameRow {
     /* One-based. */

package/src/rename.ts

@@ -1,9 +1,10 @@
 import { StaleResultError, type Location, type PrepareRenameResult, type WorkspaceEdit } from '@adecore/lsp';
+import { KEY_PRIORITY } from './key-priority.ts';
 import type { EditorRange } from '@adecore/editor';
 import type { EditorLanguage } from './editor-language.ts';
 import { lineTextOf } from './line-text.ts';
 import type { RenameView } from './popups.ts';
-import { occurrencesOf, renamePreviewOf, renameTargetOf, wordRangeAt, type RenameTarget } from './rename-model.ts';
+import { occurrencesOf, renameKindOf, renamePreviewOf, renameTargetOf, wordRangeAt, type RenameTarget } from './rename-model.ts';
 import { isShortcut } from './shortcut-keys.ts';
 import { resourceOperationsOf } from './workspace-edit.ts';
 import { messageOf } from './error-message.ts';
@@ -37,13 +38,13 @@ export class RenameFeature {
         this.language = language;
         const { editor } = language;
         const offs = [
-            editor.onKeyDown((event) => {
+            language.onKey((event) => {
                 if (!isShortcut(this.language.shortcuts.rename, event)) {
                     return false;
                 }
                 void this.start();
                 return true;
-            }),
+            }, KEY_PRIORITY.rename),
             editor.onTextChange(() => this.cancel())
         ];
         language.onDispose(() => {
@@ -218,8 +219,9 @@ export class RenameFeature {
                 start: { line: Math.max(0, line - CONTEXT_LINES), character: 0 },
                 end: { line: line + CONTEXT_LINES, character: Number.MAX_SAFE_INTEGER }
             });
-            const uses = await this.linesOf(locations ?? []);
-            const names = await suggestNames({ uri, languageId, name: session.original, context, uses }, session.names.signal);
+            const [uses, kind] = await Promise.all([this.linesOf(locations ?? []), this.kindOf(session, locations ?? [])]);
+            const request = { uri, languageId, name: session.original, ...(kind === undefined ? {} : { kind }), context, uses };
+            const names = await suggestNames(request, session.names.signal);
             if (this.session === session && names.length > 0) {
                 this.publish({ suggestions: names });
             }
@@ -228,6 +230,20 @@ export class RenameFeature {
         }
     }
 
+    /* So a suggester knows a function from a variable; a rename on a use finds the kind through the declaration's place in this file. */
+    private async kindOf(session: Session, locations: readonly Location[]): Promise<string | undefined> {
+        const { project, uri } = this.language;
+        if (!project.service.supports('textDocument/documentSymbol', uri)) {
+            return undefined;
+        }
+        try {
+            const symbols = await project.service.documentSymbols(uri, { signal: session.names.signal, parallel: true });
+            return renameKindOf(symbols, session.original, [session.target.range, ...occurrencesOf(locations, uri).inFile]);
+        } catch {
+            return undefined;
+        }
+    }
+
     /* The text of the first lines that name the symbol, in the order the servers listed them, reading at most a few other files. */
     private async linesOf(locations: readonly Location[]): Promise<string[]> {
         const { project } = this.language;

package/src/rendered-docs.ts

@@ -1,4 +1,5 @@
 import { findDocComments, type DocComment, type EditorPosition, type EditorRange, type EditorReplacement, type EditorTrackedRange } from '@adecore/editor';
+import { KEY_PRIORITY } from './key-priority.ts';
 import type { EditorLanguage } from './editor-language.ts';
 import { parseDocComment, type ParsedDocComment } from './doc-comment-model.ts';
 import { isShortcut } from './shortcut-keys.ts';
@@ -114,9 +115,9 @@ export class RenderedDocsFeature {
                     this.toggleAt(line);
                 }
             }),
-            editor.onKeyDown((event) => {
+            language.onKey((event) => {
                 return isShortcut(this.language.shortcuts.toggleRenderedDocs, event) && this.toggle();
-            }),
+            }, KEY_PRIORITY.renderedDocs),
             editor.onViewChange(() => {
                 this.sweep();
                 this.releaseRevealed();

package/src/signature.ts

@@ -1,4 +1,5 @@
 import type { SignatureHelp, SignatureHelpContext } from '@adecore/lsp';
+import { KEY_PRIORITY } from './key-priority.ts';
 import type { EditorPosition, EditorTextChange } from '@adecore/editor';
 import type { EditorLanguage } from './editor-language.ts';
 import { signatureViewOf } from './signature-model.ts';
@@ -30,8 +31,8 @@ export class SignatureFeature {
             editor.onTextChange((change) => this.edited(change)),
             editor.onCaret(() => this.retrigger()),
             editor.onBlur(() => this.close()),
-            editor.onKeyDown((event) => {
-                if (event.key === 'Escape' && this.isOpen && this.language.popups.getState().callHierarchy == null) {
+            language.onKey((event) => {
+                if (event.key === 'Escape' && this.isOpen && this.language.popups.getState().callHierarchy === null) {
                     this.close();
                     return true;
                 }
@@ -43,7 +44,7 @@ export class SignatureFeature {
                     return this.cycle(event.key === 'ArrowDown' ? 1 : -1);
                 }
                 return false;
-            })
+            }, KEY_PRIORITY.signature)
         ];
         language.onDispose(() => {
             for (const off of offs) {

package/src/snippet-session.ts

@@ -3,6 +3,7 @@ import { SnippetFieldTransforms, type FieldTransformTarget } from './snippet-fie
 import { SnippetTransformError } from './snippet-transform-client.ts';
 import { acquireSnippetTransforms, type SnippetTransformLease } from './snippet-transform-queue.ts';
 import { realTimers, type Timers } from './timers.ts';
+import { KEY_PRIORITY } from './key-priority.ts';
 import { MAX_TRANSFORM_CHARACTERS, type SnippetTransformJob } from './snippet-transform-protocol.ts';
 import type { EditorContentChange, EditorPosition, EditorRange, EditorTextChange } from '@adecore/editor';
 import { comparePositions, rangeHolds, shiftPosition } from './diagnostics-model.ts';
@@ -79,7 +80,7 @@ export interface SnippetInsertion {
     readonly fields?: readonly SnippetField[];
 }
 
-type SnippetHost = Pick<EditorLanguage, 'editor' | 'onDispose'> & Partial<Pick<EditorLanguage, 'popups' | 'pick' | 'project'>>;
+type SnippetHost = Pick<EditorLanguage, 'editor' | 'onDispose'> & Partial<Pick<EditorLanguage, 'popups' | 'pick' | 'project' | 'onKey'>>;
 const MAX_FRAMES = 8;
 const MAX_RANGES = 1000;
 
@@ -185,7 +186,12 @@ export class SnippetFeature {
         this.transforms = language.project === undefined ? null : acquireSnippetTransforms(language.project, timers);
         const { editor } = language;
         this.fieldTransforms = new SnippetFieldTransforms(editor, this.transforms, (targets, values) => this.applyFieldTransforms(targets, values));
-        const offs = [editor.onKeyDown((event) => this.key(event)), editor.onTextChange((change) => this.edited(change)), editor.onCaret(() => this.moved())];
+        const key = (event: KeyboardEvent): boolean => this.key(event);
+        const offs = [
+            language.onKey === undefined ? editor.onKeyDown(key) : language.onKey(key, KEY_PRIORITY.snippets),
+            editor.onTextChange((change) => this.edited(change)),
+            editor.onCaret(() => this.moved())
+        ];
         language.onDispose(() => {
             this.transforms?.dispose();
             this.end();
@@ -492,7 +498,7 @@ export class SnippetFeature {
             const popups = this.language.popups?.getState();
             if (
                 popups !== undefined &&
-                [popups.completion, popups.signature, popups.hover, popups.pick, popups.peek, popups.callHierarchy ?? null].some((popup) => popup !== null)
+                [popups.completion, popups.signature, popups.hover, popups.pick, popups.peek, popups.callHierarchy].some((popup) => popup !== null)
             ) {
                 return false;
             }

package/src/symbol-picker.ts

@@ -1,4 +1,5 @@
 import { StaleResultError, type Location } from '@adecore/lsp';
+import { KEY_PRIORITY } from './key-priority.ts';
 import { basenameOf } from './paths.ts';
 import type { EditorLanguage } from './editor-language.ts';
 import { entriesOf, workspaceEntriesOf, type SymbolEntry, type WorkspaceEntry } from './symbol-picker-model.ts';
@@ -17,13 +18,13 @@ export class SymbolPickerFeature {
 
     constructor(language: EditorLanguage) {
         this.language = language;
-        const off = language.editor.onKeyDown((event) => {
+        const off = language.onKey((event) => {
             if (!isShortcut(this.language.shortcuts.goToSymbol, event)) {
                 return false;
             }
             void this.open();
             return true;
-        });
+        }, KEY_PRIORITY.symbolPicker);
         language.onDispose(() => {
             off();
             this.close();

package/dist/relative-time.d.ts

@@ -1 +0,0 @@
-export declare function relativeTime(at: number, now: number): string;

package/dist/relative-time.js

@@ -1,9 +0,0 @@
-import { formatAgo, formatDay, formatDayWithYear } from '@adecore/ui/format';
-export function relativeTime(at, now) {
-    const seconds = Math.max(0, now - at);
-    if (seconds < 7 * 24 * 60 * 60) {
-        return formatAgo(seconds * 1000);
-    }
-    const date = new Date(at * 1000);
-    return date.getFullYear() === new Date(now * 1000).getFullYear() ? formatDay(date) : formatDayWithYear(date);
-}

package/src/relative-time.ts

@@ -1,10 +0,0 @@
-import { formatAgo, formatDay, formatDayWithYear } from '@adecore/ui/format';
-
-export function relativeTime(at: number, now: number): string {
-    const seconds = Math.max(0, now - at);
-    if (seconds < 7 * 24 * 60 * 60) {
-        return formatAgo(seconds * 1000);
-    }
-    const date = new Date(at * 1000);
-    return date.getFullYear() === new Date(now * 1000).getFullYear() ? formatDay(date) : formatDayWithYear(date);
-}