Handle escaped separators in split()

src/plugins/props/types/map.js

@@ -1,8 +1,7 @@
 import PropType from "../util/PropType.js";
+import { split } from "../util/split.js";
 import Iterable from "./iterable.js";
 
-const entrySplitter = /(?<!\\):/;
-
 /**
  * Concrete type for `Map`, which also serves as the canonical dictionary in
  * JS. Extends {@link Iterable}: reuses the parent's `parseItems` to grab
@@ -37,7 +36,7 @@ const MapType = PropType.register({
 		for (let item of this.parseItems(value)) {
 			let k, v;
 			if (typeof item === "string") {
-				let parts = item.split(entrySplitter);
+				let parts = [...split(item, { separator: ":" })];
 				if (parts.length >= 2) {
 					k = parts.shift();
 					v = parts.join(":");

src/plugins/props/util/split.js

@@ -15,10 +15,14 @@ function regexEscape (string) {
 	return string.replace(/[-/\\^$*+?.()|[\]{}]/g, "\\$&");
 }
 
+function unescapeSeparator (value, separator) {
+	return separator ? value.replaceAll(`\\${separator}`, separator) : value;
+}
+
 /**
  * Split a value by a separator, respecting pairs (parens, strings, etc.) but
- * failing back gracefully for malformed input. Yields each top-level part as
- * a trimmed string.
+ * failing back gracefully for malformed input. The separator can be escaped
+ * with a backslash. Yields each top-level part as a trimmed string.
  *
  * @param {string} value
  * @param {object} [options]
@@ -34,7 +38,7 @@ export function* split (value, { separator = ",", pairs = defaultPairs } = {}) {
 	let isSeparatorWhitespace = !separator;
 	let separatorRegex = isSeparatorWhitespace
 		? /\s+/g
-		: RegExp(regexEscape(separator).replace(/^\s*|\s*$/g, "\\s*"), "g");
+		: RegExp(`(?<!\\\\)${regexEscape(separator).replace(/^\s*|\s*$/g, "\\s*")}`, "g");
 
 	let pairStrings = new Set([
 		...Object.keys(pairs.nest),
@@ -46,7 +50,10 @@ export function* split (value, { separator = ",", pairs = defaultPairs } = {}) {
 
 	if (!pairRegex.test(value)) {
 		// value contains no pairs, just split
-		yield* value.trim().split(separatorRegex);
+		yield* value
+			.trim()
+			.split(separatorRegex)
+			.map(p => unescapeSeparator(p, separator));
 		return;
 	}
 
@@ -72,7 +79,7 @@ export function* split (value, { separator = ",", pairs = defaultPairs } = {}) {
 		}
 		else if (matched.trim() === separator) {
 			if (stack.length === 0) {
-				yield value.slice(lastIndex, index).trim();
+				yield unescapeSeparator(value.slice(lastIndex, index).trim(), separator);
 				lastIndex = index + matched.length;
 			}
 		}
@@ -98,6 +105,6 @@ export function* split (value, { separator = ",", pairs = defaultPairs } = {}) {
 	}
 
 	if (lastIndex < value.length) {
-		yield value.slice(lastIndex).trim();
+		yield unescapeSeparator(value.slice(lastIndex).trim(), separator);
 	}
 }

test/split.js

@@ -50,5 +50,20 @@ export default {
 			arg: `a ", b, c`,
 			expect: [`a "`, "b", "c"],
 		},
+		{
+			name: "Escaped separator",
+			tests: [
+				{
+					name: "Default",
+					arg: "a\\, b, c",
+					expect: ["a, b", "c"],
+				},
+				{
+					name: "Custom",
+					args: ["foo\\:bar: baz", { separator: ":" }],
+					expect: ["foo:bar", "baz"],
+				},
+			],
+		},
 	],
 };