web-dev-qa-db-fra.com

Chaîne d'échappement à utiliser dans une expression rationnelle Javascript

Duplicate possible:
Existe-t-il une fonction RegExp.escape dans Javascript?

J'essaie de créer une expression rationnelle javascript à partir des entrées de l'utilisateur:

 function FindString (input) {
 var reg = new RegExp ('' + input + ''); 
 // [snip] effectuer une recherche 
} 

Mais l'expression régulière ne fonctionnera pas correctement si l'entrée utilisateur contient un ? ou *, car ils sont interprétés comme des expressions spéciales spéciales. En fait, si l'utilisateur met un ( ou [ non équilibré dans sa chaîne, l'expression régulière n'est même pas valide.

Quelle est la fonction javascript pour échapper correctement à tous les caractères spéciaux pour une utilisation dans regex?

448
too much php

Short 'n Sweet

function escapeRegExp(string) {
  return string.replace(/[.*+?^${}()|[\]\\]/g, '\\$&'); // $& means the whole matched string
}

Exemple

escapeRegExp("All of these should be escaped: \ ^ $ * + ? . ( ) | { } [ ]");

>>> "All of these should be escaped: \\ \^ \$ \* \+ \? \. \( \) \| \{ \} \[ \] "

Installer

Disponible sur npm en tant que escape-string-regexp

npm install --save escape-string-regexp

Remarque

Voir MDN: Guide de Javascript: Expressions régulières

D'autres symboles (~ `!! # # ...) PEUVENT être évités sans conséquence, mais ne sont pas obligés de l'être.

.

.

.

.

Cas de test: une URL typique

escapeRegExp("/path/to/resource.html?search=query");

>>> "\/path\/to\/resource\.html\?search=query"

La longue réponse

Si vous envisagez d'utiliser la fonction ci-dessus, créez au moins un lien vers ce message de débordement de pile dans la documentation de votre code, de sorte qu'il ne ressemble pas à un voodoo difficile à tester.

var escapeRegExp;

(function () {
  // Referring to the table here:
  // https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/regexp
  // these characters should be escaped
  // \ ^ $ * + ? . ( ) | { } [ ]
  // These characters only have special meaning inside of brackets
  // they do not need to be escaped, but they MAY be escaped
  // without any adverse effects (to the best of my knowledge and casual testing)
  // : ! , = 
  // my test "~!@#$%^&*(){}[]`/=?+\|-_;:'\",<.>".match(/[\#]/g)

  var specials = [
        // order matters for these
          "-"
        , "["
        , "]"
        // order doesn't matter for any of these
        , "/"
        , "{"
        , "}"
        , "("
        , ")"
        , "*"
        , "+"
        , "?"
        , "."
        , "\\"
        , "^"
        , "$"
        , "|"
      ]

      // I choose to escape every character with '\'
      // even though only some strictly require it when inside of []
    , regex = RegExp('[' + specials.join('\\') + ']', 'g')
    ;

  escapeRegExp = function (str) {
    return str.replace(regex, "\\$&");
  };

  // test escapeRegExp("/path/to/res?search=this.that")
}());
928
CoolAJ86