Home / JavaScript / RegExp

Escape RegExp special characters

escape-string-regexp Escape RegExp special characters Install $ npm install --save escape-string-regexp Usage const escapeStringRegexp = require('escape-string-regexp'); const escapedString = esc
Information
Category: JavaScript / RegExp
Watchers: 13
Star: 561
Fork: 56
Last update: Nov 28, 2023
Resource links
https://github.com/sindresorhus/escape-string-regexp

escape-string-regexp Build Status

Escape RegExp special characters

Install

$ npm install escape-string-regexp

Usage

const escapeStringRegexp = require('escape-string-regexp');

const escapedString = escapeStringRegexp('How much $ for a 🦄?');
//=> 'How much \\$ for a 🦄\\?'

new RegExp(escapedString);

You can also use this to escape a string that is inserted into the middle of a regex, for example, into a character class.

Get professional support for this package with a Tidelift subscription
Tidelift helps make open source sustainable for maintainers while giving companies
assurances about security, maintenance, and licensing for their dependencies.
1 Open More issues
Closed

Escape "-", don't escape "}"

"-": this is a control within character sets. Escaping content for use within character sets is already fully supported except for this character, including escaping "]", which doesn't need escaping except within character sets.

"}": this isn't a control anywhere except within quantifiers. Within a quantifier, escaping this results in an invalid regex. escape-string-regexp doesn't, and can't possibly, support escaping strings meant for a quantifier context.

If you approve of the change, I'll make a PR.

opened Apr 17, 2016 by twhb 11
Closed

Hyphens in Unicode mode

With the current behavior of escaping -, there is a problem if used in a Unicode regex.

You can see that:

const esc = require('escape-string-regexp');
new RegExp(esc('-'), 'u');

gives:

Invalid regular expression: /-/: Invalid escape

because this does also:

new RegExp('\\-', 'u');

Would seem to call for a Unicode mode? (The hyphen would still need escaping (and be safe to use) within a character class though.)

I don't know whether you'd want to get into such parsing, but just sharing as it is something I came across.

bug help wanted 
opened Mar 12, 2020 by brettz9 10
Closed

Some more special characters..

MDN suggests to also include =, !, : and /. Those characters are used for conditional matching.

Their suggested pattern is /[.*+?^=!:${}()|\[\]\/\\]/g (find it below Table 4.1).

Maybe you would like to support those characters too.

opened Jul 14, 2014 by lrsjng 8
Closed

ignore Hyphens character

In some way, I just don't want escape the Hyphens character, how can I do that, in version 4.0.0 the Hyphens was escaped '-' => '\x2d'

opened Jul 24, 2020 by vndevil 6
Closed

Distributed code contains arrow function that breaks apps on IE11

Our app suddenly broke after updating from 1.0.5 to 2.0.0. Since transpilation normally does not happen on code in node_modules, this library was included as-is. Please include a es5 compatible version.

opened Jul 9, 2019 by ArthurClemens 5
Closed

escaping - in RegExp also better gitignore

opened Apr 21, 2015 by apolishch 5
Open

Forward slash is not escaped 

igornovikov1@~/Documents/Code/wtf-test:$ npm i escape-string-regexp
npm notice created a lockfile as package-lock.json. You should commit this file.
npm WARN [email protected] No description
npm WARN [email protected] No repository field.

+ [email protected]
added 1 package from 1 contributor and audited 1 package in 2.12s
found 0 vulnerabilities

igornovikov1@~/Documents/Code/wtf-test:$ node
> const escape = require('escape-string-regexp')
undefined
> escape ('^test/test$')
'\\^test/test\\$'
help wanted 
opened Sep 21, 2020 by septagram 5

v5.0.0(Apr 17, 2021)

Breaking

  • Require Node.js 12 aebb6e8
  • This package is now pure ESM. Please read this.

https://github.com/sindresorhus/escape-string-regexp/compare/v4.0.0...v5.0.0

v4.0.0(Apr 23, 2020)

Breaking

  • Escape - in a way that’s compatible with PCRE (#23) ec45c70 Shouldn't be breaking to most users, but if you depend on the exact output, it slightly changed.

https://github.com/sindresorhus/escape-string-regexp/compare/v3.0.0...v4.0.0

v3.0.0(Apr 7, 2020)

Breaking

  • Require Node.js 10 70deac5
  • Escape - in a way that’s compatible with Unicode patterns (#21) 732905d

https://github.com/sindresorhus/escape-string-regexp/compare/v2.0.0...v3.0.0

v2.0.0(Apr 17, 2019)

Breaking:

  • Require Node.js 8 (#13) ea98098

Enhancements:

  • Also escape - e76291d
  • Add TypeScript definition (#13) ea98098

https://github.com/sindresorhus/escape-string-regexp/compare/v1.0.5...v2.0.0

Contents

    taijiweb a regexp wrapper, less pain and more fun with regexp :)
    sindresorhus &🐐; Escape a string for use in HTML or the inverse
    lukeed A tiny (308B) utility that converts route patterns into RegExp. Limited alternative to `path-to-regexp` 🙇‍♂️
    mulle-nat ➿ mulle-c-string-escape turns data into C-strings
    lm2343635 Keyboard accessory to input the special text to a text field directly.
    gravityblast Sinatra inspired regexp/pattern mux and web framework for Go [NOT MAINTAINED]
    sindresorhus Find multiple RegExp matches in a string
    SamVerschueren Clean up regular expressions
    node-modules The regular expressions for China mobile phone number.
    hacksysteam Sandbox escape using WinHTTP Web Proxy Auto-Discovery Service
    max397574 Escape from insert mode without delay when typing
    unicode-org Last Resort Font is a special-purpose font that includes a collection of glyphs to represent types of Unicode characters.
    dlclark A full-featured regex engine in pure Go based on the .NET engine
    itchyny Go implementation of Regexp::Assemble
    antfu 📑 Transform texts with RegExp like a Pro.
    egoist A robust and light-weight path-to-regexp alternative
    sharkdp A command-line hex viewer
    io12 UNixize Filename -- replace annoying anti-unix characters in filenames
    Asynchronousx LPCE: A simple yet useful tool built to extract only the alphanumerical characters from a license plate image.
    ehmicky All the characters that work on most terminals and most operating systems
    mcy `boxy` - declarative box-drawing characters
    Share this repo

    Related Repos


    RegExp
    5
    LogRegex allows you to find patterns inside of logs
    theicfire LogRegex LogRegex allows you to find patterns inside of logs. Let's jump right into an example: import { FileHandler, LogRegex, Matcher } from "./inde
     
    RegExp
    3.1k
    Extended JavaScript regular expressions
    slevithan XRegExp 5.1.0 XRegExp provides augmented (and extensible) JavaScript regular expressions. You get modern syntax and flags beyond what browsers support
     
    RegExp
    2.9k
    Learn RegEx step by step, from zero to advanced.
    aykutkardas Learn RegEx step by step, from zero to advanced.
     
    RegExp
    4
    Jōyō kanji hyō (List of regular-use Han characters in Japan)
    mandel59 常用漢字表 常用漢字表（平成22年内閣告示第2号）のPDFから本表を抽出し、JSON形式に変換したものです。 著作権について 著作権法第十三条の二において、国が発する告示は、著作権法第二章の規定による権利の目的となることができない旨が定められています。 e-gov 法令検索 著作権法 データ抽出プロ
     
    RegExp
    3
    Make Regular Expressions More Exciting
    jennybc NOTE: This is a toy package created for expository purposes, for the second edition of R Packages. It is not meant to actually be useful. If you want
     
    RegExp
    14
    A DSL that translates to regex
    AbhinavOmprakash luna No more regrets, wield the power of regex with the readability of English with luna. About luna is a Domain specific language (DSL) that is reada
     
    RegExp
    13
    Add context awareness to your apps and frameworks by safely evaluating user-defined condit...
    jonschlinkert whence Add context awareness to your apps and frameworks by safely evaluating user-defined conditional expressions. Useful for evaluating expressions
     
    RegExp
    45
    A typescript library for type-safe regex for named capture groups
    phenax A typescript library for writing type-safe regular expressions using named capture groups.
     
    RegExp
    19
    A robust and light-weight path-to-regexp alternative
    egoist @egoist/path-parser This module is entirely extracted from vue-router, it's basically a light-weight version of path-to-regexp with path ranking suppo
     
    RegExp
    12
    A regular expression pattern for Java/JavaScript to match all emoji in the emoji-test.txt ...
    mathiasbynens emoji-test-regex-pattern emoji-test-regex-pattern offers Java- and JavaScript-compatible regular expression patterns to match all emoji symbols and se
     
    RegExp
    1.5k
    A curated collection of awesome Regex libraries, tools, frameworks and software
    aloisdg A curated collection of awesome Regex libraries, tools, frameworks and software
     
    RegExp
    12
    Cron UI: Input component to generate cron expressions easily and intuitively
    JossyDevers Cron Expression Input Description Cron Expression UI: Input component to generate cron expressions easily and intuitively, as in https://crontab.guru/
     
    RegExp
    433
    🦜 Super Expressive is a zero-dependency JavaScript library for building regular expressio...
    francisrstokes Super Expressive is a JavaScript library that allows you to build regular expressions in almost natural language - with no extra dependencies, and a lightweight code footprint (less than 3kb with minification + gzip!).
     
    RegExp
    166
    The magical sticky regex-based parser generator 🧙
    kitten The magical sticky regex-based parser generator 🧙
     
    RegExp
    4.3k
    The code for iHateregex.io 😈 - The Regex Cheat Sheet
    geongeorge iHateRegex 😈 don't just use; understand. iHateRegex.io - a regex cheatsheet for the haters. Chat with us on Telegram Features 😎 Visual representation of