Escaper
Escaper is a small JavaScript library for replacing string literals, regular expressions and comments in JavaScript syntax.
Russian documentation
Supports:
' ... '
" ... "
` ... `
, ` ... ${...} `
/ ... /
// ...
, //* ...
, //! ...
, //# ...
, //@ ...
, //$ ...
/* ... */
, /** ... */
, /*! ... */
, /*# ... */
, /*@ ... */
, /*$ ... */
Install
https://raw.githubusercontent.com/kobezzza/Escaper/master/dist/escaper.min.js
or
npm install escaper
or
bower install escaper
or
git clone https://github.com/kobezzza/Escaper
Usage
const
str = 'Hello "world" and \'friends\'',
content = [];
Escaper.replace(str, content)
Escaper.replace(str, ["'"])
Escaper.replace(str, -1)
Escaper.replace(str, {"'": -1})
Escaper.replace(str, {strings: false})
Escaper.replace(str, {strings: ["'"]})
Escaper.replace(str, {strings: {"'": -1}})
Escaper.paste(str, content);
API
Escaper.replace(str, how?, content?): string
Replaces all found blocks ' ... '
, " ... "
, ` ... `
, / ... /
, // ...
, /* ... */
to
escape blocks in a string and returns a new string.
Arguments
string
str
— source string;string[] | Record<string, string[] | Record<string, boolean | -1> | false | -1> | false | -1
how?
— parameters:
Possible values
If a value is set to -1
, then all found matches will be removed from the final string, or if the value will be set to
boolean
they will be included/excluded.
'label'
'singleComments'
'multComments'
'comments'
'strings'
'literals'
"'"
'"'
'`'
'/'
'//'
'//*'
'//!'
'//#'
'//@'
'//$'
'/*'
'/**'
'/*!'
'/*#'
'/*@'
'/*$'
Parameters can be specified as an array (escapes only explicitly specified sequences)
or like an object (disables/excludes by a literal or a group). Also, if you set the parameter value as -1
,
then all found sequences will be removed from the string.
string[]
content = Escaper.content
— array for matches.
Escaper.paste(str, content?, rgxp?): string
Replaces all found escape blocks to a real content in a string and returns a new string.
Arguments
string
str
— source string;string[]
content = Escaper.content
— array of matches;RegExp
rgxp?
— RegExp for searching, e.g. /__ESCAPER_QUOT__(\d+)_/g
.
The MIT License.