7456c152b7
* escape inline markdown character * fix typo * improve document around custom markdown plugin and add escape sequence utils * recover inline escape sequences on edit * remove escape sequences from plain text body * use `s` for strike-through instead of del * escape block markdown sequences * fix remove escape sequence was not removing all slashes from plain text * recover block sequences on edit
62 lines
2.4 KiB
TypeScript
62 lines
2.4 KiB
TypeScript
/**
|
|
* @typedef {RegExpMatchArray | RegExpExecArray} MatchResult
|
|
*
|
|
* Represents the result of a regular expression match.
|
|
* This type can be either a `RegExpMatchArray` or a `RegExpExecArray`,
|
|
* which are returned when performing a match with a regular expression.
|
|
*
|
|
* @see {@link https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/RegExp/exec}
|
|
* @see {@link https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String/match}
|
|
*/
|
|
export type MatchResult = RegExpMatchArray | RegExpExecArray;
|
|
|
|
/**
|
|
* @typedef {function(string): MatchResult | null} MatchRule
|
|
*
|
|
* A function type that takes a string and returns a `MatchResult` or `null` if no match is found.
|
|
*
|
|
* @param {string} text The string to match against.
|
|
* @returns {MatchResult | null} The result of the regular expression match, or `null` if no match is found.
|
|
*/
|
|
export type MatchRule = (text: string) => MatchResult | null;
|
|
|
|
/**
|
|
* Returns the part of the text before a match.
|
|
*
|
|
* @param text - The input text string.
|
|
* @param match - The match result (e.g., `RegExpMatchArray` or `RegExpExecArray`).
|
|
* @returns A string containing the part of the text before the match.
|
|
*/
|
|
export const beforeMatch = (text: string, match: RegExpMatchArray | RegExpExecArray): string =>
|
|
text.slice(0, match.index);
|
|
|
|
/**
|
|
* Returns the part of the text after a match.
|
|
*
|
|
* @param text - The input text string.
|
|
* @param match - The match result (e.g., `RegExpMatchArray` or `RegExpExecArray`).
|
|
* @returns A string containing the part of the text after the match.
|
|
*/
|
|
export const afterMatch = (text: string, match: RegExpMatchArray | RegExpExecArray): string =>
|
|
text.slice((match.index ?? 0) + match[0].length);
|
|
|
|
/**
|
|
* Replaces a match in the text with a content.
|
|
*
|
|
* @param text - The input text string.
|
|
* @param match - The match result (e.g., `RegExpMatchArray` or `RegExpExecArray`).
|
|
* @param content - The content to replace the match with.
|
|
* @param processPart - A function to further process remaining parts of the text.
|
|
* @returns An array containing the processed parts of the text, including the content.
|
|
*/
|
|
export const replaceMatch = <C>(
|
|
text: string,
|
|
match: MatchResult,
|
|
content: C,
|
|
processPart: (txt: string) => Array<string | C>
|
|
): Array<string | C> => [
|
|
...processPart(beforeMatch(text, match)),
|
|
content,
|
|
...processPart(afterMatch(text, match)),
|
|
];
|