From 5ec61468d5e787b3c8ae32a2b4ef1595cf0bc3ee Mon Sep 17 00:00:00 2001
From: Emile Bangma <ewjbangma@hotmail.com>
Date: Sun, 31 Mar 2024 16:44:50 +0000
Subject: [PATCH] fix(wikilinks): proper escaping of pipe character in wikilinks inside tables (#1040)
---
quartz/plugins/transformers/ofm.ts | 47 ++++++++++++++++++++++++++++++++++-------------
1 files changed, 34 insertions(+), 13 deletions(-)
diff --git a/quartz/plugins/transformers/ofm.ts b/quartz/plugins/transformers/ofm.ts
index 4091960..108f7f7 100644
--- a/quartz/plugins/transformers/ofm.ts
+++ b/quartz/plugins/transformers/ofm.ts
@@ -99,15 +99,27 @@
export const arrowRegex = new RegExp(/(-{1,2}>|={1,2}>|<-{1,2}|<={1,2})/, "g")
-// !? -> optional embedding
-// \[\[ -> open brace
-// ([^\[\]\|\#]+) -> one or more non-special characters ([,],|, or #) (name)
-// (#[^\[\]\|\#]+)? -> # then one or more non-special characters (heading link)
-// (\|[^\[\]\#]+)? -> \| then one or more non-special characters (alias)
+// !? -> optional embedding
+// \[\[ -> open brace
+// ([^\[\]\|\#]+) -> one or more non-special characters ([,],|, or #) (name)
+// (#[^\[\]\|\#]+)? -> # then one or more non-special characters (heading link)
+// (\\?\|[^\[\]\#]+)? -> optional escape \ then | then one or more non-special characters (alias)
export const wikilinkRegex = new RegExp(
/!?\[\[([^\[\]\|\#\\]+)?(#+[^\[\]\|\#\\]+)?(\\?\|[^\[\]\#]+)?\]\]/,
"g",
)
+
+// ^\|([^\n])+\|\n(\|) -> matches the header row
+// ( ?:?-{3,}:? ?\|)+ -> matches the header row separator
+// (\|([^\n])+\|\n)+ -> matches the body rows
+export const tableRegex = new RegExp(
+ /^\|([^\n])+\|\n(\|)( ?:?-{3,}:? ?\|)+\n(\|([^\n])+\|\n?)+/,
+ "gm",
+)
+
+// matches any wikilink, only used for escaping wikilinks inside tables
+export const tableWikilinkRegex = new RegExp(/(!?\[\[[^\]]*?\]\])/, "g")
+
const highlightRegex = new RegExp(/==([^=]+)==/, "g")
const commentRegex = new RegExp(/%%[\s\S]*?%%/, "g")
// from https://github.com/escwxyz/remark-obsidian-callout/blob/main/src/index.ts
@@ -169,6 +181,21 @@
src = src.toString()
}
+ // replace all wikilinks inside a table first
+ src = src.replace(tableRegex, (value) => {
+ // escape all aliases and headers in wikilinks inside a table
+ return value.replace(tableWikilinkRegex, (value, ...capture) => {
+ const [raw]: (string | undefined)[] = capture
+ let escaped = raw ?? ""
+ escaped = escaped.replace("#", "\\#")
+ // escape pipe characters if they are not already escaped
+ escaped = escaped.replace(/((^|[^\\])(\\\\)*)\|/g, "$1\\|")
+
+ return escaped
+ })
+ })
+
+ // replace all other wikilinks
src = src.replace(wikilinkRegex, (value, ...capture) => {
const [rawFp, rawHeader, rawAlias]: (string | undefined)[] = capture
@@ -176,27 +203,21 @@
const anchor = rawHeader?.trim().replace(/^#+/, "")
const blockRef = Boolean(anchor?.startsWith("^")) ? "^" : ""
const displayAnchor = anchor ? `#${blockRef}${slugAnchor(anchor)}` : ""
- let displayAlias = rawAlias ?? rawHeader?.replace("#", "|") ?? ""
+ const displayAlias = rawAlias ?? rawHeader?.replace("#", "|") ?? ""
const embedDisplay = value.startsWith("!") ? "!" : ""
if (rawFp?.match(externalLinkRegex)) {
return `${embedDisplay}[${displayAlias.replace(/^\|/, "")}](${rawFp})`
}
- //transform `[[note#^block_ref|^block_ref]]` to `[[note#^block_ref\|^block_ref]]`, display correctly in table.
- if (displayAlias && displayAlias.startsWith("|")) {
- displayAlias = `\\${displayAlias}`
- }
-
return `${embedDisplay}[[${fp}${displayAnchor}${displayAlias}]]`
})
}
return src
},
- markdownPlugins(ctx) {
+ markdownPlugins(_ctx) {
const plugins: PluggableList = []
- const cfg = ctx.cfg.configuration
// regex replacements
plugins.push(() => {
--
Gitblit v1.10.0