plainleaf/plugs/editor/complete.ts

import { folderName } from "@silverbulletmd/silverbullet/lib/resolve";
import { editor, index, language, lua } from "@silverbulletmd/silverbullet/syscalls";
import type {
  DocumentMeta,
  PageMeta,
} from "@silverbulletmd/silverbullet/type/index";
import type { CompleteEvent } from "@silverbulletmd/silverbullet/type/client";

// Page completion
export async function pageComplete(completeEvent: CompleteEvent) {
  const isDocumentQuery = {
    objectVariable: "_",
    where: await lua.parseExpression(
      `not string.startsWith(_.name, "_") and not string.endsWith(_.name, ".plug.js")`,
    ),
  };
  const isMetaPageQuery = {
    objectVariable: "_",
    where: await lua.parseExpression(`table.find(_.tags, function(tag)
           return tag == "meta" or string.startsWith(tag, "meta/")
          end)`),
  };
  const isntMetaPageQuery = {
    objectVariable: "_",
    where: await lua.parseExpression(`not table.find(_.tags, function(tag)
           return tag == "meta" or string.startsWith(tag, "meta/")
          end)`),
  };
  // Try to match [[wikilink]]
  let isWikilink = true;
  // This negative lookbehind is to prevent matching query[[. This requires negative lookbehind, which generally supported now (it seems), in versions of iOS Safari 13.1 and later
  // https://caniuse.com/js-regexp-lookbehind
  let match = /(?<!query)\[\[([^\]@$#:{}]*)$/.exec(completeEvent.linePrefix);
  if (!match) {
    // Try to match [markdown link]()
    match = /\[.*\]\(([^\])@$#:{}]*)$/.exec(completeEvent.linePrefix);
    isWikilink = false;
  }
  if (!match) {
    return null;
  }

  const prefix = match[1];

  let allPages: (PageMeta | DocumentMeta)[] = [];

  if (prefix.startsWith("^")) {
    // A carrot prefix means we're looking for a meta page
    allPages = await index.queryLuaObjects<PageMeta>("page", isMetaPageQuery);
    // Let's prefix the names with a caret to make them match
    allPages = allPages.map((page) => ({
      ...page,
      name: `^${page.name}`,
    }));
  } else {
    // This is the most common case, we're combining three types of completions here:
    allPages = (
      await Promise.all([
        // All non-meta pages
        index.queryLuaObjects<PageMeta>("page", isntMetaPageQuery),
        // All documents
        index.queryLuaObjects<DocumentMeta>("document", isDocumentQuery),
        // And all links to non-existing pages (to augment the existing ones)
        index
          .queryLuaObjects<string>("aspiring-page", {
            select: { type: "Variable", name: "name", ctx: {} as any },
            distinct: true,
          })
          .then((aspiringPages) =>
            // Rewrite them to PageMeta shaped objects
            aspiringPages.map(
              (aspiringPage: string): PageMeta => ({
                ref: aspiringPage,
                tag: "page",
                tags: ["non-existing"], // Picked up later in completion
                name: aspiringPage,
                created: "",
                lastModified: "",
                perm: "rw",
              }),
            ),
          ),
      ])
    ).flat();
  }

  // Don't complete hidden pages
  allPages = allPages.filter((page) => !(page.pageDecoration?.hide === true));

  const folder = folderName(completeEvent.pageName);

  return {
    from: completeEvent.pos - prefix.length,
    options: allPages.flatMap((pageMeta) => {
      const completions: any[] = [];
      const namePrefix = (pageMeta as PageMeta).pageDecoration?.prefix || "";
      const cssClass = ((pageMeta as PageMeta).pageDecoration?.cssClasses || [])
        .join(" ")
        .replaceAll(/[^a-zA-Z0-9-_ ]/g, "");

      if (isWikilink) {
        // A [[wikilink]]
        const linkAlias = pageMeta.linkName || pageMeta.displayName;
        if (linkAlias) {
          const decoratedName = namePrefix + linkAlias;
          let boost = new Date(pageMeta.lastModified).getTime();
          if (pageMeta._isAspiring) {
            boost = -Infinity;
          }
          completions.push({
            label: linkAlias,
            displayLabel: decoratedName,
            boost,
            apply:
              pageMeta.tag === "template"
                ? pageMeta.name
                : `${pageMeta.name}|${linkAlias}`,
            detail: pageMeta.linkName
              ? `linkName for: ${pageMeta.name}`
              : `displayName for: ${pageMeta.name}`,
            type: "page",
            cssClass,
          });
        }
        if (Array.isArray(pageMeta.aliases)) {
          for (const alias of pageMeta.aliases) {
            const decoratedName = namePrefix + alias;
            completions.push({
              label: `${alias}`,
              displayLabel: decoratedName,
              boost: new Date(pageMeta.lastModified).getTime(),
              apply:
                pageMeta.tag === "template"
                  ? pageMeta.name
                  : `${pageMeta.name}|${alias}`,
              detail: `alias to: ${pageMeta.name}`,
              type: "page",
              cssClass,
            });
          }
        }
        const decoratedName = namePrefix + pageMeta.name;
        completions.push({
          label: pageMeta.name,
          displayLabel: decoratedName,
          boost: new Date(pageMeta.lastModified).getTime(),
          detail: pageMeta.tags?.includes("non-existing")
            ? "Linked but not created"
            : undefined,
          type: "page",
          cssClass,
        });
      } else {
        // A markdown link []()
        let labelText = pageMeta.name;
        let boost = new Date(pageMeta.lastModified).getTime();
        // Relative path if in the same folder or a subfolder
        if (folder.length > 0 && labelText.startsWith(folder)) {
          labelText = labelText.slice(folder.length + 1);
          boost = boost * 1.1;
        } else {
          // Absolute path otherwise
          labelText = `/${labelText}`;
        }
        completions.push({
          label: labelText,
          displayLabel: namePrefix + labelText,
          boost: boost,
          apply: labelText.includes(" ") ? `<${labelText}>` : labelText,
          type: "page",
          cssClass,
        });
      }
      return completions;
    }),
  };
}

export async function footnoteComplete(completeEvent: CompleteEvent) {
  const match = /\[\^([^\]\s]*)$/.exec(completeEvent.linePrefix);
  if (!match) return null;

  // Rudamentary scan of full editor text to quickly find all footnote definitions
  const text = await editor.getText();
  const defRegex = /^\[\^([^\]\s]+)\]:\s?(.*)$/gm;
  const options = [];
  let m;
  while ((m = defRegex.exec(text)) !== null) {
    const label = m[1];
    let body = m[2].trim();
    if (body.length > 50) {
      body = `${body.slice(0, 50)}\u2026`;
    }
    options.push({
      label,
      detail: body,
      type: "footnote",
    });
  }

  return {
    from: completeEvent.pos - match[1].length,
    options,
  };
}

export async function languageComplete(completeEvent: CompleteEvent) {
  const languagePrefix = /^(?:```+|~~~+)(\w*)$/.exec(completeEvent.linePrefix);
  if (!languagePrefix) {
    return null;
  }

  const allLanguages = await language.listLanguages();
  return {
    from: completeEvent.pos - languagePrefix[1].length,
    options: allLanguages.map((lang) => ({
      label: lang,
      type: "language",
    })),
  };
}