@adecore/editor-react 0.31.12 → 0.32.0

package/dist/hover-content.js

@@ -5,61 +5,75 @@ const FENCE = /^```([\w+#.-]*)[^\n]*\n([\s\S]*?)\n```[ \t]*(?:\n|$)/;
  * in the documentation, stays where it is.
  */
 export function splitSignatures(markdown) {
-    const signatures = [];
-    let rest = markdown.replace(/^\s+/, '');
-    for (let match = FENCE.exec(rest); match !== null; match = FENCE.exec(rest)) {
-        signatures.push({ language: match[1] || 'text', code: match[2] });
-        rest = rest.slice(match[0].length).replace(/^\s+/, '');
-    }
-    return { signatures, markdown: rest.replace(/^(?:-{3,}|\*{3,})\s*(?:\n|$)/, '').trim() };
+  const signatures = [];
+  let rest = markdown.replace(/^\s+/, '');
+  for (let match = FENCE.exec(rest); match !== null; match = FENCE.exec(rest)) {
+    signatures.push({
+      language: match[1] || 'text',
+      code: match[2]
+    });
+    rest = rest.slice(match[0].length).replace(/^\s+/, '');
+  }
+  return {
+    signatures,
+    markdown: rest.replace(/^(?:-{3,}|\*{3,})\s*(?:\n|$)/, '').trim()
+  };
 }
 function markedStringText(content) {
-    if (typeof content !== 'string') {
-        return { signatures: [{ language: content.language || 'text', code: content.value }], markdown: '' };
-    }
-    return splitSignatures(content);
+  if (typeof content !== 'string') {
+    return {
+      signatures: [{
+        language: content.language || 'text',
+        code: content.value
+      }],
+      markdown: ''
+    };
+  }
+  return splitSignatures(content);
 }
 /* The text of a hover, whichever of the three shapes the protocol allows it in. */
 export function hoverTextOf(hover) {
-    const { contents } = hover;
-    if (Array.isArray(contents)) {
-        const parts = contents.map(markedStringText);
-        return {
-            signatures: parts.flatMap((part) => part.signatures),
-            markdown: parts
-                .map((part) => part.markdown)
-                .filter(Boolean)
-                .join('\n\n')
-        };
-    }
-    if (typeof contents === 'string' || 'language' in contents) {
-        return markedStringText(contents);
-    }
-    return contents.kind === 'plaintext' ? { signatures: [], markdown: escapeMarkdown(contents.value).trim() } : splitSignatures(contents.value);
+  const {
+    contents
+  } = hover;
+  if (Array.isArray(contents)) {
+    const parts = contents.map(markedStringText);
+    return {
+      signatures: parts.flatMap(part => part.signatures),
+      markdown: parts.map(part => part.markdown).filter(Boolean).join('\n\n')
+    };
+  }
+  if (typeof contents === 'string' || 'language' in contents) {
+    return markedStringText(contents);
+  }
+  return contents.kind === 'plaintext' ? {
+    signatures: [],
+    markdown: escapeMarkdown(contents.value).trim()
+  } : splitSignatures(contents.value);
 }
 /* Plain text as markdown that reads the same, its markdown characters escaped. */
 export function escapeMarkdown(text) {
-    return text.replace(/([\\`*_{}[\]()#+\-.!|<>~])/g, '\\$1');
+  return text.replace(/([\\`*_{}[\]()#+\-.!|<>~])/g, '\\$1');
 }
 export function isEmptyHover(text) {
-    return text.signatures.length === 0 && text.markdown === '';
+  return text.signatures.length === 0 && text.markdown === '';
 }
 function isLink(entry) {
-    return 'targetUri' in entry;
+  return 'targetUri' in entry;
 }
 /* Where a navigation result leads, as plain locations: the part of a link that names the symbol is the one to land on. */
 export function locationsOf(result) {
-    if (result === null) {
-        return [];
-    }
-    const list = Array.isArray(result) ? result : [result];
-    return list.map((entry) => (isLink(entry) ? { uri: entry.targetUri, range: entry.targetSelectionRange } : entry));
+  if (result === null) {
+    return [];
+  }
+  const list = Array.isArray(result) ? result : [result];
+  return list.map(entry => isLink(entry) ? {
+    uri: entry.targetUri,
+    range: entry.targetSelectionRange
+  } : entry);
 }
 export function sameRange(left, right) {
-    return (left.start.line === right.start.line &&
-        left.start.character === right.start.character &&
-        left.end.line === right.end.line &&
-        left.end.character === right.end.character);
+  return left.start.line === right.start.line && left.start.character === right.start.character && left.end.line === right.end.line && left.end.character === right.end.character;
 }
 const TAG_LINE = /^(?:_@([\w-]+)_|\*@([\w-]+)\*|@([\w-]+))(?:\s+|$)([\s\S]*)$/;
 /* Tags whose text is a block of its own, which a row of the tag list has no room for. */
@@ -70,59 +84,72 @@ const BLOCK_TAGS = new Set(['example']);
  * `@` stays prose.
  */
 export function splitDocTags(markdown) {
-    const tags = [];
-    const kept = [];
-    for (const paragraph of markdown.split(/\n{2,}/)) {
-        const lines = paragraph.split('\n');
-        const matches = lines.map((line) => TAG_LINE.exec(line.trim()));
-        const names = matches.map((match) => (match === null ? null : (match[1] ?? match[2] ?? match[3])));
-        if (paragraph.trim() === '' || names.some((name) => name === null || BLOCK_TAGS.has(name))) {
-            kept.push(paragraph);
-            continue;
-        }
-        matches.forEach((match, index) => {
-            // The TypeScript server puts a dash between a tag, its parameter and its text.
-            const text = match[4].replace(/^[\u2014\u2013-]\s*/, '').replace(/^(`[^`]+`)\s+[\u2014\u2013-]\s+/, '$1 ');
-            tags.push({ name: names[index], markdown: text.trim() });
-        });
+  const tags = [];
+  const kept = [];
+  for (const paragraph of markdown.split(/\n{2,}/)) {
+    const lines = paragraph.split('\n');
+    const matches = lines.map(line => TAG_LINE.exec(line.trim()));
+    const names = matches.map(match => match === null ? null : match[1] ?? match[2] ?? match[3]);
+    if (paragraph.trim() === '' || names.some(name => name === null || BLOCK_TAGS.has(name))) {
+      kept.push(paragraph);
+      continue;
     }
-    // By name, and in the order written within one name, so parameters keep the order of the signature.
-    return { markdown: kept.join('\n\n').trim(), tags: tags.toSorted((left, right) => left.name.localeCompare(right.name)) };
+    matches.forEach((match, index) => {
+      // The TypeScript server puts a dash between a tag, its parameter and its text.
+      const text = match[4].replace(/^[\u2014\u2013-]\s*/, '').replace(/^(`[^`]+`)\s+[\u2014\u2013-]\s+/, '$1 ');
+      tags.push({
+        name: names[index],
+        markdown: text.trim()
+      });
+    });
+  }
+  // By name, and in the order written within one name, so parameters keep the order of the signature.
+  return {
+    markdown: kept.join('\n\n').trim(),
+    tags: tags.toSorted((left, right) => left.name.localeCompare(right.name))
+  };
 }
 /* A CSS server draws the status as a data URL image in front of an italic sentence, and a data URL is not an address the markdown renderer lets through. */
 const BASELINE = /!\[Baseline icon\]\([^)\s]*\)[ \t]*_([^\n]+?)_[ \t]*(?:\n|$)/;
 /* The Baseline status a text carries, which the card draws with a mark of its own, and the text without it. */
 function takeBaseline(markdown) {
-    const match = BASELINE.exec(markdown);
-    if (match === null) {
-        return { baseline: null, rest: markdown };
-    }
-    const text = match[1].trim();
-    const level = text.startsWith('Widely') ? 'widely' : text.startsWith('Newly') ? 'newly' : 'limited';
-    return { baseline: { level, text }, rest: (markdown.slice(0, match.index) + markdown.slice(match.index + match[0].length)).replace(/\n{3,}/g, '\n\n') };
+  const match = BASELINE.exec(markdown);
+  if (match === null) {
+    return {
+      baseline: null,
+      rest: markdown
+    };
+  }
+  const text = match[1].trim();
+  const level = text.startsWith('Widely') ? 'widely' : text.startsWith('Newly') ? 'newly' : 'limited';
+  return {
+    baseline: {
+      level,
+      text
+    },
+    rest: (markdown.slice(0, match.index) + markdown.slice(match.index + match[0].length)).replace(/\n{3,}/g, '\n\n')
+  };
 }
 const RULE = /^\s*(?:-{3,}|\*{3,}|_{3,})\s*$/m;
 const TITLE = /^(?:__(.+)__|\*\*(.+)\*\*)\s*(?:\n|$)/;
 const ANY_FENCE = /```([\w+#.-]*)[^\n]*\n([\s\S]*?)\n```[ \t]*(?:\n|$)/;
 /* The PHP server opens every snippet with a tag the reader does not need to see. */
 function withoutOpenTag(block) {
-    return { language: block.language, code: block.code.replace(/^<\?php\s*\n/, '') };
+  return {
+    language: block.language,
+    code: block.code.replace(/^<\?php\s*\n/, '')
+  };
 }
 const HTML_CODE = /<(code|pre)>([\s\S]*?)<\/\1>/g;
 const INLINE_TAG = /\{@(see|link|linkplain)\s+([^}\s]+)(?:\s+([^}]+?))?\s*\}/g;
 function decodeEntities(text) {
-    return text
-        .replace(/&lt;/g, '<')
-        .replace(/&gt;/g, '>')
-        .replace(/&quot;/g, '"')
-        .replace(/&#0?39;/g, "'")
-        .replace(/&amp;/g, '&');
+  return text.replace(/&lt;/g, '<').replace(/&gt;/g, '>').replace(/&quot;/g, '"').replace(/&#0?39;/g, "'").replace(/&amp;/g, '&');
 }
 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');
+  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');
 }
 /*
  * What a docblock writes for a reader of its source, written for one of a hover: a `<code>` or `<pre>`
@@ -130,70 +157,81 @@ function dedent(text) {
  * the name in code. Servers pass both on as they are, and markdown would show the tags as text.
  */
 export function docblockMarkdown(markdown, language) {
-    return markdown
-        .replace(HTML_CODE, (_match, _tag, body) => {
-        const code = decodeEntities(body);
-        return code.includes('\n') ? `\n\n\`\`\`${language}\n${dedent(code)}\n\`\`\`\n\n` : `\`${code.trim()}\``;
-    })
-        .replace(INLINE_TAG, (_match, _tag, target, label) => (label === undefined ? `\`${target}\`` : label))
-        .replace(/\n{3,}/g, '\n\n')
-        .trim();
+  return markdown.replace(HTML_CODE, (_match, _tag, body) => {
+    const code = decodeEntities(body);
+    return code.includes('\n') ? `\n\n\`\`\`${language}\n${dedent(code)}\n\`\`\`\n\n` : `\`${code.trim()}\``;
+  }).replace(INLINE_TAG, (_match, _tag, target, label) => label === undefined ? `\`${target}\`` : label).replace(/\n{3,}/g, '\n\n').trim();
 }
 export function markdownParts(markdown) {
-    const parts = [];
-    let rest = markdown;
-    for (let match = ANY_FENCE.exec(rest); match !== null; match = ANY_FENCE.exec(rest)) {
-        const prose = rest.slice(0, match.index).trim();
-        if (prose !== '') {
-            parts.push({ kind: 'prose', text: prose });
-        }
-        parts.push({ kind: 'code', block: { language: match[1] || 'text', code: match[2] } });
-        rest = rest.slice(match.index + match[0].length);
-    }
-    if (rest.trim() !== '') {
-        parts.push({ kind: 'prose', text: rest.trim() });
+  const parts = [];
+  let rest = markdown;
+  for (let match = ANY_FENCE.exec(rest); match !== null; match = ANY_FENCE.exec(rest)) {
+    const prose = rest.slice(0, match.index).trim();
+    if (prose !== '') {
+      parts.push({
+        kind: 'prose',
+        text: prose
+      });
     }
-    return parts;
+    parts.push({
+      kind: 'code',
+      block: {
+        language: match[1] || 'text',
+        code: match[2]
+      }
+    });
+    rest = rest.slice(match.index + match[0].length);
+  }
+  if (rest.trim() !== '') {
+    parts.push({
+      kind: 'prose',
+      text: rest.trim()
+    });
+  }
+  return parts;
 }
 /* The title is drawn as text, so the escapes that kept it from reading as markdown come off: `A\\B::\_\_construct` is `A\B::__construct`. */
 function unescapeMarkdown(text) {
-    return text.replace(/\\([\\`*_{}[\]()#+\-.!|<>~])/g, '$1');
+  return text.replace(/\\([\\`*_{}[\]()#+\-.!|<>~])/g, '$1');
 }
 function sectionOf(chunk, leading) {
-    let rest = chunk.trim();
-    const title = TITLE.exec(rest);
-    if (title !== null) {
-        rest = rest.slice(title[0].length).trim();
-    }
-    const signatures = [...leading];
-    // A section's own snippet is its first block; one further down after the prose, such as an example, stays prose.
-    const fence = ANY_FENCE.exec(rest);
-    if (fence !== null && !/@example/.test(rest.slice(0, fence.index))) {
-        signatures.push({ language: fence[1] || 'text', code: fence[2] });
-        rest = (rest.slice(0, fence.index) + rest.slice(fence.index + fence[0].length)).trim();
-    }
-    const taken = takeBaseline(rest);
-    const doc = splitDocTags(docblockMarkdown(taken.rest, signatures[0]?.language ?? 'text'));
-    return {
-        title: title === null ? null : unescapeMarkdown((title[1] ?? title[2]).trim()),
-        signatures: signatures.map(withoutOpenTag),
-        markdown: doc.markdown,
-        tags: doc.tags,
-        baseline: taken.baseline
-    };
+  let rest = chunk.trim();
+  const title = TITLE.exec(rest);
+  if (title !== null) {
+    rest = rest.slice(title[0].length).trim();
+  }
+  const signatures = [...leading];
+  // A section's own snippet is its first block; one further down after the prose, such as an example, stays prose.
+  const fence = ANY_FENCE.exec(rest);
+  if (fence !== null && !/@example/.test(rest.slice(0, fence.index))) {
+    signatures.push({
+      language: fence[1] || 'text',
+      code: fence[2]
+    });
+    rest = (rest.slice(0, fence.index) + rest.slice(fence.index + fence[0].length)).trim();
+  }
+  const taken = takeBaseline(rest);
+  const doc = splitDocTags(docblockMarkdown(taken.rest, signatures[0]?.language ?? 'text'));
+  return {
+    title: title === null ? null : unescapeMarkdown((title[1] ?? title[2]).trim()),
+    signatures: signatures.map(withoutOpenTag),
+    markdown: doc.markdown,
+    tags: doc.tags,
+    baseline: taken.baseline
+  };
 }
 /* The symbols of a hover apart, split where a server draws a rule between them, each described once. */
 export function hoverSectionsOf(text) {
-    const chunks = text.markdown === '' ? [''] : text.markdown.split(RULE);
-    const sections = chunks.map((chunk, index) => sectionOf(chunk, index === 0 ? text.signatures : []));
-    const seen = new Set();
-    return sections.filter((section) => {
-        const empty = section.title === null && section.signatures.length === 0 && section.markdown === '' && section.tags.length === 0 && section.baseline === null;
-        const key = JSON.stringify([section.title, section.signatures, section.markdown, section.baseline]);
-        if (empty || seen.has(key)) {
-            return false;
-        }
-        seen.add(key);
-        return true;
-    });
-}
+  const chunks = text.markdown === '' ? [''] : text.markdown.split(RULE);
+  const sections = chunks.map((chunk, index) => sectionOf(chunk, index === 0 ? text.signatures : []));
+  const seen = new Set();
+  return sections.filter(section => {
+    const empty = section.title === null && section.signatures.length === 0 && section.markdown === '' && section.tags.length === 0 && section.baseline === null;
+    const key = JSON.stringify([section.title, section.signatures, section.markdown, section.baseline]);
+    if (empty || seen.has(key)) {
+      return false;
+    }
+    seen.add(key);
+    return true;
+  });
+}