@adecore/editor-react 0.22.0 → 0.23.0

package/dist/doc-comment-model.d.ts

@@ -0,0 +1,23 @@
+export interface DocTagEntry {
+    readonly name: string;
+    readonly type: string | null;
+    readonly subject: string | null;
+    readonly text: string;
+}
+export interface ParsedDocComment {
+    readonly description: string;
+    readonly tags: readonly DocTagEntry[];
+}
+export declare const DOC_LINK_PREFIX = "#doc-link:";
+export declare function decodeEntities(text: string): string;
+export declare function safeAddress(address: string): string | null;
+export declare function htmlToMarkdown(source: string): string;
+export declare function inlineTagsToMarkdown(markdown: string): string;
+export declare function parseDocComment(body: string, options?: {
+    php?: boolean;
+}): ParsedDocComment;
+export interface DocTagSection {
+    readonly name: string;
+    readonly tags: readonly DocTagEntry[];
+}
+export declare function sectionsOf(tags: readonly DocTagEntry[]): DocTagSection[];

package/dist/doc-comment-model.js

@@ -0,0 +1,291 @@
+/*
+ * A documentation comment read the way a person reads it: a description and its tags. The text is
+ * Markdown by the time it leaves here. HTML is never passed on; a small, fixed subset is turned into
+ * Markdown and every other tag is dropped or left as text.
+ */
+/* The prefix of an address that stands for a name a `{@link}` points at, which the view resolves instead of following. */
+export const DOC_LINK_PREFIX = '#doc-link:';
+const ALIASES = {
+    returns: 'return',
+    exception: 'throws',
+    arg: 'param',
+    argument: 'param',
+    prop: 'property',
+    yields: 'yield',
+    link: 'see'
+};
+/* Tags that carry a type before their subject. */
+const TYPED = new Set(['param', 'property', 'return', 'throws', 'var', 'type', 'yield', 'template', 'this']);
+/* Tags whose first word is the thing they are about. */
+const SUBJECT_FIRST = new Set(['param', 'property', 'var', 'template']);
+const TAG_START = /^@([A-Za-z][\w-]*)(?::[\w-]+)?[ \t]*(.*)$/;
+const FENCE = /^\s*(```|~~~)/;
+const DASH = /^[—–-][ \t]+/;
+const DANGEROUS = /<(script|style|iframe|object|embed|svg|math|form)\b[\s\S]*?<\/\1\s*>|<\/?(script|style|iframe|object|embed|link|meta|base|svg|math|form|img|video|audio|source|input|button|textarea|select|canvas|frame|frameset)\b[^>]*>/gi;
+const SAFE_SCHEME = /^(https?:|mailto:)/i;
+/* Reads a type that starts the text: in braces as JSDoc writes it, or as one word with its brackets as PHPDoc does. */
+function takeType(text, braces) {
+    const trimmed = text.trimStart();
+    if (trimmed.startsWith('{')) {
+        let depth = 0;
+        for (let i = 0; i < trimmed.length; i++) {
+            depth += trimmed[i] === '{' ? 1 : trimmed[i] === '}' ? -1 : 0;
+            if (depth === 0) {
+                return { type: trimmed.slice(1, i).trim(), rest: trimmed.slice(i + 1).trimStart() };
+            }
+        }
+        return { type: null, rest: trimmed };
+    }
+    if (braces || /^[$&.]/.test(trimmed)) {
+        return { type: null, rest: trimmed };
+    }
+    let depth = 0;
+    let end = 0;
+    for (; end < trimmed.length; end++) {
+        const character = trimmed[end];
+        if ('<([{'.includes(character)) {
+            depth++;
+        }
+        else if ('>)]}'.includes(character)) {
+            depth--;
+        }
+        else if (/\s/.test(character) && depth <= 0) {
+            break;
+        }
+    }
+    return { type: end === 0 ? null : trimmed.slice(0, end), rest: trimmed.slice(end).trimStart() };
+}
+/* The first word of a tag's text: a name with its sigils and the `[name=default]` form of JSDoc. */
+function takeSubject(text) {
+    const optional = /^\[([^\]]+)\]\s*/.exec(text);
+    if (optional !== null) {
+        return { subject: optional[1], rest: text.slice(optional[0].length) };
+    }
+    const word = /^(?:\.\.\.|&)?[$\w.\\:-]+/.exec(text);
+    if (word === null) {
+        return { subject: null, rest: text };
+    }
+    return { subject: word[0], rest: text.slice(word[0].length).trimStart() };
+}
+/* A comment's lines cut where a tag starts at the beginning of a line, outside a fenced block. */
+function splitTags(body) {
+    const description = [];
+    const raw = [];
+    let fenced = false;
+    for (const line of body.split('\n')) {
+        if (FENCE.test(line)) {
+            fenced = !fenced;
+        }
+        const start = fenced ? null : TAG_START.exec(line.trimStart());
+        if (start !== null) {
+            raw.push({ name: start[1].toLowerCase(), text: start[2] });
+        }
+        else if (raw.length > 0) {
+            raw[raw.length - 1].text += `\n${line}`;
+        }
+        else {
+            description.push(line);
+        }
+    }
+    return { description: description.join('\n').trim(), raw };
+}
+function entryOf(name, text, php) {
+    let rest = text.trim();
+    let type = null;
+    let subject = null;
+    if (TYPED.has(name)) {
+        const taken = name === 'return' && rest.startsWith('$this') ? { type: '$this', rest: rest.slice(5).trimStart() } : takeType(rest, !php);
+        type = taken.type;
+        rest = taken.rest;
+        // A type that stands alone is the whole text of a tag that has no subject.
+        if (SUBJECT_FIRST.has(name) || (name === 'throws' && type === null)) {
+            const word = takeSubject(rest);
+            subject = word.subject;
+            rest = word.rest;
+        }
+    }
+    else if (name === 'see' && !rest.startsWith('{')) {
+        const target = /^\S+/.exec(rest);
+        subject = target === null ? null : target[0];
+        rest = target === null ? rest : rest.slice(target[0].length).trimStart();
+    }
+    if (name === 'throws' && type === null && subject !== null) {
+        type = subject;
+        subject = null;
+    }
+    return { name, type, subject, text: rest.replace(DASH, '').trim() };
+}
+/* Text outside backtick code, which is the only text HTML and inline tags are read in. */
+function outsideCode(markdown, convert) {
+    return markdown
+        .split(/(```[\s\S]*?```|~~~[\s\S]*?~~~|`[^`\n]*`)/)
+        .map((part, index) => (index % 2 === 1 ? part : convert(part)))
+        .join('');
+}
+const ENTITIES = { lt: '<', gt: '>', amp: '&', quot: '"', apos: "'", nbsp: ' ', ndash: '-', mdash: '-', hellip: '...' };
+/* Named entities of the small set docblocks use, and numeric ones; anything else stays as written. */
+export function decodeEntities(text) {
+    return text.replace(/&(#x[0-9a-f]+|#\d+|[a-z]+);/gi, (match, code) => {
+        if (code[0] === '#') {
+            const point = code[1].toLowerCase() === 'x' ? Number.parseInt(code.slice(2), 16) : Number.parseInt(code.slice(1), 10);
+            return Number.isFinite(point) && point > 0 && point <= 0x10ffff ? String.fromCodePoint(point) : match;
+        }
+        return ENTITIES[code.toLowerCase()] ?? match;
+    });
+}
+function dedent(text) {
+    const lines = text.replace(/^\n+|\s+$/g, '').split('\n');
+    const indents = lines.filter((line) => line.trim() !== '').map((line) => line.length - line.trimStart().length);
+    const common = indents.length === 0 ? 0 : Math.min(...indents);
+    return lines.map((line) => line.slice(common)).join('\n');
+}
+function fenced(body) {
+    return `\n\n\`\`\`\n${dedent(decodeEntities(stripTags(body)))}\n\`\`\`\n\n`;
+}
+function stripTags(html) {
+    return html.replace(/<\/?[a-zA-Z][^>]*>/g, '');
+}
+/* The address of a link when it is one a reader may follow; null for everything else, such as a script address. */
+export function safeAddress(address) {
+    const trimmed = decodeEntities(address.trim());
+    return SAFE_SCHEME.test(trimmed) || trimmed.startsWith(DOC_LINK_PREFIX) ? trimmed.replace(/\s/g, '%20').replace(/\(/g, '%28').replace(/\)/g, '%29') : null;
+}
+/*
+ * The HTML subset docblocks use, as Markdown: paragraphs and breaks, bold, italic, code, preformatted
+ * blocks, links to http, https and mailto, lists, headings and entities. Dangerous elements go with their
+ * content, attributes are never copied except a safe `href`, and a tag that is not in the subset is left
+ * as the text it was, which the view draws escaped.
+ */
+export function htmlToMarkdown(source) {
+    if (!source.includes('<') && !source.includes('&')) {
+        return source;
+    }
+    const lists = [];
+    const counters = [];
+    let anchor = null;
+    const blocks = source
+        .replace(/<pre\b[^>]*>([\s\S]*?)<\/pre\s*>/gi, (_match, body) => fenced(body))
+        .replace(/<code>([^<]*\n[^<]*)<\/code>/gi, (_match, body) => fenced(body));
+    const converted = outsideCode(blocks, (text) => text
+        .replace(DANGEROUS, '')
+        .replace(/<(\/?)(p|br|b|strong|i|em|u|code|tt|kbd|samp|var|a|ul|ol|li|h[1-6]|blockquote|hr|div|span|dl|dt|dd|sup|sub|small|center)\b([^>]*?)(\/?)>/gi, (_match, close, tag, attributes) => {
+        const closing = close === '/';
+        switch (tag.toLowerCase()) {
+            case 'p':
+            case 'div':
+            case 'dl':
+                return '\n\n';
+            case 'br':
+                return '\n';
+            case 'hr':
+                return '\n\n---\n\n';
+            case 'b':
+            case 'strong':
+                return '**';
+            case 'i':
+            case 'em':
+            case 'var':
+                return '*';
+            case 'code':
+            case 'tt':
+            case 'kbd':
+            case 'samp':
+                return '`';
+            case 'a': {
+                if (closing) {
+                    const target = anchor;
+                    anchor = null;
+                    return target === null ? '' : `](${target})`;
+                }
+                const href = /\bhref\s*=\s*(?:"([^"]*)"|'([^']*)'|([^\s>]+))/i.exec(attributes);
+                anchor = href === null ? null : safeAddress(href[1] ?? href[2] ?? href[3] ?? '');
+                return anchor === null ? '' : '[';
+            }
+            case 'ul':
+            case 'ol':
+                if (closing) {
+                    lists.pop();
+                    counters.pop();
+                }
+                else {
+                    lists.push(tag.toLowerCase());
+                    counters.push(0);
+                }
+                return '\n';
+            case 'li': {
+                if (closing) {
+                    return '';
+                }
+                const depth = Math.max(0, lists.length - 1);
+                const marker = lists.at(-1) === 'ol' ? `${(counters[depth] = (counters[depth] ?? 0) + 1)}.` : '-';
+                return `\n${'  '.repeat(depth)}${marker} `;
+            }
+            case 'blockquote':
+                return closing ? '\n\n' : '\n\n> ';
+            case 'dt':
+                return closing ? '**\n\n' : '\n\n**';
+            case 'dd':
+                return '\n\n';
+            default:
+                if (/^h[1-6]$/i.test(tag)) {
+                    return closing ? '\n\n' : `\n\n${'#'.repeat(Number(tag[1]))} `;
+                }
+                return '';
+        }
+    }));
+    // Entities last, so `&lt;b&gt;` stays the text it spells and is not read as a tag above.
+    return outsideCode(converted, decodeEntities).replace(/\n{3,}/g, '\n\n');
+}
+/*
+ * Inline `{@link Name}`, `{@link Name label}`, `{@link Name|label}`, the `linkcode` and `linkplain` forms, `{@see Name}`
+ * and `{@code text}`. A name becomes a link the view resolves; an address becomes a link to it.
+ */
+export function inlineTagsToMarkdown(markdown) {
+    return outsideCode(markdown, (text) => text
+        .replace(/\{@(?:link|linkcode|linkplain|see)\s+([^}\s|]+)(?:\s*[|\s]\s*([^}]+?))?\s*\}/g, (_match, target, label) => {
+        const address = /^https?:\/\//i.test(target) ? safeAddress(target) : `${DOC_LINK_PREFIX}${encodeURIComponent(target)}`;
+        const shown = label ?? target;
+        return address === null ? `\`${shown}\`` : `[${label === undefined ? `\`${shown}\`` : shown}](${address})`;
+    })
+        .replace(/\{@code\s+([^}]*)\}/g, (_match, code) => `\`${code.trim()}\``)
+        .replace(/\{@inheritDoc\}/g, ''));
+}
+/* An example's lines without the caption, and without the indentation they share; the text after the tag on its own line is not indented like the rest. */
+function exampleOf(text) {
+    const code = text.replace(/^\s*<caption>[\s\S]*?<\/caption>[ \t]*\n?/i, '');
+    const [head = '', ...tail] = code.split('\n');
+    return head.trim() === '' ? dedent(code) : [head.trim(), dedent(tail.join('\n'))].join('\n').trim();
+}
+function proseOf(text) {
+    return inlineTagsToMarkdown(htmlToMarkdown(text)).trim();
+}
+/* Reads the body of a documentation comment, as `findDocComments` returns it. `php` lets a type stand without braces. */
+export function parseDocComment(body, options = {}) {
+    const php = options.php === true;
+    const { description, raw } = splitTags(body);
+    const tags = raw.map(({ name, text }) => {
+        const bare = name.replace(/^(?:psalm|phpstan)-/, '');
+        const canonical = ALIASES[bare] ?? bare;
+        const entry = entryOf(canonical, text, php);
+        // An example is code: it keeps its lines and gets no prose treatment, only its caption removed.
+        if (canonical === 'example') {
+            return { ...entry, text: exampleOf(text) };
+        }
+        return { ...entry, text: proseOf(entry.text) };
+    });
+    return { description: proseOf(description), tags };
+}
+/* Tags in the order a reader looks for them; every other tag follows in the order it was written. */
+const ORDER = ['deprecated', 'template', 'param', 'property', 'type', 'var', 'return', 'yield', 'throws', 'see', 'example', 'since', 'version', 'author'];
+/* The tags gathered by name, so a list of parameters is one section, in reading order. */
+export function sectionsOf(tags) {
+    const byName = new Map();
+    for (const tag of tags) {
+        byName.set(tag.name, [...(byName.get(tag.name) ?? []), tag]);
+    }
+    const rank = (name) => {
+        const index = ORDER.indexOf(name);
+        return index === -1 ? ORDER.length : index;
+    };
+    return [...byName].map(([name, entries]) => ({ name, tags: entries })).sort((left, right) => rank(left.name) - rank(right.name));
+}

package/dist/editor-language.d.ts

@@ -1,12 +1,14 @@
 import { type Keymap } from '@adecore/editor/keymap';
 import type { Editor, EditorPosition } from '@adecore/editor';
 import type { Location } from '@adecore/lsp';
+import { CallHierarchyFeature } from './call-hierarchy.ts';
 import { CodeActionsFeature } from './code-actions.ts';
 import { CodeVisionFeature } from './code-vision.ts';
 import { CompletionFeature } from './completion.ts';
 import { ContextMenuFeature } from './context-menu.ts';
 import { DefinitionLinkFeature } from './definition-link.ts';
 import { DiagnosticsFeature } from './diagnostics.ts';
+import { FormatOnTypeFeature } from './format-on-type.ts';
 import { HighlightsFeature } from './highlights.ts';
 import { HistoryFeature } from './history.ts';
 import { HoverFeature } from './hover.ts';
@@ -15,13 +17,19 @@ import { PeekFeature } from './peek.ts';
 import { PickFeature } from './pick.ts';
 import { SymbolPickerFeature } from './symbol-picker.ts';
 import { RenameFeature } from './rename.ts';
+import { RenderedDocsFeature } from './rendered-docs.ts';
 import { shortcutsOf } from './shortcut-keys.ts';
 import { type Timers } from './timers.ts';
+import { InlayHintsFeature } from './inlay-hints.ts';
+import { type SemanticTokensOptions } from './semantic-tokens.ts';
 import { SignatureFeature } from './signature.ts';
 import { SnippetFeature } from './snippet-session.ts';
 import { SymbolsFeature } from './symbols.ts';
 import type { Place } from './navigation-history.ts';
 import type { LanguageDocumentHandle, ProjectLanguage } from './project-language.ts';
+export interface EditorLanguageOptions {
+    semanticTokens?: SemanticTokensOptions;
+}
 export declare class EditorLanguage {
     readonly editor: Editor;
     readonly apple: boolean;
@@ -33,6 +41,7 @@ export declare class EditorLanguage {
     readonly popups: import("./popups.ts").PopupStore;
     readonly diagnostics: DiagnosticsFeature;
     readonly hover: HoverFeature;
+    readonly inlayHints: InlayHintsFeature;
     readonly completion: CompletionFeature;
     readonly signature: SignatureFeature;
     readonly snippets: SnippetFeature;
@@ -42,15 +51,18 @@ export declare class EditorLanguage {
     readonly rename: RenameFeature;
     readonly navigation: NavigationFeature;
     readonly peek: PeekFeature;
+    readonly callHierarchy: CallHierarchyFeature;
     readonly symbolPicker: SymbolPickerFeature;
     readonly contextMenu: ContextMenuFeature;
     readonly history: HistoryFeature;
     readonly definitionLink: DefinitionLinkFeature;
     readonly symbols: SymbolsFeature;
     readonly codeVision: CodeVisionFeature;
+    readonly formatOnType: FormatOnTypeFeature;
+    readonly renderedDocs: RenderedDocsFeature;
     private readonly disposers;
     private disposed;
-    constructor(project: ProjectLanguage, editor: Editor, uri: string, languageId: string, timers?: Timers);
+    constructor(project: ProjectLanguage, editor: Editor, uri: string, languageId: string, timers?: Timers, options?: EditorLanguageOptions);
     get uri(): string;
     get isDisposed(): boolean;
     get place(): Place;

package/dist/editor-language.js

@@ -1,4 +1,5 @@
 import { KEYMAP } from '@adecore/editor/keymap';
+import { CallHierarchyFeature } from './call-hierarchy.js';
 import { CodeActionsFeature } from './code-actions.js';
 import { CodeVisionFeature } from './code-vision.js';
 import { CompletionFeature } from './completion.js';
@@ -6,6 +7,7 @@ import { ContextMenuFeature } from './context-menu.js';
 import { DefinitionLinkFeature } from './definition-link.js';
 import { DiagnosticsFeature } from './diagnostics.js';
 import { FoldingFeature } from './folding.js';
+import { FormatOnTypeFeature } from './format-on-type.js';
 import { HighlightsFeature } from './highlights.js';
 import { HistoryFeature } from './history.js';
 import { HoverFeature } from './hover.js';
@@ -14,6 +16,7 @@ import { PeekFeature } from './peek.js';
 import { PickFeature } from './pick.js';
 import { SymbolPickerFeature } from './symbol-picker.js';
 import { RenameFeature } from './rename.js';
+import { RenderedDocsFeature } from './rendered-docs.js';
 import { shortcutsOf } from './shortcut-keys.js';
 import { createPopupStore } from './popups.js';
 import { realTimers } from './timers.js';
@@ -39,6 +42,7 @@ export class EditorLanguage {
     popups = createPopupStore();
     diagnostics;
     hover;
+    inlayHints;
     completion;
     signature;
     snippets;
@@ -48,15 +52,18 @@ export class EditorLanguage {
     rename;
     navigation;
     peek;
+    callHierarchy;
     symbolPicker;
     contextMenu;
     history;
     definitionLink;
     symbols;
     codeVision;
+    formatOnType;
+    renderedDocs;
     disposers = [];
     disposed = false;
-    constructor(project, editor, uri, languageId, timers = realTimers) {
+    constructor(project, editor, uri, languageId, timers = realTimers, options = {}) {
         this.editor = editor;
         this.apple = project.host.apple ?? false;
         this.keymap = project.host.keymap ?? KEYMAP;
@@ -68,22 +75,25 @@ export class EditorLanguage {
         this.diagnostics = new DiagnosticsFeature(this);
         this.hover = new HoverFeature(this, timers);
         this.completion = new CompletionFeature(this, timers);
-        this.snippets = new SnippetFeature(this);
+        this.snippets = new SnippetFeature(this, timers);
         this.signature = new SignatureFeature(this, timers);
         this.highlights = new HighlightsFeature(this, timers);
         this.symbols = new SymbolsFeature(this, timers);
         new SelectionRangesFeature(this);
-        new SemanticTokensFeature(this, timers);
-        new InlayHintsFeature(this, timers);
+        new SemanticTokensFeature(this, timers, options.semanticTokens);
+        this.inlayHints = new InlayHintsFeature(this, timers);
         this.codeActions = new CodeActionsFeature(this, timers);
         this.rename = new RenameFeature(this);
         this.navigation = new NavigationFeature(this);
         this.peek = new PeekFeature(this);
+        this.callHierarchy = new CallHierarchyFeature(this, timers);
         this.symbolPicker = new SymbolPickerFeature(this);
         this.contextMenu = new ContextMenuFeature(this);
         this.history = new HistoryFeature(this);
         this.definitionLink = new DefinitionLinkFeature(this);
         this.codeVision = new CodeVisionFeature(this, (listener) => this.symbols.onResult(listener), timers);
+        this.formatOnType = new FormatOnTypeFeature(this);
+        this.renderedDocs = new RenderedDocsFeature(this, timers);
         new FoldingFeature(this, (listener) => this.symbols.onResult(listener), timers);
         this.placeOpenedCaret(editor.getCaret());
         this.onDispose(editor.onCaret((position) => this.placeOpenedCaret(position)));

package/dist/editor-react.css

@@ -17,6 +17,36 @@
     color: var(--accent);
     text-decoration: underline;
 }
+/* Documentation drawn in place of a comment: lists and quotes that the base layer strips of their marks. */
+.adecore-rendered-doc ul,
+.adecore-rendered-doc ol {
+    margin: 4px 0;
+    padding-inline-start: 20px;
+}
+.adecore-rendered-doc ul {
+    list-style: disc;
+}
+.adecore-rendered-doc ol {
+    list-style: decimal;
+}
+.adecore-rendered-doc blockquote {
+    margin: 4px 0;
+    padding-inline-start: 8px;
+    border-inline-start: 2px solid var(--border);
+}
+.adecore-rendered-doc :not(pre) > code {
+    font-family: var(--font-mono);
+}
+.adecore-rendered-doc h1,
+.adecore-rendered-doc h2,
+.adecore-rendered-doc h3,
+.adecore-rendered-doc h4,
+.adecore-rendered-doc h5,
+.adecore-rendered-doc h6 {
+    margin: 4px 0;
+    font-size: inherit;
+    font-weight: 600;
+}
 .adecore-editor-find {
     display: flex;
     flex-direction: column;
@@ -41,3 +71,52 @@
 .adecore-editor-find output {
     font-variant-numeric: tabular-nums;
 }
+
+.adecore-editor-diff-gap {
+    display: flex;
+    align-items: center;
+    min-height: 32px;
+    padding: 4px 8px;
+    font-family: var(--font-sans);
+    color: var(--text-muted);
+    background: var(--surface-raised);
+}
+.adecore-editor-diff-no-newline {
+    padding-inline: 8px;
+    color: var(--text-muted);
+    font-family: var(--font-sans);
+    font-size: var(--text-sm);
+}
+
+.adecore-editor-diff .se-viewport {
+    overscroll-behavior-y: auto;
+}
+
+.adecore-editor-diff[data-scroll='false'] .se-viewport {
+    overflow-y: hidden;
+}
+
+.adecore-editor-diff-split {
+    display: grid;
+    grid-template-columns: minmax(0, 1fr) minmax(0, 1fr);
+    min-height: 0;
+}
+.adecore-editor-diff-side {
+    position: relative;
+    min-width: 0;
+    min-height: 0;
+}
+.adecore-editor-diff-side + .adecore-editor-diff-side {
+    border-inline-start: 1px solid var(--border);
+}
+.adecore-editor-diff-surface {
+    position: absolute;
+    inset: 0;
+}
+.adecore-editor-diff-split .se-viewport {
+    scrollbar-gutter: stable;
+}
+.adecore-editor-diff-filler {
+    background: repeating-linear-gradient(135deg, transparent 0 6px, var(--editor-hatch) 6px 7px);
+    pointer-events: none;
+}

package/dist/format-on-type.d.ts

@@ -0,0 +1,14 @@
+import type { EditorLanguage } from './editor-language.ts';
+export declare class FormatOnTypeFeature {
+    private readonly language;
+    private enabled;
+    private revision;
+    private controller;
+    constructor(language: EditorLanguage);
+    get isEnabled(): boolean;
+    get supported(): boolean;
+    configure(enabled: boolean): void;
+    triggerCharacters(): readonly string[];
+    private typed;
+    private ask;
+}

package/dist/format-on-type.js

@@ -0,0 +1,96 @@
+import { comparePositions } from './diagnostics-model.js';
+const METHOD = 'textDocument/onTypeFormatting';
+/* A line break with the indentation the editor put after it, which is how Enter reaches the server. */
+const LINE_BREAK = /^\r?\n[ \t]*(\r?\n[ \t]*)?$/;
+/* A closer with the whitespace the editor replaced in front of it when it moved the closer back to its opener's indentation. */
+const DEDENTED = /^[ \t]+(\S)$/u;
+/* The overlapping edits of a server answer have no single meaning, so an answer that has them is not applied. */
+function overlaps(edits) {
+    const ordered = [...edits].sort((left, right) => comparePositions(left.range.start, right.range.start));
+    return ordered.some((edit, index) => index > 0 && comparePositions(ordered[index - 1].range.end, edit.range.start) > 0);
+}
+/*
+ * Formatting while typing: after a person types one of the characters the server named in
+ * `firstTriggerCharacter` and `moreTriggerCharacter`, the server is asked what to change around the caret, and its
+ * edits are applied.
+ *
+ * Only typing counts: one change that is the trigger character alone, the closer the editor moved back to its
+ * opener's indentation, or a line break with its indentation for `\n`, which the editor reports as typed though
+ * Enter runs as a command. A character the editor types over an existing closer changes no text and asks nothing. A paste, undo, a completion or an external change does not ask, and neither does a
+ * second caret, a read-only editor or a snippet session, whose tab stops an edit could move. An answer is applied
+ * only while the text is exactly what it was asked about, and the caret where it was.
+ *
+ * The edits join the undo step of the typed character, so one undo takes both back. On by default where the server offers it; `configure(false)`
+ * turns it off for a host that has a setting for it.
+ */
+export class FormatOnTypeFeature {
+    language;
+    enabled = true;
+    /* Raised by every change of the text, so an answer for an older text is told from the one for the text that is. */
+    revision = 0;
+    controller = new AbortController();
+    constructor(language) {
+        this.language = language;
+        const off = language.editor.onTextChange((change) => this.typed(change));
+        language.onDispose(() => {
+            off();
+            this.controller.abort();
+        });
+    }
+    get isEnabled() {
+        return this.enabled;
+    }
+    /* Whether the server of this document formats on type and the service can ask it. */
+    get supported() {
+        const { project, uri } = this.language;
+        return project.service.onTypeFormatting !== undefined && project.service.supports(METHOD, uri);
+    }
+    configure(enabled) {
+        this.enabled = enabled;
+        if (!enabled) {
+            this.controller.abort();
+        }
+    }
+    /* The characters that ask the server, the first one and the more. */
+    triggerCharacters() {
+        const options = this.language.project.service.providerOptions(METHOD, this.language.uri);
+        return options === undefined
+            ? []
+            : [...(options.firstTriggerCharacter === undefined ? [] : [options.firstTriggerCharacter]), ...(options.moreTriggerCharacter ?? [])];
+    }
+    typed(change) {
+        const revision = ++this.revision;
+        this.controller.abort();
+        if (!this.enabled || (change.source !== 'input' && change.typed !== true) || change.changes.length !== 1 || !this.supported) {
+            return;
+        }
+        const { editor, snippets } = this.language;
+        const { text } = change.changes[0];
+        const typed = LINE_BREAK.test(text) ? '\n' : Array.from(text).length === 1 ? text : (DEDENTED.exec(text)?.[1] ?? null);
+        if (typed === null || !this.triggerCharacters().includes(typed)) {
+            return;
+        }
+        if (snippets.isActive || editor.isReadOnly?.() === true || editor.getSelections().length !== 1) {
+            return;
+        }
+        this.controller = new AbortController();
+        void this.ask(revision, typed, editor.getCaret(), this.controller.signal);
+    }
+    async ask(revision, typed, caret, signal) {
+        const { editor, project, uri, document } = this.language;
+        try {
+            // The change of the typed character reaches the server before this question does.
+            await document.ready;
+            const edits = await project.service.onTypeFormatting(uri, caret, typed, { ...editor.getIndentation() }, { signal });
+            const here = editor.getCaret();
+            const stale = revision !== this.revision || this.language.isDisposed || comparePositions(here, caret) !== 0;
+            if (stale || edits === null || edits.length === 0 || overlaps(edits)) {
+                return;
+            }
+            editor.applyEdits(edits.map((edit) => ({ range: edit.range, text: edit.newText })), { mergeUndo: true });
+        }
+        catch {
+            // A refusal or a failing server is not worth a notice per keystroke; the next trigger character asks again.
+        }
+    }
+}