@adecore/editor-react 0.17.0-beta.1 → 0.17.0-beta.2

package/src/editor-language.ts

@@ -145,6 +145,32 @@ export class EditorLanguage {
         this.pick.open({ anchor, title, groups: [{ title: null, rows }], accept: (id) => this.goTo(places[Number(id)]!) });
     }
 
+    /*
+     * Runs `listener` once the document is open and again whenever the service says what it can ask for
+     * this document changed. A service that is ready before the document opens never says so, so the
+     * opening counts as the first change.
+     */
+    onProvidersChanged(listener: () => void): () => void {
+        let listening = true;
+        void this.document.ready.then(
+            () => {
+                if (listening && !this.disposed) {
+                    listener();
+                }
+            },
+            () => undefined
+        );
+        const providers = this.project.service.onProvidersChanged((uri) => {
+            if (uri === this.uri) {
+                listener();
+            }
+        });
+        return () => {
+            listening = false;
+            providers.dispose();
+        };
+    }
+
     /* Runs `dispose` when the editor lets go of its document. */
     onDispose(dispose: () => void): void {
         this.disposers.push(dispose);

package/src/folding.ts

@@ -91,15 +91,13 @@ export class FoldingFeature {
             this.publish();
         });
         const edits = editor.onTextChange(() => this.refresher.later());
-        const providers = project.service.onProvidersChanged((changed) => {
-            if (changed === uri) {
-                this.refresher.now();
-            }
+        const providers = language.onProvidersChanged(() => {
+            this.refresher.now();
         });
         language.onDispose(() => {
             symbols();
             edits();
-            providers.dispose();
+            providers();
             this.refresher.dispose();
             editor.setFoldHints(null);
         });

package/src/history.ts

@@ -1,4 +1,3 @@
-import i18next from 'i18next';
 import type { EditorLanguage } from './editor-language.ts';
 import { isShortcut } from './shortcut-keys.ts';
 
@@ -51,7 +50,7 @@ export class HistoryFeature {
         this.language.locations(
             places.map((place) => ({ uri: place.uri, range: { start: place.position, end: place.position } })),
             this.language.editor.getCaret(),
-            i18next.t('editor:language.history.recent')
+            this.language.project.i18n.t('editor:language.history.recent')
         );
     }
 }

package/src/host-types.ts

@@ -1,3 +1,4 @@
+import type { i18n } from 'i18next';
 import type { Keymap } from '@adecore/editor/keymap';
 import type { ProjectFiles } from './workspace-edit.ts';
 import type { Place } from './navigation-history.ts';
@@ -37,6 +38,8 @@ export interface RenameSuggestionsRequest {
 }
 
 export interface LanguageHost {
+    /* The instance the app hands `UIProvider`, which the features read their words from too; the default instance without one. */
+    readonly i18n?: i18n;
     readonly folder?: string;
     readonly files?: ProjectFiles;
     readonly apple?: boolean;

package/src/hover.ts

@@ -1,4 +1,3 @@
-import i18next from 'i18next';
 import type { EditorHover, EditorPosition, EditorRange } from '@adecore/editor';
 import type { EditorLanguage } from './editor-language.ts';
 import { rangeHolds, type Problem } from './diagnostics-model.ts';
@@ -212,7 +211,7 @@ export class HoverFeature {
         if (problems.length === 0 && info === null) {
             this.hide();
             if (pinned) {
-                this.language.project.host.notify?.({ id: TOAST_ID, kind: 'error', title: i18next.t('editor:language.hover.none') });
+                this.language.project.host.notify?.({ id: TOAST_ID, kind: 'error', title: this.language.project.i18n.t('editor:language.hover.none') });
             }
             return;
         }

package/src/inlay-hints.ts

@@ -71,15 +71,13 @@ export class InlayHintsFeature {
                 this.refresher.later();
             }
         });
-        const providers = project.service.onProvidersChanged((changed) => {
-            if (changed === uri) {
-                this.refresher.now();
-            }
+        const providers = language.onProvidersChanged(() => {
+            this.refresher.now();
         });
         language.onDispose(() => {
             edits();
             scrolls();
-            providers.dispose();
+            providers();
             this.refresher.dispose();
             editor.setInlayHints([]);
         });

package/src/navigation.ts

@@ -1,4 +1,3 @@
-import i18next from 'i18next';
 import { StaleResultError, fileUriToPath, type Location, type LocationLink, type NavigationResult, type Range } from '@adecore/lsp';
 import type { EditorPosition } from '@adecore/editor';
 import { basenameOf } from './paths.ts';
@@ -24,10 +23,6 @@ const SHORTCUT_KINDS: readonly [NavigationKind, 'goToDefinition' | 'goToTypeDefi
 
 const TOAST_ID = 'language-navigation';
 
-function say(key: string, options?: Record<string, unknown>): string {
-    return i18next.t(`editor:language.navigation.${key}`, options);
-}
-
 /* The places of a result, each once: the two servers of a Vue file may both know the same one. `target` is the whole declaration when the server gave it. */
 export function uniquePlaces(result: NavigationResult): { location: Location; target: Range | null }[] {
     const seen = new Set<string>();
@@ -96,7 +91,7 @@ export class NavigationFeature {
     async go(kind: NavigationKind, position: EditorPosition = this.language.editor.getCaret()): Promise<void> {
         const { project, uri, editor } = this.language;
         if (!this.supports(kind)) {
-            this.tell(say('unavailable'));
+            this.tell(this.say('unavailable'));
             return;
         }
         let result: NavigationResult;
@@ -111,20 +106,20 @@ export class NavigationFeature {
                     : service.implementation(uri, position));
         } catch (error) {
             if (!(error instanceof StaleResultError)) {
-                this.tell(say('failed', { message: error instanceof Error ? error.message : String(error) }));
+                this.tell(this.say('failed', { message: error instanceof Error ? error.message : String(error) }));
             }
             return;
         }
         const places = uniqueLocations(result);
         if (places.length === 0) {
-            this.tell(say('none'));
+            this.tell(this.say('none'));
         } else if (kind === 'definition' && places.length === 1 && places[0]!.uri === uri && rangeHolds(places[0]!.range, position)) {
             // The name is its own definition, so what a person wants to see is where it is used.
             void this.language.peek.open(position);
         } else if (places.length === 1) {
             this.language.goTo(places[0]!);
         } else {
-            this.language.locations(places, position, say(`titles.${kind}`));
+            this.language.locations(places, position, this.say(`titles.${kind}`));
         }
         editor.focus();
     }
@@ -148,7 +143,7 @@ export class NavigationFeature {
             if (places.length === 1) {
                 this.language.goTo(places[0]!);
             } else if (places.length > 1) {
-                this.language.locations(places, anchor, say('titles.symbol'));
+                this.language.locations(places, anchor, this.say('titles.symbol'));
             }
         } catch {
             // A name that cannot be found is a link that does nothing, not an error.
@@ -158,6 +153,10 @@ export class NavigationFeature {
     private tell(title: string): void {
         this.language.project.host.notify?.({ id: TOAST_ID, kind: 'error', title });
     }
+
+    private say(key: string, options?: Record<string, unknown>): string {
+        return this.language.project.i18n.t(`editor:language.navigation.${key}`, options);
+    }
 }
 
 /* How a place reads in a list: the file and the line, with the folder it is in. */

package/src/peek.ts

@@ -1,4 +1,3 @@
-import i18next from 'i18next';
 import { StaleResultError, type Location, type Range } from '@adecore/lsp';
 import type { EditorPosition } from '@adecore/editor';
 import type { EditorLanguage } from './editor-language.ts';
@@ -22,10 +21,6 @@ function placeKey(location: Location): string {
     return `${location.uri}\0${location.range.start.line}\0${location.range.start.character}`;
 }
 
-function say(key: string, options?: Record<string, unknown>): string {
-    return i18next.t(`editor:language.peek.${key}`, options);
-}
-
 /*
  * The references of the name at the caret, between the lines of the file under the line it is on. The
  * editor keeps the keyboard: arrows pick a reference, Enter goes to it and Escape closes the peek; typing
@@ -75,7 +70,7 @@ export class PeekFeature {
         const { editor, project, uri } = this.language;
         const method = KINDS[kind].method;
         if (!project.service.supports(method, uri)) {
-            this.tell(say(KINDS[kind].unavailable));
+            this.tell(this.say(KINDS[kind].unavailable));
             return;
         }
         const token = ++this.token;
@@ -84,7 +79,7 @@ export class PeekFeature {
             found = await this.fetch(kind, position);
         } catch (error) {
             if (!(error instanceof StaleResultError)) {
-                this.tell(say('failed', { message: error instanceof Error ? error.message : String(error) }));
+                this.tell(this.say('failed', { message: error instanceof Error ? error.message : String(error) }));
             }
             return;
         }
@@ -102,7 +97,7 @@ export class PeekFeature {
                 ) === index
         );
         if (unique.length === 0) {
-            this.tell(say(KINDS[kind].none));
+            this.tell(this.say(KINDS[kind].none));
             return;
         }
         const uris = [...new Set(unique.map((location) => location.uri))].slice(0, PEEK_READ_FILES);
@@ -245,4 +240,8 @@ export class PeekFeature {
     private tell(title: string): void {
         this.language.project.host.notify?.({ id: TOAST_ID, kind: 'error', title });
     }
+
+    private say(key: string, options?: Record<string, unknown>): string {
+        return this.language.project.i18n.t(`editor:language.peek.${key}`, options);
+    }
 }

package/src/project-language.ts

@@ -1,3 +1,4 @@
+import i18next, { type i18n } from 'i18next';
 import { fileUriToPath, type ApplyWorkspaceEditResult, type ContentChange, type LanguageService, type WorkspaceEdit } from '@adecore/lsp';
 import type { Editor, EditorPosition } from '@adecore/editor';
 import { NavigationHistory, type Place } from './navigation-history.ts';
@@ -78,6 +79,7 @@ interface Holder {
 export class ProjectLanguage {
     readonly service: LanguageService;
     readonly host: LanguageHost;
+    readonly i18n: i18n;
     readonly folder: string;
     readonly problems: ProjectProblems;
     readonly history = new NavigationHistory();
@@ -90,6 +92,7 @@ export class ProjectLanguage {
     constructor(service: LanguageService, host: LanguageHost = {}) {
         this.service = service;
         this.host = host;
+        this.i18n = host.i18n ?? i18next;
         this.folder = host.folder ?? '';
         this.files = host.files ?? null;
         this.problems = new ProjectProblems(service, (uri) => this.pathOfLocation(uri) ?? uri);

package/src/rename.ts

@@ -1,4 +1,3 @@
-import i18next from 'i18next';
 import { StaleResultError, type Location, type PrepareRenameResult, type WorkspaceEdit } from '@adecore/lsp';
 import type { EditorRange } from '@adecore/editor';
 import type { EditorLanguage } from './editor-language.ts';
@@ -13,10 +12,6 @@ const SAMPLE_LOCATIONS = 8;
 const SAMPLE_OTHER_FILES = 3;
 const CONTEXT_LINES = 3;
 
-function say(key: string, options?: Record<string, unknown>): string {
-    return i18next.t(`editor:language.rename.${key}`, options);
-}
-
 interface Session {
     readonly target: RenameTarget;
     readonly original: string;
@@ -67,7 +62,7 @@ export class RenameFeature {
     async start(): Promise<void> {
         const { editor, project, uri } = this.language;
         if (!project.service.supports(METHOD, uri)) {
-            this.tell('error', say('unavailable'));
+            this.tell('error', this.say('unavailable'));
             return;
         }
         this.cancel();
@@ -78,7 +73,7 @@ export class RenameFeature {
             answer = prepare ? await project.service.prepareRename(uri, caret) : { defaultBehavior: true };
         } catch (error) {
             if (!(error instanceof StaleResultError)) {
-                this.tell('error', say('nothing'));
+                this.tell('error', this.say('nothing'));
             }
             return;
         }
@@ -92,7 +87,7 @@ export class RenameFeature {
                 )
         );
         if (target === null) {
-            this.tell('error', say('nothing'));
+            this.tell('error', this.say('nothing'));
             return;
         }
         const session: Session = { target, original: editor.textInRange(target.range), edit: null, names: new AbortController() };
@@ -120,7 +115,7 @@ export class RenameFeature {
                 return;
             }
             if (edit === null) {
-                this.fail(say('refused'));
+                this.fail(this.say('refused'));
                 return;
             }
             session.edit = edit;
@@ -140,7 +135,7 @@ export class RenameFeature {
             this.publish({ phase: 'preview', busy: false, name: next, files });
         } catch (error) {
             if (this.session === session) {
-                this.fail(error instanceof StaleResultError ? say('stale') : error instanceof Error ? error.message : String(error));
+                this.fail(error instanceof StaleResultError ? this.say('stale') : error instanceof Error ? error.message : String(error));
             }
         }
     }
@@ -168,7 +163,7 @@ export class RenameFeature {
         if (result.applied) {
             this.finish();
         } else {
-            this.fail(result.failureReason ?? say('refused'));
+            this.fail(result.failureReason ?? this.say('refused'));
         }
     }
 
@@ -176,7 +171,7 @@ export class RenameFeature {
     private fail(message: string): void {
         if (this.session !== null) {
             this.session.edit = null;
-            this.publish({ phase: 'input', busy: false, files: [], error: say('failed', { message }) });
+            this.publish({ phase: 'input', busy: false, files: [], error: this.say('failed', { message }) });
         }
     }
 
@@ -288,4 +283,8 @@ export class RenameFeature {
             }
         });
     }
+
+    private say(key: string, options?: Record<string, unknown>): string {
+        return this.language.project.i18n.t(`editor:language.rename.${key}`, options);
+    }
 }

package/src/semantic-tokens.ts

@@ -33,14 +33,12 @@ export class SemanticTokensFeature {
             timers
         );
         const edits = editor.onTextChange(() => this.refresher.later());
-        const providers = project.service.onProvidersChanged((changed) => {
-            if (changed === uri) {
-                this.refresher.now();
-            }
+        const providers = language.onProvidersChanged(() => {
+            this.refresher.now();
         });
         language.onDispose(() => {
             edits();
-            providers.dispose();
+            providers();
             this.refresher.dispose();
             editor.setSemanticTokens(null);
         });

package/src/symbol-picker.ts

@@ -1,4 +1,3 @@
-import i18next from 'i18next';
 import { StaleResultError, type Location } from '@adecore/lsp';
 import { basenameOf } from './paths.ts';
 import type { EditorLanguage } from './editor-language.ts';
@@ -33,7 +32,7 @@ export class SymbolPickerFeature {
     async open(): Promise<void> {
         const { project, uri, popups } = this.language;
         if (!project.service.supports('textDocument/documentSymbol', uri)) {
-            this.language.project.host.notify?.({ id: TOAST_ID, kind: 'error', title: i18next.t('editor:language.symbols.unavailable') });
+            this.language.project.host.notify?.({ id: TOAST_ID, kind: 'error', title: this.language.project.i18n.t('editor:language.symbols.unavailable') });
             return;
         }
         try {
@@ -44,7 +43,7 @@ export class SymbolPickerFeature {
                 this.language.project.host.notify?.({
                     id: TOAST_ID,
                     kind: 'error',
-                    title: i18next.t('editor:language.symbols.failed', { message: error instanceof Error ? error.message : String(error) })
+                    title: this.language.project.i18n.t('editor:language.symbols.failed', { message: error instanceof Error ? error.message : String(error) })
                 });
             }
         }

package/src/symbols.ts

@@ -89,14 +89,12 @@ export class SymbolsFeature {
             timers
         );
         const edits = editor.onTextChange(() => this.refresher.later());
-        const providers = project.service.onProvidersChanged((changed) => {
-            if (changed === uri) {
-                this.refresher.now();
-            }
+        const providers = language.onProvidersChanged(() => {
+            this.refresher.now();
         });
         language.onDispose(() => {
             edits();
-            providers.dispose();
+            providers();
             this.refresher.dispose();
             editor.setBlocks(null);
         });