Zum Inhalt springen
FrAIFlow

Lösungen / Text & Code

Warum Dollarzeichen Ihren JavaScript-Ersetzungstext verändern

Ein Suchen-und-Ersetzen-Werkzeug verändert den Ersetzungstext selbst. Selbst bei einer Suche nach einer einfachen Zeichenfolge interpretiert JavaScript Dollar-Sequenzen im Ersetzungsargument. Soll der Text wörtlich eingefügt werden, geben Sie ihn aus einer Funktion zurück.

Ein Wert, zwei Interpretationen
Eigene Erklärung auf Grundlage des erhaltenen Beispiels, kein Screenshot einer Anwendung.

Ersetzungsvorlagen erkennen, bevor Sie die Eingabe ändern

Stellen Sie sich vor, ein Platzhalter soll durch eine Preisbeschreibung ersetzt werden, die $& enthält. Der Nutzer erwartet diese zwei Zeichen, doch stattdessen erscheint wieder der alte Platzhalter. Das muss kein Kodierungsproblem sein. Das Ersetzungsargument besitzt eine eigene kleine Vorlagensprache, auch wenn die Suche eine normale Zeichenfolge statt eines regulären Ausdrucks verwendet.

Beginnen Sie mit einer Textkopie und einem Treffer. Ändert sich eine Dollar-Sequenz, ersetzen Sie das Ersetzungsargument durch einen Callback und vergleichen Sie die Ergebnisse. Lassen Sie die Suche dabei unverändert. Wenn Sie beide Eingaben gleichzeitig ändern, ist schwerer zu erkennen, welche Regel die Überraschung verursacht hat.

Ein öffentlicher Bericht von 2012 ersetzte eine ganze Zeichenfolge durch $' und erhielt ein leeres Ergebnis. Dieses Token steht für den Text nach dem Treffer. Da der Treffer alles umfasste, gab es keinen solchen Rest.

const input = "as";
const replacement = "$'";
input.replace("as", replacement);       // ""
input.replace("as", () => replacement); // "$'"

Der erhaltene Test unter Node.js v24.19.0 reproduzierte beide Ergebnisse. Weitere Ersetzungstokens sind $$ für ein Dollarzeichen, $& für den Treffer und Gruppenverweise wie $1, sofern das Muster die betreffende Gruppe enthält. Es gibt außerdem Formen für den Text vor dem Treffer und benannte Gruppen. Nicht jedes einzelne Dollarzeichen hat eine besondere Bedeutung.

Zwei Modi klar auseinanderhalten
Eigene Erklärung auf Grundlage des erhaltenen Beispiels, kein Screenshot einer Anwendung.

Verwenden Sie einen Callback für wörtlichen Ersetzungstext

const draft = "Price: TOKEN. Repeat: TOKEN.";
const typedReplacement = "$& costs $$";

console.log(draft.replaceAll("TOKEN", typedReplacement));
// Price: TOKEN costs $. Repeat: TOKEN costs $.

console.log(draft.replaceAll("TOKEN", () => typedReplacement));
// Price: $& costs $$. Repeat: $& costs $$.

Im ersten Aufruf wird die Ersetzungszeichenfolge interpretiert. Im zweiten gibt die Funktion den wörtlichen Nutzerwert für jeden Treffer zurück. Dieser Rückgabewert wird ohne erneute Interpretation als Ersetzungsvorlage eingefügt. Das ist sinnvoll für Werkzeuge, die gewöhnliches Suchen und Ersetzen versprechen: Nutzer sollten keine besondere Dollar-Maskierung lernen müssen, nur um Text einzufügen.

Lösen Sie das Problem nicht, indem Sie aus der Nutzersuche automatisch einen regulären Ausdruck erzeugen. Eine Suche nach a.b soll im wörtlichen Modus normalerweise einen Punkt finden, nicht ein beliebiges Zeichen. Bieten Sie für RegEx-Gruppen und Ersetzungsvorlagen einen gesonderten, klar gekennzeichneten erweiterten Modus an. Eine Vorlage wie $1 ist dort nützlich und darf nicht plötzlich ohne Erklärung wörtlich behandelt werden.

Die Zeichenfolgenersetzung interpretiert Dollar-Tokens; der Callback erhält den eingegebenen Dollartext exakt.
Eigene Vorher-nachher-Erklärung des oben gezeigten künstlichen Node.js-Beispiels. Kein Texteditor-Screenshot. Öffnen Sie das Bild für Details in voller Größe.
function replaceLiteralOnce(text, search, value) {
  return text.replace(search, () => value);
}
function replaceLiteralAll(text, search, value) {
  if (search === "") throw new Error("Search must not be empty");
  return text.replaceAll(search, () => value);
}

Diese Hilfsfunktionen erwarten Zeichenfolgen, die von der Anwendung bereitgestellt werden. Die eine ersetzt den ersten Treffer, die andere alle Treffer. Nur replaceLiteralAll weist einen leeren Suchtext zurück, um Einfügungen zwischen Codeeinheiten zu verhindern. Bei einem leeren Suchtext fügt replaceLiteralOnce den Ersetzungstext am Anfang der Zeichenfolge ein. Unterstützt Ihr Produkt bewusst Gruppenvorlagen, erhalten und kennzeichnen Sie diesen Modus, statt seine Bedeutung stillschweigend zu ändern.

Zeigen Sie die vollständige Änderung im endgültigen Zusammenhang

Zeigen Sie Original und Ergebnis, besonders bei „Alle ersetzen“. Prüfen Sie Ersetzungen mit einem einzelnen Dollarzeichen, zwei Dollarzeichen, einem Treffertoken und einer leeren Zeichenfolge. Kontrollieren Sie auch den Fall ohne Treffer. Eine leere Ersetzung ist eine zulässige Löschung. Eine leere Suche benötigt dagegen eine ausdrückliche Produktentscheidung, weil sie an Positionen durch die ganze Zeichenfolge Text einfügen kann.

Prüfen Sie schließlich die Darstellung. Wörtlicher Text aus einem Ersetzungs-Callback ist dadurch noch kein sicheres HTML. Eine Vorschau sollte für nicht vertrauenswürdigen Text ein textarea-Element oder textContent verwenden, damit eingefügte Tags angezeigt statt ausgeführt werden. Speichern oder übertragen Sie erst, wenn die Vorschau der Absicht entspricht. Erhalten Sie für Sammeländerungen einen Weg zum Rückgängigmachen.

Die aufgezeichneten Testfälle erhielten $&, $', $$ und $1 exakt, wenn der Callback sie zurückgab. Nehmen Sie ähnliche Beispiele in Ihre Regressionstests auf, einschließlich wiederholter Treffer und leerer Ersetzungen. Bewahren Sie die Quelle auf und zeigen Sie Sammeländerungen vorab an.

Gemessene Ersetzung: Das Zeichenfolgenargument ergibt eine leere Ausgabe; die Funktion gibt Dollarzeichen und Apostroph wörtlich zurück.
Unveränderte ursprüngliche Erklärung.
Aufgezeichnete künstliche Testausgabe zu Dollarzeichen im JavaScript-Ersetzungstext
Aufgezeichnete Node.js-Ausgabe zur Zeichenfolgenersetzung mit wörtlichem Dollartext. Die Aufnahme zeigt gespeicherte Testausgaben, nicht die Anwendung aus dem ursprünglichen Nutzerbericht. Nachweisbild in voller Größe öffnen.

Quellen und weiterführende Informationen