npmpackage.info

escaper

Small JavaScript library to replace string literals, regular expressions, and comments from JavaScript syntax.

3.0.6

MIT

JavaScript

Installations

npm install escaper

Pull Requests

Open

3

Total

26

Closed

0

Merged

23

Issues

Open

0

Total

2

Closed

2

Releases

Escaper v3.0.6

v3.0.6

Published on 05 Jul 2021

Escaper v3.0.5

v3.0.5

Published on 28 Oct 2018

Escaper v2.5.3

v2.5.3

Published on 25 Mar 2017

View all 3 releases

Developer

kobezzza

Developer Guide

BETA

Module System

CommonJS

Min. Node Version

Typescript Support

No

Node Version

14.15.1

NPM Version

6.14.8 Statistics

12 Stars

720 Commits

3 Watching

4 Branches

4 Contributors

Updated on 15 Dec 2022

Languages

JavaScript (98.51%)

HTML (1.49%)

Total Downloads

Cumulative downloads

Total Downloads

6,701,340

Last day

-67.7%

744

Compared to previous day

Last week

-21.8%

5,650

Compared to previous week

Last month

24.1%

23,543

Compared to previous month

Last year

-2.5%

219,558

Compared to previous year

Daily Downloads

Weekly Downloads

Monthly Downloads

Yearly Downloads

Versions

Escaper

Escaper is a small JavaScript library to replace string literals, regular expressions, and comments from the JavaScript syntax.

Russian documentation

Supports:

' ... '
" ... "
` ... `, ` ... ${...} `
/ ... /
// ..., //* ..., //! ..., //# ..., //@ ..., //$ ...
/* ... */, /** ... */, /*! ... */, /*# ... */, /*@ ... */, /*$ ... */

Install

https://raw.githubusercontent.com/kobezzza/Escaper/master/dist/escaper.min.js

1npm install escaper

1git clone https://github.com/kobezzza/Escaper

Usage

1const
2  str = 'Hello "world" and \'friends\'',
3  content = [];
4
5// Replaces all found matches
6// 'Hello __ESCAPER_QUOT__0_ and __ESCAPER_QUOT__1_'
7Escaper.replace(str, content)
8
9// Replaces only single quotes
10// 'Hello "world" and __ESCAPER_QUOT__0_'
11Escaper.replace(str, ["'"])
12
13// Cuts all found matches
14// 'Hello and '
15Escaper.replace(str, -1)
16
17// Replaces all and cuts single quotes
18// 'Hello __ESCAPER_QUOT__0_ and '
19Escaper.replace(str, {"'": -1})
20
21// Replaces all but strings
22// 'Hello __ESCAPER_QUOT__0_ and \'friends\''
23Escaper.replace(str, {strings: false})
24
25// Replaces all, but strings can be only single quotes
26// 'Hello "world" and __ESCAPER_QUOT__0_'
27Escaper.replace(str, {strings: ["'"]})
28
29// Replaces all, but strings can be only single quotes and it will be cut
30// 'Hello "world" and '
31Escaper.replace(str, {strings: {"'": -1}})
32
33// Replaces all found escape blocks to a real content
34// 'Hello "world" and \'friends\''
35Escaper.paste(str, content);

API

Escaper.replace(str, how?, store?): string

Replaces all found blocks ' ... ', " ... ", ` ... `, / ... /, // ..., /* ... */ to escape blocks from the specified 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. If the value is set to boolean it will be replaced/passed.

1// Label of replacement, by default __ESCAPER_QUOT__${pos}_
2'label'
3
4// Singleline comment
5'singleComments'
6
7// Multiline comments
8'multComments'
9
10// All kinds of comments
11'comments'
12
13// All kinds of strings
14'strings'
15
16// All kinds of literals (except strings and comments)
17'literals'
18
19// Literals
20"'"
21'"'
22'`'
23'/'
24'//'
25'//*'
26'//!'
27'//#'
28'//@'
29'//$'
30'/*'
31'/**'
32'/*!'
33'/*#'
34'/*@'
35'/*$'

The parameters can be specified as an array (escapes only explicitly specified sequences) or like an object (disables/excludes by a literal or group). Also, if you set the parameter value as -1, then all found sequences will be removed from the string.

string[] store = Escaper.content — store for matches.

Escaper.paste(str, store?, rgxp?): string

Replaces all found escape blocks to real content from the specified string and returns a new string.

Arguments

string str — source string;
string[] store = Escaper.content — store of matches;
RegExp rgxp? — RegExp to search, e.g. /__ESCAPER_QUOT__(\d+)_/g.

License

The MIT License.

No vulnerabilities found.

10

Dangerous-Workflow

Determines if the project's GitHub Action workflows avoid dangerous patterns.

10

Binary-Artifacts

Determines if the project has generated executable (binary) artifacts in the source repository.

10

License

Determines if the project has defined a license.

4

Pinned-Dependencies

Determines if the project has declared and pinned the dependencies of its build process.

0

Code-Review

Determines if the project requires human code review before pull requests (aka merge requests) are merged.

0

Maintained

Determines if the project is "actively maintained".

0

Token-Permissions

Determines if the project's workflows follow the principle of least privilege.

0

CII-Best-Practices

Determines if the project has an OpenSSF (formerly CII) Best Practices Badge.

0

Security-Policy

Determines if the project has published a security policy.

0

Fuzzing

Determines if the project uses fuzzing.

0

Branch-Protection

Determines if the default and release branches are protected with GitHub's branch protection settings.

0

SAST

Determines if the project uses static code analysis.

0

Vulnerabilities

Determines if the project has open, known unfixed vulnerabilities.

Score

2.8

/10

Last Scanned on 2024-11-25

The Open Source Security Foundation is a cross-industry collaboration to improve the security of open source software (OSS). The Scorecard provides security health metrics for open source projects.

Learn More

escaper

Installations

Pull Requests

3

26

0

23

Issues

0

2

2

Releases

Developer

kobezzza

Developer Guide

CommonJS

No

14.15.1

6.14.8

Statistics

Languages

Total Downloads

6,701,340

Daily Downloads

Weekly Downloads

Monthly Downloads

Yearly Downloads

Dev Dependencies

Escaper

Install

Usage

API

Escaper.replace(str, how?, store?): string

Escaper.paste(str, store?, rgxp?): string

License

10

10

10

4

0

0

0

0

0

0

0

0

0

2.8

/10