Files
tiptap/packages/suggestion/src/findSuggestionMatch.ts
Ricardo Amaral 482cb960d6 feat: Allow multiple prefix characters to trigger a suggestion (#2896)
* feat: Allow multiple prefix characters to trigger a suggestion

* review: Turn `allowedPrefixes` into an array instead
2022-06-21 23:17:26 +02:00

81 lines
2.1 KiB
TypeScript

import { escapeForRegEx, Range } from '@tiptap/core'
import { ResolvedPos } from 'prosemirror-model'
export interface Trigger {
char: string,
allowSpaces: boolean,
allowedPrefixes: string[] | null,
startOfLine: boolean,
$position: ResolvedPos,
}
export type SuggestionMatch = {
range: Range,
query: string,
text: string,
} | null
export function findSuggestionMatch(config: Trigger): SuggestionMatch {
const {
char,
allowSpaces,
allowedPrefixes,
startOfLine,
$position,
} = config
const escapedChar = escapeForRegEx(char)
const suffix = new RegExp(`\\s${escapedChar}$`)
const prefix = startOfLine ? '^' : ''
const regexp = allowSpaces
? new RegExp(`${prefix}${escapedChar}.*?(?=\\s${escapedChar}|$)`, 'gm')
: new RegExp(`${prefix}(?:^)?${escapedChar}[^\\s${escapedChar}]*`, 'gm')
const text = $position.nodeBefore?.isText && $position.nodeBefore.text
if (!text) {
return null
}
const textFrom = $position.pos - text.length
const match = Array.from(text.matchAll(regexp)).pop()
if (!match || match.input === undefined || match.index === undefined) {
return null
}
// JavaScript doesn't have lookbehinds. This hacks a check that first character
// is a space or the start of the line
const matchPrefix = match.input.slice(Math.max(0, match.index - 1), match.index)
const matchPrefixIsAllowed = new RegExp(`^[${allowedPrefixes?.join('')}\0]?$`).test(matchPrefix)
if (allowedPrefixes !== null && !matchPrefixIsAllowed) {
return null
}
// The absolute position of the match in the document
const from = textFrom + match.index
let to = from + match[0].length
// Edge case handling; if spaces are allowed and we're directly in between
// two triggers
if (allowSpaces && suffix.test(text.slice(to - 1, to + 1))) {
match[0] += ' '
to += 1
}
// If the $position is located within the matched substring, return that range
if (from < $position.pos && to >= $position.pos) {
return {
range: {
from,
to,
},
query: match[0].slice(char.length),
text: match[0],
}
}
return null
}