yanki 2.0.4 → 2.0.6

package/dist/lib/index.js

@@ -2,13 +2,45 @@ import { deepmerge } from "deepmerge-ts";
 import plur from "plur";
 import prettyMilliseconds from "pretty-ms";
 import { YankiConnect, defaultYankiConnectOptions } from "yanki-connect";
-import rehypeShiki from "@shikijs/rehype";
+import bash from "@shikijs/langs/bash";
+import c from "@shikijs/langs/c";
+import cpp from "@shikijs/langs/cpp";
+import css from "@shikijs/langs/css";
+import diff from "@shikijs/langs/diff";
+import dockerfile from "@shikijs/langs/dockerfile";
+import go from "@shikijs/langs/go";
+import html from "@shikijs/langs/html";
+import java from "@shikijs/langs/java";
+import javascript from "@shikijs/langs/javascript";
+import json from "@shikijs/langs/json";
+import jsx from "@shikijs/langs/jsx";
+import kotlin from "@shikijs/langs/kotlin";
+import markdown from "@shikijs/langs/markdown";
+import php from "@shikijs/langs/php";
+import python from "@shikijs/langs/python";
+import regex from "@shikijs/langs/regex";
+import ruby from "@shikijs/langs/ruby";
+import rust from "@shikijs/langs/rust";
+import scss from "@shikijs/langs/scss";
+import shellscript from "@shikijs/langs/shellscript";
+import sql from "@shikijs/langs/sql";
+import swift from "@shikijs/langs/swift";
+import toml from "@shikijs/langs/toml";
+import tsx from "@shikijs/langs/tsx";
+import typescript from "@shikijs/langs/typescript";
+import xml from "@shikijs/langs/xml";
+import yaml from "@shikijs/langs/yaml";
+import rehypeShikiFromHighlighter from "@shikijs/rehype/core";
+import githubDark from "@shikijs/themes/github-dark";
+import githubLight from "@shikijs/themes/github-light";
 import { toText } from "hast-util-to-text";
 import rehypeFormat from "rehype-format";
 import rehypeParse from "rehype-parse";
 import rehypeRaw from "rehype-raw";
 import rehypeStringify from "rehype-stringify";
 import remarkRehype from "remark-rehype";
+import { createHighlighterCore } from "shiki/core";
+import { createJavaScriptRegexEngine } from "shiki/engine/javascript";
 import { unified } from "unified";
 import { u } from "unist-builder";
 import { CONTINUE, EXIT, SKIP, visit } from "unist-util-visit";
@@ -42,10 +74,13 @@ function capitalize(text) {
 * Truncates on word boundary and adds ellipsis. Does not give special treatment
 * to file extensions. If there are no spaces in the text, it will truncate at
 * `maxLength` without respect for word boundaries.
+*
 * @param text Text to truncate
 * @param maxLength Maximum length excluding ellipsis
 * @param truncationString String to append to truncated text. Defaults to '...'
-* @param wordBoundary Character to consider a word boundary. Defaults to a space.
+* @param wordBoundary Character to consider a word boundary. Defaults to a
+*   space.
+*
 * @returns Truncated string
 */
 function truncateOnWordBoundary(text, maxLength, truncationString = "...", wordBoundary = " ") {
@@ -63,10 +98,12 @@ function emptyIsUndefined(text) {
 	return text.trim() === "" ? void 0 : text;
 }
 /**
-* Mainly for nice formatting with prettier. But the line wrapping means we have to strip surplus whitespace.
+* Mainly for nice formatting with prettier. But the line wrapping means we have
+* to strip surplus whitespace.
+*
 * @public
 */
-function css(strings, ...values) {
+function css$1(strings, ...values) {
 	return trimLeadingIndentation(strings, ...values);
 }
 const NEWLINE_REGEX$1 = /\r?\n/;
@@ -86,10 +123,12 @@ function splitAtFirstMatch(text, regex) {
 //#endregion
 //#region src/lib/shared/constants.ts
 /**
-* The default CSS to use for cards. This matches Anki's default. Stored in the Yanki card models and shared across all Yanki-managed notes regardless of namespace.
-* It does change occasionally, see https://github.com/ankitects/anki/blob/main/rslib/src/notetype/styling.css
+* The default CSS to use for cards. This matches Anki's default. Stored in the
+* Yanki card models and shared across all Yanki-managed notes regardless of
+* namespace. It does change occasionally, see
+* https://github.com/ankitects/anki/blob/main/rslib/src/notetype/styling.css
 */
-const CSS_DEFAULT_STYLE = css`
+const CSS_DEFAULT_STYLE = css$1`
 	.card {
 		font-family: arial;
 		font-size: 20px;
@@ -100,7 +139,8 @@ const CSS_DEFAULT_STYLE = css`
 	}
 `;
 /**
-* CSS class to always include in a top-level div wrapper in the card template to allow for custom styling.
+* CSS class to always include in a top-level div wrapper in the card template
+* to allow for custom styling.
 */
 const CSS_DEFAULT_CLASS_NAME = "yanki";
 /**
@@ -110,12 +150,13 @@ const CSS_DEFAULT_CLASS_NAME = "yanki";
 */
 const NOTE_DEFAULT_DECK_NAME = "Yanki";
 /**
-* Text to show if a note 'Front' field is empty, and content is required for a semantically valid card.
+* Text to show if a note 'Front' field is empty, and content is required for a
+* semantically valid card.
 */
 const NOTE_DEFAULT_EMPTY_TEXT = "(Empty)";
 /**
-* HTML element to use to present `NOTE_DEFAULT_EMPTY_TEXT`.
-* TODO consider hidden span?
+* HTML element to use to present `NOTE_DEFAULT_EMPTY_TEXT`. TODO consider
+* hidden span?
 */
 const NOTE_DEFAULT_EMPTY_HAST = u("element", {
 	properties: {},
@@ -130,19 +171,23 @@ const MEDIA_DEFAULT_HASH_MODE_URL = "metadata";
 * How to first attempt to infer the asset type behind a URL.
 *
 * - `metadata`: Fetch the head and hope for a `Content-Type` header.
-* - `name`: Infer the extension from the URL alone, won't work if there's nothing extension-like in the `pathname`.
+* - `name`: Infer the extension from the URL alone, won't work if there's nothing
+*   extension-like in the `pathname`.
 */
 const MEDIA_URL_CONTENT_TYPE_MODE = "metadata";
 /**
-* Filename to use when a media asset has no name. Will be appended with counter parenthetical as needed.
+* Filename to use when a media asset has no name. Will be appended with counter
+* parenthetical as needed.
 */
 const MEDIA_DEFAULT_EMPTY_FILENAME = "Untitled";
 /**
 * Supported image extensions for Anki media assets.
 *
-* Note that while officially "supported", some of these are not universally compatible across Anki platforms.
+* Note that while officially "supported", some of these are not universally
+* compatible across Anki platforms.
 *
-* Via https://github.com/ankitects/anki/blob/e41c4573d789afe8b020fab5d9d1eede50c3fa3d/qt/aqt/editor.py#L62
+* Via
+* https://github.com/ankitects/anki/blob/e41c4573d789afe8b020fab5d9d1eede50c3fa3d/qt/aqt/editor.py#L62
 */
 const MEDIA_SUPPORTED_IMAGE_EXTENSIONS = [
 	"avif",
@@ -360,7 +405,8 @@ const FORBIDDEN_CHARACTERS = [
 ];
 /**
 * Convenience
-* @returns sanitized valid namespace
+*
+* @returns Sanitized valid namespace
 * @throws {Error} If namespace is invalid
 */
 function validateAndSanitizeNamespace(namespace, allowAsterisk = false) {
@@ -369,7 +415,8 @@ function validateAndSanitizeNamespace(namespace, allowAsterisk = false) {
 }
 /**
 * Used internally before storing and searching
-* @returns sanitized namespace
+*
+* @returns Sanitized namespace
 */
 function sanitizeNamespace(namespace) {
 	return namespace.normalize("NFC").trim();
@@ -383,11 +430,13 @@ function sanitizeNamespace(namespace) {
 * about the letter of the namespace, otherwise there's a risk of data loss. For
 * this reason, validation is strict and throws errors, so that the user can
 * understand and correct their input so that they know the proper form for
-* subsequent uses of the namespace string — especially if they're using the CLI.
+* subsequent uses of the namespace string — especially if they're using the
+* CLI.
 *
 * Silently correcting the namespace would be a bad idea, because the user might
 * not realize that the namespace has been changed, and then they might not be
 * able to find their notes.
+*
 * @throws {Error}
 */
 function validateNamespace(namespace, allowAsterisk = false) {
@@ -462,7 +511,9 @@ const WINDOWS_DRIVE_LETTER_REGEX = /^[A-Z]:/i;
 const QUERY_FRAGMENT_START_REGEX = /[#?^]/;
 /**
 * The browserify polyfill doesn't implement win32 absolute path detection...
+*
 * @param filePath Normalized path
+*
 * @returns Whether the path is absolute
 */
 function isAbsolute(filePath) {
@@ -472,8 +523,10 @@ const RE_WINDOWS_EXTENDED_LENGTH_PATH = /^\\\\\?\\.+/;
 /**
 * Converts all paths to cross-platform 'mixed' style with forward slashes.
 * Warns on unsupported Windows extended length paths.
+*
 * @param filePath Path to normalize
-* @returns normalized path
+*
+* @returns Normalized path
 */
 function normalize(filePath) {
 	if (RE_WINDOWS_EXTENDED_LENGTH_PATH.test(filePath)) {
@@ -486,14 +539,15 @@ function normalize(filePath) {
 	return normalizedPath;
 }
 /**
-* Special handling for `/absolute-path.md` style links in Obsidian
-* and static site generators, where absolute paths are relative to a base path
-* instead of the volume root.
+* Special handling for `/absolute-path.md` style links in Obsidian and static
+* site generators, where absolute paths are relative to a base path instead of
+* the volume root.
 *
-
+* Paths starting with Windows drive letters, while technically absolute, are
+* _not_ prepended with the base:
 *
-* Paths starting with Windows drive letters, while technically absolute, are _not_ prepended with the base:
-* - If no base path is provided, paths are resolved relative to the the provided CWD.
+* - If no base path is provided, paths are resolved relative to the the provided
+*   CWD.
 * - If paths are relative, the base paths are ignored and the CWD is used.
 *
 * All path values are normalized and in 'mixed' platform style.
@@ -570,8 +624,9 @@ function isUrl(text) {
 	return safeParseUrl(text) !== void 0;
 }
 /**
-* Helper to "filter" file URLs into path strings so they're treated
-* correctly in mdastToHtml
+* Helper to "filter" file URLs into path strings so they're treated correctly
+* in mdastToHtml
+*
 * @todo Need stuff from node's implementation, fileURLToPath?
 */
 function fileUrlToPath(url) {
@@ -593,9 +648,12 @@ function getSrcType(filePathOrUrl) {
 }
 /**
 * Supports both Header type and Record<string, string> type
+*
 * @param headers Headers object or record from a fetch response
 * @param headerKeys Headers to include in the string
-* @returns a concatenated string of the header contents, suitable for hashing, or undefined if no matching headers are present
+*
+* @returns A concatenated string of the header contents, suitable for hashing,
+*   or undefined if no matching headers are present
 */
 function getHeadersString(headers, headerKeys) {
 	if (headers === void 0) return;
@@ -648,11 +706,11 @@ async function getFileExtensionFromUrl(url, fetchAdapter, mode = MEDIA_URL_CONTE
 *
 * - `filename`: Use the filename of the media asset, no network required.
 * - `metadata`: Use the metadata of the media asset, either fstat stuff for
-* files, or reading the headers for URLs... requires a network request for
-* remote urls. Falls through to `filename` if not available.
-* - `content`: Actually read the content of the media asset, requires reading
-* the file or fetching the URL. Not yet implemented. Falls through to
-* `metadata` if not available.
+*   files, or reading the headers for URLs... requires a network request for
+*   remote urls. Falls through to `filename` if not available.
+* - `content`: Actually read the content of the media asset, requires reading the
+*   file or fetching the URL. Not yet implemented. Falls through to `metadata`
+*   if not available.
 */
 async function getUrlContentHash(url, fetchAdapter, mode = MEDIA_DEFAULT_HASH_MODE_URL) {
 	switch (mode) {
@@ -687,8 +745,11 @@ function hostAndPortToUrl(host, port) {
 //#region src/lib/utilities/media.ts
 /**
 * Get the extension of a media file, if it's supported
-* @returns Extension without the `.`, possibly an extra string if no extension is found
+*
+* @returns Extension without the `.`, possibly an extra string if no extension
+*   is found
 * @todo Check for how it handles query strings
+*
 * @todo Clean up type casting
 */
 async function getAnkiMediaFilenameExtension(pathOrUrl, fetchAdapter) {
@@ -704,8 +765,8 @@ async function mediaAssetExists(absolutePathOrUrl, fileAdapter, fetchAdapter) {
 	return fileExists(absolutePathOrUrl, fileAdapter);
 }
 /**
-* Get a safe filename for an Anki media asset
-* Anki truncates long file names... so we crush the complete path down to a hash
+* Get a safe filename for an Anki media asset Anki truncates long file names...
+* so we crush the complete path down to a hash
 */
 async function getSafeAnkiMediaFilename(absolutePathOrUrl, namespace, fileExtension, fileAdapter, fetchAdapter) {
 	if (!await mediaAssetExists(absolutePathOrUrl, fileAdapter, fetchAdapter)) return;
@@ -722,6 +783,10 @@ async function getContentHash(absolutePathOrUrl, fileAdapter, fetchAdapter) {
 }
 //#endregion
 //#region src/lib/parse/rehype-mathjax-anki.ts
+const CONSECUTIVE_BRACES_REGEX = /([{}])(?=[{}])/g;
+function sanitizeBraces(value) {
+	return value.replaceAll(CONSECUTIVE_BRACES_REGEX, "$1 ");
+}
 /**
 * Non-rendering replacement for the `rehype-mathjax` plugin, which takes output
 * from `remark-math` and wraps it in Anki-specific syntax.
@@ -740,6 +805,7 @@ const plugin$3 = function() {
 			if (node.tagName === "code" && Array.isArray(node.properties.className) && node.properties.className.includes("language-math")) {
 				const isBlock = node.properties.className.includes("math-display") || fenced;
 				fenced = false;
+				for (const child of node.children) if (child.type === "text") child.value = sanitizeBraces(child.value);
 				node.tagName = isBlock ? "div" : "span";
 				node.children = [
 					{
@@ -770,7 +836,41 @@ const plugin$2 = function() {
 //#endregion
 //#region src/lib/parse/rehype-utilities.ts
 const DIMENSION_CHARS_REGEX = /^[\dx]+$/;
-const processor = unified().use(plugin$2).use(remarkRehype, { allowDangerousHtml: true }).use(rehypeRaw).use(plugin$3).use(rehypeShiki, {
+const highlighter = await createHighlighterCore({
+	engine: createJavaScriptRegexEngine(),
+	langs: [
+		bash,
+		c,
+		cpp,
+		css,
+		diff,
+		dockerfile,
+		go,
+		html,
+		java,
+		javascript,
+		json,
+		jsx,
+		kotlin,
+		markdown,
+		php,
+		python,
+		regex,
+		ruby,
+		rust,
+		scss,
+		shellscript,
+		sql,
+		swift,
+		toml,
+		tsx,
+		typescript,
+		xml,
+		yaml
+	],
+	themes: [githubDark, githubLight]
+});
+const processor = unified().use(plugin$2).use(remarkRehype, { allowDangerousHtml: true }).use(rehypeRaw).use(plugin$3).use(rehypeShikiFromHighlighter, highlighter, {
 	defaultLanguage: "plaintext",
 	fallbackLanguage: "plaintext",
 	themes: {
@@ -939,7 +1039,9 @@ function parseDimensions(dimensions) {
 }
 /**
 * Determine if a HAST tree is visually empty.
+*
 * @param tree - The HAST tree to check.
+*
 * @returns - True if the tree is visually empty, otherwise false.
 */
 function isVisuallyEmpty(tree) {
@@ -976,10 +1078,12 @@ function isVisuallyEmpty(tree) {
 	return !hasVisualContent;
 }
 /**
-* Add a first child to the first div element in a HAST tree.
-* Intended for use with the "div-wrapped" HAST tree generated early in `mdastToHtml`.
+* Add a first child to the first div element in a HAST tree. Intended for use
+* with the "div-wrapped" HAST tree generated early in `mdastToHtml`.
+*
 * @param tree - The HAST tree to modify in place.
 * @param newChild - The new child node to add.
+*
 * @returns - The modified-in-place HAST tree.
 */
 function addFirstChildToFirstDiv(tree, newChild) {
@@ -1069,9 +1173,12 @@ async function deleteNotes(client, notes, dryRun = false) {
 *
 * Duplicates will be created if present in the source. It's up to the user to
 * manage their Markdown files as they like.
+*
 * @param client An instance of YankiConnect
 * @param note The note to add
-* @param dryRun If true, the note will not be created and an ID of 0 will be returned
+* @param dryRun If true, the note will not be created and an ID of 0 will be
+*   returned
+*
 * @returns The ID of the newly created note in Anki
 * @throws {Error}
 */
@@ -1103,11 +1210,14 @@ async function addNote(client, note, dryRun, fileAdapter) {
 }
 /**
 * Updates a note in Anki.
+*
 * @param client An instance of YankiConnect
 * @param localNote A note read from a markdown file
 * @param remoteNote A note loaded from Anki
+*
 * @returns True if the note was updated, false otherwise.
-* @throws {Error} If the local note ID or remote note cards are undefined, or if model/deck errors occur.
+* @throws {Error} If the local note ID or remote note cards are undefined, or
+*   if model/deck errors occur.
 */
 async function updateNote(client, localNote, remoteNote, dryRun, fileAdapter) {
 	if (localNote.noteId === void 0) throw new Error("Local note ID is undefined");
@@ -1146,6 +1256,7 @@ async function updateNote(client, localNote, remoteNote, dryRun, fileAdapter) {
 }
 /**
 * Helper to compare local and remote field contents.
+*
 * @returns True if the fields are equal, false otherwise.
 */
 function areFieldsEqual(localFields, remoteFields) {
@@ -1167,14 +1278,14 @@ function areNotesEqual(noteA, noteB, includeId = true) {
 	return true;
 }
 /**
-* Helper function to compare two arrays of tags.
-* Note some nuances around case insensitivity as discussed here:
-* https://github.com/kitschpatrol/yanki-obsidian/issues/44
-* Anki will alphabetically sort tags, so we sort as well.
-* Duplicate tags are ignored in Anki, so we ignore them here:
-* ['yes', 'yes'] is considered equal to ['yes'].
-* Tags in different orders are considered equal:
-* ['yes', 'no'] is considered equal to ['no', 'yes'].
+* Helper function to compare two arrays of tags. Note some nuances around case
+* insensitivity as discussed here:
+* https://github.com/kitschpatrol/yanki-obsidian/issues/44 Anki will
+* alphabetically sort tags, so we sort as well. Duplicate tags are ignored in
+* Anki, so we ignore them here: ['yes', 'yes'] is considered equal to ['yes'].
+* Tags in different orders are considered equal: ['yes', 'no'] is considered
+* equal to ['no', 'yes'].
+*
 * @returns True if the tags are equal, false otherwise.
 */
 function areTagsEqual(localTags, remoteTags) {
@@ -1184,8 +1295,11 @@ function areTagsEqual(localTags, remoteTags) {
 }
 /**
 * Get all notes from Anki that match the model prefix.
+*
 * @param client An instance of YankiConnect
-* @param namespace The value of the YankiNamespace field, or search with '*' to get all notes. Defaults to the global default namespace.
+* @param namespace The value of the YankiNamespace field, or search with '*' to
+*   get all notes. Defaults to the global default namespace.
+*
 * @returns An array of YankiNote objects
 * @throws {Error}
 */
@@ -1196,14 +1310,19 @@ async function getRemoteNotes(client, namespace = defaultGlobalOptions.namespace
 * Get all data from Anki required to populate the YankiNote type.
 *
 * Handles some extra footwork to identify the deck name and validate the model
-* name. There's no way to get everything we need in one shot from Anki-Connect.
+* name. There's no way to get everything we need in one shot from
+* Anki-Connect.
 *
 * Undefined elements in the returned array are subsequently used to identify
 * notes that need to be created.
+*
 * @param client An instance of YankiConnect
 * @param noteIds An array of local note IDs to (attempt) to fetch
-* @returns Array of YankiNote objects, with undefined for notes that could not be found.
-* @throws {Error} If an unknown model name or multiple decks are found for a note, or if no deck is found.
+*
+* @returns Array of YankiNote objects, with undefined for notes that could not
+*   be found.
+* @throws {Error} If an unknown model name or multiple decks are found for a
+*   note, or if no deck is found.
 */
 async function getRemoteNotesById(client, noteIds) {
 	const ankiNotes = await client.note.notesInfo({ notes: noteIds });
@@ -1311,7 +1430,8 @@ async function deleteOrphanedDecks(client, activeNotes, originalNotes, dryRun) {
 	return decksToDelete;
 }
 /**
-* Global! Does not respect namespace. You can write namespace checks into your css if you want.
+* Global! Does not respect namespace. You can write namespace checks into your
+* css if you want.
 */
 async function updateModelStyle(client, modelName, css, dryRun) {
 	let currentCss;
@@ -1343,6 +1463,7 @@ async function getModelStyle(client, modelName = yankiModelNames[0]) {
 }
 /**
 * Upload all media files for a note to Anki.
+*
 * @returns Original source name of media files uploaded
 */
 async function uploadMediaForNote(client, note, dryRun, fileAdapter) {
@@ -1416,7 +1537,9 @@ async function reconcileMedia(client, liveNotes, namespace, dryRun, fileAdapter)
 }
 /**
 * Request permission to access Anki through Anki-Connect.
-* @returns 'ankiUnreachable' if Anki is not open, or 'granted' if everything is copacetic
+*
+* @returns 'ankiUnreachable' if Anki is not open, or 'granted' if everything is
+*   copacetic
 * @throws {Error} If access is denied
 */
 async function requestPermission(client) {
@@ -1443,8 +1566,10 @@ const defaultCleanOptions = { ...defaultGlobalOptions };
 * Deletes all remote notes in Anki associated with the given namespace.
 *
 * Use with significant caution. Mostly useful for testing.
+*
 * @returns The IDs of the notes that were deleted
-* @throws {Error} If Anki is unreachable or another error occurs during deletion.
+* @throws {Error} If Anki is unreachable or another error occurs during
+*   deletion.
 */
 async function cleanNotes(options) {
 	const startTime = performance.now();
@@ -1552,8 +1677,11 @@ function getSafeTitleForNote(note, manageFilenames, maxLength) {
 }
 /**
 * Get a safe filename for a media asset
+*
 * @param text Text to be converted to a safe filename
-* @param maxLength If undefined, no truncation will take place. If defined, a maximum maximum length of the filename will be enforced.
+* @param maxLength If undefined, no truncation will take place. If defined, a
+*   maximum maximum length of the filename will be enforced.
+*
 * @returns A safe filename
 */
 function getSafeFilename(text, maxLength) {
@@ -1582,8 +1710,11 @@ function auditUniqueFilePath(filePath, existingFilenames) {
 }
 /**
 * Strip the trailing increment from a filename
-* @param filename File name with or without an extension, and possibly with a (1)
-* @returns filename without the increment
+*
+* @param filename File name with or without an extension, and possibly with a
+*   (1)
+*
+* @returns Filename without the increment
 */
 function stripFilenameIncrement(filename) {
 	const validExtension = filename.endsWith(".") || filename.endsWith(")") ? void 0 : path.extname(filename);
@@ -1610,27 +1741,31 @@ const defaultResolveLinkOptions = {
 /**
 * Resolve a file path, URL, or wiki-style named links to an absolute path.
 *
-* Warning:
-* Wiki name link resolution is CASE INSENSITIVE, like in Obsidian, though
-* the case of the matching file will be preserved in the returned path.
+* Warning: Wiki name link resolution is CASE INSENSITIVE, like in Obsidian,
+* though the case of the matching file will be preserved in the returned path.
+*
 * @param filePathOrUrl May be one of:
-* - Wiki named link
-* - Relative file path
-* - Bare file path
-* - Absolute file path
-* - HTTP protocol URL string
-* - File protocol URL string
-* - Obsidian protocol URL string
-* (All file paths can be Windows or POSIX, with or without URI encoding, with
-* or without funky Obsidian-style post-extension block and heading anchor
-* additions.)
+*
+*   - Wiki named link
+*   - Relative file path
+*   - Bare file path
+*   - Absolute file path
+*   - HTTP protocol URL string
+*   - File protocol URL string
+*   - Obsidian protocol URL string (All file paths can be Windows or POSIX, with or
+*       without URI encoding, with or without funky Obsidian-style
+*       post-extension block and heading anchor additions.)
+*
+*
 * @returns Resolved absolute path or URL One of:
-* - Resolved absolute POSIX-style paths
+*
+*   - Resolved absolute POSIX-style paths
 *   - Removes any file path query parameters
 *   - Not URI-encoded
 *   - Retains original case
-* - HTTP protocol URL
-* - Obsidian protocol vault URL (Optionally, this will include file query parameters)
+*   - HTTP protocol URL
+*   - Obsidian protocol vault URL (Optionally, this will include file query
+*       parameters)
 */
 function resolveLink(filePathOrUrl, options) {
 	const { allFilePaths, basePath, convertFilePathsToProtocol, cwd, obsidianVaultName, type } = deepmerge(defaultResolveLinkOptions, options ?? {});
@@ -1695,16 +1830,19 @@ function resolveLink(filePathOrUrl, options) {
 *
 * See Obsidian's `getFirstLinkpathDest()` for a roughly equivalent algorithm.
 *
-* Obsidian seems to treat note links slightly differently from image / asset links.
+* Obsidian seems to treat note links slightly differently from image / asset
+* links.
+*
 * @param name Non-URI-encoded name of the file, may have file extension, if no
-* match with a non-.md extension is found, a match will be attempted with .md
-* regardless. (POSIX-style paths.)
+*   match with a non-.md extension is found, a match will be attempted with .md
+*   regardless. (POSIX-style paths.)
 * @param cwd Absolute path to the current working directory of the file from
-* which we're resolving the link. (POSIX-style paths)
+*   which we're resolving the link. (POSIX-style paths)
 * @param allFilePaths Array of absolute paths to all other files in the paths
-* to be considered. (POSIX-style paths.)
+*   to be considered. (POSIX-style paths.)
+*
 * @returns Absolute path to the best matching file with the name provided, or
-* undefined if there's no valid match. (POSIX-style paths.)
+*   undefined if there's no valid match. (POSIX-style paths.)
 */
 function resolveNameLink(name, cwd, allFilePaths) {
 	if (allFilePaths.length === 0) return;
@@ -1729,10 +1867,13 @@ function resolveNameLink(name, cwd, allFilePaths) {
 /**
 * Check for presence of a path in a list in a case- and query- agnostic manner.
 * Ignores .md extensions to simplify matching files
+*
 * @param filePath File path with file extension. (POSIX-style path.)
-* @param allFilePaths Array of absolute file paths to check. (POSIX-style paths.)
+* @param allFilePaths Array of absolute file paths to check. (POSIX-style
+*   paths.)
+*
 * @returns The file path if it is present in the list of all file paths, or
-* undefined if it is not.
+*   undefined if it is not.
 */
 function pathExistsInAllFiles(filePath, allFilePaths) {
 	const base = getBase(filePath);
@@ -1941,9 +2082,9 @@ function wikiBasic() {
 			return insideLabel;
 		}
 		/**
-		* When encountering a right square bracket, we must look ahead at the next character
-		* to determine whether it indicates the end of the [[wikilink]] or is
-		* simply part of the label text.
+		* When encountering a right square bracket, we must look ahead at the next
+		* character to determine whether it indicates the end of the [[wikilink]]
+		* or is simply part of the label text.
 		*/
 		function lookaheadClosingMarker(code) {
 			if (code !== 93) return nok(code);
@@ -2061,12 +2202,12 @@ function wikiBasic() {
 *
 * Obsidian also supports wiki links in Markdown-style image and link syntax, so
 * handling resolution here would miss those cases, so:
+*
 * - Resolution of wiki link into absolute paths happens later in
 *   remark-resolve-links.ts
 * - Parsing of Obsidian-style image size from alias / alt text happens later in
 *   rehype-utilities.ts
 *
-*
 * Note that only wiki links support spaces in the src, regular markdown links
 * MUST be URI-encoded in the Markdown source Here, we URI-encode for
 * consistency with the regular image syntax in the resulting HAST `<>` escaped
@@ -2471,29 +2612,29 @@ async function loadLocalNotes(allLocalFilePaths, options) {
 }
 const defaultDeckNamesFromFilePathsOptions = { mode: "common-root" };
 /**
-* Helper function to infer deck names from file paths if `deckName` not defined in the note's frontmatter.
+* Helper function to infer deck names from file paths if `deckName` not defined
+* in the note's frontmatter.
 *
 * `deckName` will always override the inferred deck name.
 *
 * Depends on the context of _all_ file paths passed to `syncNoteFiles`.
 *
-* Example of paths -> deck names with `common-root`:
-* /base/foo/note.md -> foo
+* Example of paths -> deck names with `common-root`: /base/foo/note.md -> foo
 * /base/foo/baz/note.md -> foo::baz
 *
-* Example of paths -> deck names with `common-root`:
-* /base/foo/note.md -> foo
+* Example of paths -> deck names with `common-root`: /base/foo/note.md -> foo
 * /base/foo/note.md -> foo
 *
-* Example of paths -> deck names with `common-parent`:
-* /base/foo/note.md -> base::foo
-* /base/foo/baz/note.md -> base::foo::baz
+* Example of paths -> deck names with `common-parent`: /base/foo/note.md ->
+* base::foo /base/foo/baz/note.md -> base::foo::baz
 *
-* Example of paths -> deck names with `common-parent`:
+* Example of paths -> deck names with `common-parent`: /base/foo/note.md -> foo
 * /base/foo/note.md -> foo
-* /base/foo/note.md -> foo
-* @param absoluteFilePaths Absolute paths to all markdown Anki note files. (Ensures proper resolution if path module is polyfilled.)
-* @returns array of ::-delimited deck paths
+*
+* @param absoluteFilePaths Absolute paths to all markdown Anki note files.
+*   (Ensures proper resolution if path module is polyfilled.)
+*
+* @returns Array of ::-delimited deck paths
 */
 function getDeckNamesFromFilePaths(absoluteFilePaths, options) {
 	const { mode } = deepmerge(defaultDeckNamesFromFilePathsOptions, options ?? {});
@@ -2638,13 +2779,14 @@ const NEWLINE_REGEX = /\r?\n/;
 *
 * Used when a noteId is received from Anki after creating a note.
 *
-*
 * String manipulation is ugly, but it ensures that the markdown format is
 * preserved verbatim. Running it through the unified AST and then
 * remarkStringify would possibly change the format.
+*
 * @param markdown Raw markdown string with frontmatter.
-* @param noteId  The value to set the noteId to. If undefined, the noteId will
-* be removed from the frontmatter. (Useful for testing.)
+* @param noteId The value to set the noteId to. If undefined, the noteId will
+*   be removed from the frontmatter. (Useful for testing.)
+*
 * @returns Raw markdown string with updated frontmatter.
 */
 async function setNoteIdInFrontmatter(markdown, noteId) {
@@ -2688,9 +2830,11 @@ function getFrontmatterRange(markdown) {
 const defaultSyncNotesOptions = { ...defaultGlobalOptions };
 /**
 * Syncs local notes to Anki.
+*
 * @param allLocalNotes All the YankiNotes to sync
+*
 * @returns The synced notes (with new IDs where applicable), plus some stats
-* about the sync
+*   about the sync
 * @throws {Error} For various reasons...
 */
 async function syncNotes(allLocalNotes, options) {
@@ -2819,9 +2963,11 @@ const defaultSyncFilesOptions = {
 *
 * Most importantly, it updates the note IDs in the frontmatter of the local
 * files.
+*
 * @param allLocalFilePaths Array of paths to the local markdown files
+*
 * @returns The synced files (with new IDs where applicable), plus some stats
-* about the sync
+*   about the sync
 * @throws {Error} If syncing fails or file operations encounter an error.
 */
 async function syncFiles(allLocalFilePaths, options) {