JSPM

  • Created
  • Published
  • Downloads 3175
  • Score
    100M100P100Q116461F

Small JavaScript library for replacing string literals, regular expressions and comments in syntax of JavaScript.

Package Exports

  • escaper

This package does not declare an exports field, so the exports above have been automatically detected and optimized by JSPM instead. If any package subpath is missing, it is recommended to post an issue to the original package (escaper) to support the "exports" field. If that is not possible, create a JSPM override to customize the exports field for this package.

Readme

Escaper

Escaper is a small JavaScript library for replacing string literals, regular expressions and comments in syntax of JavaScript.

Russian documentation

NPM version NPM dependencies NPM devDependencies Build Status Coverage Status

Supported:

  • ' ... '
  • " ... "
  • ` ... `, ` ... ${...} `
  • / ... /
  • // ...
  • /* ... */, /** ... */, /*! ... */

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

var str = '"foo" 1 + /foo/ + 2 /* 1 */ 3',
    content = [];

// __ESCAPER_QUOT__0_ 1 + __ESCAPER_QUOT__1_ + 2 __ESCAPER_QUOT__2_ 3
str = Escaper.replace(str, true, content);

// "foo" 1 + /foo/ + 2 /* 1 */ 3
Escaper.paste(str, content);

API

Escaper.replace(str, opt_withComment, opt_quotContent)

The method replaces all found blocks ' ... ', " ... ", ` ... `, / ... /, // ..., /* ... */ to __ESCAPER_QUOT__number_ in a specified string and returns result.

Arguments

  • string str — a source string
  • (Object|boolean)= opt_withCommentsOrParams = false — parameters:
{
    '@all'     : true, // Replaces all matches
    '@comments': true, // Replaces all kinds of comments
    '@strings' : true, // Replaces all kinds of string literals
    '@literals': true, // Replaces all kinds of string literals
                       // and regular expressions

    "'"        : true,
    '"'        : true,
    '`'        : true,
    '/'        : true,
    '//'       : true,
    '/*'       : true,
    '/**'      : true,
    '/*!'      : true
}

If a value of parameter is set to -1, then all found matches will be removed from a final string, or if the value will be set to true/false they will be included/excluded.

If parameter opt_withCommentsOrParams is boolean:

true  // Replaces all matches
false // Replaces all kinds of string literals and regular expressions
  • Array= opt_quotContent = Escaper.quotContent — stack of content

@return {string}

Escaper.paste(str, opt_quotContent)

The method replaces all found blocks __ESCAPER_QUOT__number_ to real content in a specified string and returns result.

Arguments

  • string str — source string
  • Array= opt_quotContent = Escaper.quotContent — stack of content

@return {string}

License

The MIT License.