Gibt es eine RegExp.escape Funktion in JavaScript?

Question

Ich möchte einfach einen regulären Ausdruck aus jedem möglichen String erstellen.

var usersString = "Hello?!*`~World()[]";
var expression = new RegExp(RegExp.escape(usersString))
var matches = "Hello".match(expression);

Gibt es dafür eine integrierte Methode? Wenn nicht, was verwenden die Leute? Ruby hat RegExp.escape. Ich habe nicht das Gefühl, dass ich meinen eigenen schreiben muss, es muss doch etwas Standardmäßiges geben.

Answer 1

Die in einer anderen Antwort verlinkte Funktion ist unzureichend. Sie versäumt es, ^ oder $ (Anfang und Ende eines Strings) oder - zu escapen, was in einer Zeichenklasse für Bereiche verwendet wird.

Verwenden Sie diese Funktion:

function escapeRegex(string) {
    return string.replace(/[/\-\\^$*+?.()|[\]{}]/g, '\\$&');
}

Auf den ersten Blick mag es unnötig erscheinen, - (sowie ^) zu escapen, aber dies macht die Funktion geeignet, um Zeichen für die Einfügung in eine Zeichenklasse sowie den Körper des Regex zu escapen.

Das Escapen von / macht die Funktion geeignet, um Zeichen zu escapen, die in einem JavaScript Regex-Literal für spätere Auswertung verwendet werden sollen.

Da es keinen Nachteil gibt, eines von beiden zu escapen, macht es Sinn, zu escapen, um breitere Anwendungsfälle abzudecken.

Und ja, es ist enttäuschend, dass dies nicht Teil von Standard-JavaScript ist.

Answer 2

Für alle, die Lodash verwenden, ist seit Version v3.0.0 eine _.escapeRegExp Funktion integriert:

_.escapeRegExp('[lodash](https://lodash.com/)');
//  '\[lodash\]\(https:\/\/lodash\.com\/\)'

Und für den Fall, dass Sie nicht die gesamte Lodash-Bibliothek benötigen, können Sie nur diese Funktion requiren!

Answer 3

Die meisten Ausdrücke hier lösen spezifische Einzelfälle.

Das ist in Ordnung, aber ich bevorzuge einen Ansatz, der "immer funktioniert".

function regExpEscape(literal_string) {
    return literal_string.replace(/[-[\]{}()*+!<=:?.\/\\^$|#\s,]/g, '\\$&');
}

Dies wird einen literalen String für folgende Verwendungen in regulären Ausdrücken "vollständig escapen":

• Einfügen in einen regulären Ausdruck. z.B. new RegExp(regExpEscape(str))
• Einfügen in eine Zeichenklasse. z.B. new RegExp('[' + regExpEscape(str) + ']')
• Einfügen in einen Integer-Zähl-Spezifikator. z.B. new RegExp('x{1,' + regExpEscape(str) + '}')
• Ausführung in nicht-JavaScript-regulären Ausdrucks-Engines.

Behandelte Sonderzeichen:

• -: Erzeugt ein Zeichenbereich in einer Zeichenklasse.
• [ / ]: Startet / beendet eine Zeichenklasse.
• { / }: Startet / beendet einen Nummerierungsspezifikator.
• ( / ): Startet / beendet eine Gruppe.
• * / + / ?: Spezifiziert den Wiederholungstyp.
• .: Passt auf jedes Zeichen.
• \: Escapiert Zeichen und startet Entitäten.
• ^: Spezifiziert den Start des Übereinstimmungsbereichs und negiert das Matchen in einer Zeichenklasse.
• $: Spezifiziert das Ende des Übereinstimmungsbereichs.
• |: Spezifiziert Alternation.
• #: Spezifiziert einen Kommentar im free-spacing-Modus.
• \s: Im free-spacing-Modus ignoriert.
• ,: Trennt Werte im Nummerierungsspezifikator.
• /: Startet oder beendet den Ausdruck.
• :: Vollendet spezielle Gruppentypen und Teil von Perl-style Zeichenklassen.
• !: Negiert Nullbreiten-Gruppe.
• < / =: Teil der Nullbreiten-Gruppenspezifikationen.

Anmerkungen:

• / ist in keiner Variante eines regulären Ausdrucks strikt notwendig. Es schützt jedoch, falls jemand (schauder) dies tut: eval("/" + pattern + "/");.
• , stellt sicher, dass, wenn der String integer im numerischen Spezifikator sein soll, es richtig einen RegExp-Kompilierungsfehler verursacht anstatt stillschweigend falsch zu kompilieren.
• # und \s müssen in JavaScript nicht escapet werden, aber in vielen anderen Varianten schon. Sie sind hier escapet, falls der reguläre Ausdruck später an ein anderes Programm übergeben wird.

---

Wenn Sie den regulären Ausdruck auch gegen potenzielle Ergänzungen der JavaScript-Regex-Engine-Funktionen zukunftssicher machen möchten, empfehle ich die sicherere Variante:

function regExpEscapeFuture(literal_string) {
    return literal_string.replace(/[^A-Za-z0-9_]/g, '\\$&');
}

Diese Funktion escapet jedes Zeichen, außer denen, die explizit garantiert nicht für die Syntax in zukünftigen regulären Ausdrucksvarianten verwendet werden.

---

Für diejenigen, die wirklich auf Reinlichkeit bedacht sind, erwägen Sie diesen Spezialfall:

var s = '';
new RegExp('(choice1|choice2|' + regExpEscape(s) + ')');

Dies sollte in JavaScript gut kompilieren, aber in einigen anderen Varianten nicht. Wenn die Absicht besteht, es an eine andere Variante weiterzugeben, sollte der Nullfall von s === '' unabhängig überprüft werden, wie folgt:

var s = '';
new RegExp('(choice1|choice2' + (s ? '|' + regExpEscape(s) : '') + ')');

Answer 4

Leitfaden des Mozilla Developer Network zu regulären Ausdrücken bietet diese Escaping-Funktion an:

function escapeRegExp(string) {
  return string.replace(/[.*+?^${}()|[\]\\]/g, '\\$&'); // $& bedeutet den gesamten übereinstimmenden String
}

Answer 5

Im Autocomplete-Widget von jQuery UI (Version 1.9.1) wird eine leicht abweichende reguläre Ausdruck verwendet (Zeile 6753), hier ist der reguläre Ausdruck in Kombination mit bobinces Ansatz.

RegExp.escape = function( value ) {
     return value.replace(/[\-\[\]{}()*+?.,\\\^$|#\s]/g, "\\$&");
}