@adecore/editor-react 0.31.12 → 0.33.0

package/dist/peek.js

@@ -9,11 +9,19 @@ const TOAST_ID = 'language-peek';
 /* The block as the panel draws it: a hatched band, the header, eight lines of code and a hatched band, until the editor has measured it. */
 export const PEEK_HEIGHT = 241;
 const KINDS = {
-    references: { method: 'textDocument/references', unavailable: 'unavailable', none: 'none' },
-    definitions: { method: 'textDocument/definition', unavailable: 'unavailableDefinition', none: 'noDefinition' }
+  references: {
+    method: 'textDocument/references',
+    unavailable: 'unavailable',
+    none: 'none'
+  },
+  definitions: {
+    method: 'textDocument/definition',
+    unavailable: 'unavailableDefinition',
+    none: 'noDefinition'
+  }
 };
 function placeKey(location) {
-    return `${location.uri}\0${location.range.start.line}\0${location.range.start.character}`;
+  return `${location.uri}\0${location.range.start.line}\0${location.range.start.character}`;
 }
 /*
  * The references of the name at the caret, between the lines of the file under the line it is on. The
@@ -21,208 +29,262 @@ function placeKey(location) {
  * closes it too. A click on a place shows its code and a second one goes there.
  */
 export class PeekFeature {
-    language;
-    timers;
-    kind = 'references';
-    /* The whole declaration of each place of a definition peek, where the server gave it. */
-    targets = new Map();
-    texts = new Map();
-    places = new Map();
-    order = [];
-    line = 0;
-    token = 0;
-    constructor(language, timers = realTimers) {
-        this.language = language;
-        this.timers = timers;
-        const { editor } = language;
-        const offs = [
-            language.onKey((event) => {
-                if (isShortcut(this.language.shortcuts.peekReferences, event)) {
-                    void this.open();
-                    return true;
-                }
-                if (isShortcut(this.language.shortcuts.peekDefinition, event)) {
-                    void this.openDefinition();
-                    return true;
-                }
-                return this.key(event);
-            }, KEY_PRIORITY.peek),
-            editor.onTextChange(() => this.close())
-        ];
-        language.onDispose(() => {
-            for (const off of offs) {
-                off();
-            }
-            this.close();
-        });
+  language;
+  timers;
+  kind = 'references';
+  /* The whole declaration of each place of a definition peek, where the server gave it. */
+  targets = new Map();
+  texts = new Map();
+  places = new Map();
+  order = [];
+  line = 0;
+  token = 0;
+  constructor(language, timers = realTimers) {
+    this.language = language;
+    this.timers = timers;
+    const {
+      editor
+    } = language;
+    const offs = [language.onKey(event => {
+      if (isShortcut(this.language.shortcuts.peekReferences, event)) {
+        void this.open();
+        return true;
+      }
+      if (isShortcut(this.language.shortcuts.peekDefinition, event)) {
+        void this.openDefinition();
+        return true;
+      }
+      return this.key(event);
+    }, KEY_PRIORITY.peek), editor.onTextChange(() => this.close())];
+    language.onDispose(() => {
+      for (const off of offs) {
+        off();
+      }
+      this.close();
+    });
+  }
+  get isOpen() {
+    return this.language.popups.getState().peek !== null;
+  }
+  async open(position = this.language.editor.getCaret(), kind = 'references') {
+    const {
+      editor,
+      project,
+      uri
+    } = this.language;
+    const method = KINDS[kind].method;
+    if (!project.service.supports(method, uri)) {
+      this.tell(this.say(KINDS[kind].unavailable));
+      return;
     }
-    get isOpen() {
-        return this.language.popups.getState().peek !== null;
-    }
-    async open(position = this.language.editor.getCaret(), kind = 'references') {
-        const { editor, project, uri } = this.language;
-        const method = KINDS[kind].method;
-        if (!project.service.supports(method, uri)) {
-            this.tell(this.say(KINDS[kind].unavailable));
-            return;
-        }
-        const token = ++this.token;
-        let found;
-        try {
-            found = await this.fetch(kind, position);
-        }
-        catch (error) {
-            if (!(error instanceof StaleResultError)) {
-                this.tell(this.say('failed', { message: messageOf(error) }));
-            }
-            return;
-        }
-        if (token !== this.token) {
-            return;
-        }
-        const { targets } = found;
-        const seen = new Set();
-        const unique = found.locations.filter((location) => {
-            const key = placeKey(location);
-            if (seen.has(key)) {
-                return false;
-            }
-            seen.add(key);
-            return true;
-        });
-        if (unique.length === 0) {
-            this.tell(this.say(KINDS[kind].none));
-            return;
-        }
-        const uris = [...new Set(unique.map((location) => location.uri))].slice(0, PEEK_READ_FILES);
-        const texts = new Map();
-        await Promise.all(uris.map(async (target) => {
-            const text = await project.readText(target);
-            if (text !== null) {
-                texts.set(target, text);
-            }
+    const token = ++this.token;
+    let found;
+    try {
+      found = await this.fetch(kind, position);
+    } catch (error) {
+      if (!(error instanceof StaleResultError)) {
+        this.tell(this.say('failed', {
+          message: messageOf(error)
         }));
-        if (token !== this.token) {
-            return;
-        }
-        this.texts = texts;
-        this.kind = kind;
-        this.targets = targets;
-        const files = peekFilesOf(unique, uri, (target) => texts.get(target) ?? null);
-        this.places = new Map(files.flatMap((file) => file.places.map((place) => [place.id, place.location])));
-        this.order = files.flatMap((file) => file.places.map((place) => place.id));
-        // The references open on the first place that is not the one the caret is on, which is what a person came to see.
-        const first = kind === 'definitions'
-            ? files[0].places[0]
-            : (files.flatMap((file) => file.places).find((place) => !(place.location.uri === uri && place.line === position.line)) ?? files[0].places[0]);
-        this.line = position.line;
-        this.language.callHierarchy.close();
-        this.language.popups.setState({ peek: { kind, container: null, files, active: first.id, collapsed: [], count: unique.length, preview: null } });
-        this.select(first.id);
-        // The editor draws a row once per id, so a peek opened over another needs an id of its own to get a container.
-        editor.setWidgets([{ id: `peek-${token}`, line: this.line, height: PEEK_HEIGHT, render: (container) => this.mounted(container) }]);
-        // The keys come through the editor, which a click on the hover's link or a menu command has taken the focus from.
-        editor.focus();
+      }
+      return;
     }
-    /* The definition of the name at the caret, as its source between the lines of the file. */
-    openDefinition(position = this.language.editor.getCaret()) {
-        return this.open(position, 'definitions');
+    if (token !== this.token) {
+      return;
     }
-    async fetch(kind, position) {
-        const { project, uri } = this.language;
-        if (kind === 'references') {
-            // Without the declaration, so the list holds what the usages count above a declaration counts.
-            return { locations: (await project.service.references(uri, position, false)) ?? [], targets: new Map() };
-        }
-        const places = uniquePlaces(await project.service.definition(uri, position));
-        const targets = new Map(places.flatMap(({ location, target }) => (target === null ? [] : [[placeKey(location), target]])));
-        return { locations: places.map(({ location }) => location), targets };
+    const {
+      targets
+    } = found;
+    const seen = new Set();
+    const unique = found.locations.filter(location => {
+      const key = placeKey(location);
+      if (seen.has(key)) {
+        return false;
+      }
+      seen.add(key);
+      return true;
+    });
+    if (unique.length === 0) {
+      this.tell(this.say(KINDS[kind].none));
+      return;
     }
-    close() {
-        this.token++;
-        if (this.language.popups.getState().peek === null) {
-            return;
-        }
-        this.language.popups.setState({ peek: null });
-        this.language.editor.setWidgets([]);
-        this.language.editor.focus();
+    const uris = [...new Set(unique.map(location => location.uri))].slice(0, PEEK_READ_FILES);
+    const texts = new Map();
+    await Promise.all(uris.map(async target => {
+      const text = await project.readText(target);
+      if (text !== null) {
+        texts.set(target, text);
+      }
+    }));
+    if (token !== this.token) {
+      return;
     }
-    /* Shows the code around a place. */
-    select(id) {
-        const view = this.language.popups.getState().peek;
-        const location = this.places.get(id);
-        if (view === null || location === undefined) {
-            return;
-        }
-        const text = this.texts.get(location.uri);
-        const line = location.range.start.line;
-        const snippet = text === undefined
-            ? null
-            : this.kind === 'definitions'
-                ? definitionSnippetOf(text, line, this.targets.get(placeKey(location)) ?? null, location.range)
-                : snippetOf(text, line, location.range);
-        this.language.popups.setState({ peek: { ...view, active: id, preview: snippet === null ? null : { ...snippet, uri: location.uri } } });
-    }
-    /* Folds the places of a file away from the list, or brings them back. */
-    toggleFile(uri) {
-        const view = this.language.popups.getState().peek;
-        if (view !== null) {
-            const collapsed = view.collapsed.includes(uri) ? view.collapsed.filter((other) => other !== uri) : [...view.collapsed, uri];
-            this.language.popups.setState({ peek: { ...view, collapsed } });
-        }
+    this.texts = texts;
+    this.kind = kind;
+    this.targets = targets;
+    const files = peekFilesOf(unique, uri, target => texts.get(target) ?? null);
+    this.places = new Map(files.flatMap(file => file.places.map(place => [place.id, place.location])));
+    this.order = files.flatMap(file => file.places.map(place => place.id));
+    // The references open on the first place that is not the one the caret is on, which is what a person came to see.
+    const first = kind === 'definitions' ? files[0].places[0] : files.flatMap(file => file.places).find(place => !(place.location.uri === uri && place.line === position.line)) ?? files[0].places[0];
+    this.line = position.line;
+    this.language.callHierarchy.close();
+    this.language.popups.setState({
+      peek: {
+        kind,
+        container: null,
+        files,
+        active: first.id,
+        collapsed: [],
+        count: unique.length,
+        preview: null
+      }
+    });
+    this.select(first.id);
+    // The editor draws a row once per id, so a peek opened over another needs an id of its own to get a container.
+    editor.setWidgets([{
+      id: `peek-${token}`,
+      line: this.line,
+      height: PEEK_HEIGHT,
+      render: container => this.mounted(container)
+    }]);
+    // The keys come through the editor, which a click on the hover's link or a menu command has taken the focus from.
+    editor.focus();
+  }
+  /* The definition of the name at the caret, as its source between the lines of the file. */
+  openDefinition(position = this.language.editor.getCaret()) {
+    return this.open(position, 'definitions');
+  }
+  async fetch(kind, position) {
+    const {
+      project,
+      uri
+    } = this.language;
+    if (kind === 'references') {
+      // Without the declaration, so the list holds what the usages count above a declaration counts.
+      return {
+        locations: (await project.service.references(uri, position, false)) ?? [],
+        targets: new Map()
+      };
     }
-    /* Goes to a place and closes the peek. */
-    go(id) {
-        const location = this.places.get(id);
-        if (location !== undefined) {
-            this.close();
-            this.language.goTo(location);
-        }
+    const places = uniquePlaces(await project.service.definition(uri, position));
+    const targets = new Map(places.flatMap(({
+      location,
+      target
+    }) => target === null ? [] : [[placeKey(location), target]]));
+    return {
+      locations: places.map(({
+        location
+      }) => location),
+      targets
+    };
+  }
+  close() {
+    this.token++;
+    if (this.language.popups.getState().peek === null) {
+      return;
     }
-    mounted(container) {
-        const view = this.language.popups.getState().peek;
-        if (view !== null && view.container !== container) {
-            this.language.popups.setState({ peek: { ...view, container } });
-            revealRow(this.timers, container);
-        }
+    this.language.popups.setState({
+      peek: null
+    });
+    this.language.editor.setWidgets([]);
+    this.language.editor.focus();
+  }
+  /* Shows the code around a place. */
+  select(id) {
+    const view = this.language.popups.getState().peek;
+    const location = this.places.get(id);
+    if (view === null || location === undefined) {
+      return;
     }
-    key(event) {
-        const view = this.language.popups.getState().peek;
-        if (view === null || event.metaKey || event.ctrlKey || event.altKey) {
-            return false;
+    const text = this.texts.get(location.uri);
+    const line = location.range.start.line;
+    const snippet = text === undefined ? null : this.kind === 'definitions' ? definitionSnippetOf(text, line, this.targets.get(placeKey(location)) ?? null, location.range) : snippetOf(text, line, location.range);
+    this.language.popups.setState({
+      peek: {
+        ...view,
+        active: id,
+        preview: snippet === null ? null : {
+          ...snippet,
+          uri: location.uri
         }
-        switch (event.key) {
-            case 'ArrowDown':
-                this.step(view, 1);
-                return true;
-            case 'ArrowUp':
-                this.step(view, -1);
-                return true;
-            case 'Enter':
-                this.go(view.active);
-                return true;
-            case 'Escape':
-                this.close();
-                return true;
-            default:
-                return false;
+      }
+    });
+  }
+  /* Folds the places of a file away from the list, or brings them back. */
+  toggleFile(uri) {
+    const view = this.language.popups.getState().peek;
+    if (view !== null) {
+      const collapsed = view.collapsed.includes(uri) ? view.collapsed.filter(other => other !== uri) : [...view.collapsed, uri];
+      this.language.popups.setState({
+        peek: {
+          ...view,
+          collapsed
         }
+      });
+    }
+  }
+  /* Goes to a place and closes the peek. */
+  go(id) {
+    const location = this.places.get(id);
+    if (location !== undefined) {
+      this.close();
+      this.language.goTo(location);
     }
-    /* The next place in the list a person can see, which a folded file has none of. */
-    step(view, direction) {
-        const index = this.order.indexOf(view.active);
-        for (let next = index + direction; next >= 0 && next < this.order.length; next += direction) {
-            const id = this.order[next];
-            if (!view.collapsed.includes(this.places.get(id).uri)) {
-                this.select(id);
-                return;
-            }
+  }
+  mounted(container) {
+    const view = this.language.popups.getState().peek;
+    if (view !== null && view.container !== container) {
+      this.language.popups.setState({
+        peek: {
+          ...view,
+          container
         }
+      });
+      revealRow(this.timers, container);
     }
-    tell(title) {
-        this.language.project.host.notify?.({ id: TOAST_ID, kind: 'error', title });
+  }
+  key(event) {
+    const view = this.language.popups.getState().peek;
+    if (view === null || event.metaKey || event.ctrlKey || event.altKey) {
+      return false;
     }
-    say(key, options) {
-        return this.language.project.i18n.t(`editor:language.peek.${key}`, options);
+    switch (event.key) {
+      case 'ArrowDown':
+        this.step(view, 1);
+        return true;
+      case 'ArrowUp':
+        this.step(view, -1);
+        return true;
+      case 'Enter':
+        this.go(view.active);
+        return true;
+      case 'Escape':
+        this.close();
+        return true;
+      default:
+        return false;
     }
-}
+  }
+  /* The next place in the list a person can see, which a folded file has none of. */
+  step(view, direction) {
+    const index = this.order.indexOf(view.active);
+    for (let next = index + direction; next >= 0 && next < this.order.length; next += direction) {
+      const id = this.order[next];
+      if (!view.collapsed.includes(this.places.get(id).uri)) {
+        this.select(id);
+        return;
+      }
+    }
+  }
+  tell(title) {
+    this.language.project.host.notify?.({
+      id: TOAST_ID,
+      kind: 'error',
+      title
+    });
+  }
+  say(key, options) {
+    return this.language.project.i18n.t(`editor:language.peek.${key}`, options);
+  }
+}