add lisp packages
This commit is contained in:
126
lisp/emacs-application-framework/app/mermaid/node_modules/escaper/README.md
generated
vendored
Normal file
126
lisp/emacs-application-framework/app/mermaid/node_modules/escaper/README.md
generated
vendored
Normal file
@@ -0,0 +1,126 @@
|
||||
Escaper
|
||||
=======
|
||||
|
||||
Escaper is a small JavaScript library for replacing string literals, regular expressions and comments in JavaScript syntax.
|
||||
|
||||
[Russian documentation](https://github.com/kobezzza/Escaper/blob/master/README.ru.md)
|
||||
|
||||
[](http://badge.fury.io/js/escaper)
|
||||
[](https://david-dm.org/kobezzza/Escaper?type=dev)
|
||||
[](https://travis-ci.org/kobezzza/Escaper)
|
||||
[](https://coveralls.io/r/kobezzza/Escaper?branch=master)
|
||||
|
||||
**Supports:**
|
||||
|
||||
* `' ... '`
|
||||
* `" ... "`
|
||||
* `` ` ... ` ``, `` ` ... ${...} ` ``
|
||||
* `/ ... /`
|
||||
* `// ...`, `//* ...`, `//! ...`, `//# ...`, `//@ ...`, `//$ ...`
|
||||
* `/* ... */`, `/** ... */`, `/*! ... */`, `/*# ... */`, `/*@ ... */`, `/*$ ... */`
|
||||
|
||||
## Install
|
||||
|
||||
https://raw.githubusercontent.com/kobezzza/Escaper/master/dist/escaper.min.js
|
||||
|
||||
or
|
||||
|
||||
```bash
|
||||
npm install escaper
|
||||
```
|
||||
|
||||
or
|
||||
|
||||
```bash
|
||||
bower install escaper
|
||||
```
|
||||
|
||||
or
|
||||
|
||||
```bash
|
||||
git clone https://github.com/kobezzza/Escaper
|
||||
```
|
||||
|
||||
## Usage
|
||||
|
||||
```js
|
||||
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_content)
|
||||
|
||||
The method replaces all found blocks `' ... '`, `" ... "`, `` ` ... ` ``, `/ ... /`, `// ...`, `/* ... */` to
|
||||
`__ESCAPER_QUOT__number_` in a string and returns a new string.
|
||||
|
||||
**Arguments**
|
||||
|
||||
* `string` `str` — source string;
|
||||
* `(Object|boolean)=` `opt_withCommentsOrParams = false` — parameters:
|
||||
|
||||
```js
|
||||
{
|
||||
// The template for replacement
|
||||
'@label' : '__ESCAPER_QUOT__${pos}_',
|
||||
|
||||
'@all' : true, // Replaces all found 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,
|
||||
'//@' : true,
|
||||
'//$' : true,
|
||||
'/*' : true,
|
||||
'/**' : true,
|
||||
'/*!' : true,
|
||||
'/*#' : true,
|
||||
'/*@' : true,
|
||||
'/*$' : true
|
||||
}
|
||||
```
|
||||
|
||||
If a parameter value is set to `-1`, then all found matches will be removed from the final string, or if the value will be set to
|
||||
`true`/`false` they will be included/excluded.
|
||||
|
||||
If parameter `opt_withCommentsOrParams` is boolean:
|
||||
|
||||
```js
|
||||
true // Replaces all found matches
|
||||
false // Replaces all kinds of string literals and regular expressions
|
||||
```
|
||||
|
||||
* `Array=` `opt_content = Escaper.content` — array for matches.
|
||||
|
||||
`@return {string}`
|
||||
|
||||
### Escaper.paste(str, opt_content)
|
||||
|
||||
The method replaces all found blocks `__ESCAPER_QUOT__number_` to real content in a string and returns a new string.
|
||||
|
||||
**Arguments**
|
||||
|
||||
* `string` `str` — source string;
|
||||
* `Array=` `opt_content = Escaper.content` — array of matches;
|
||||
* `RegExp=` `opt_rgxp` — RegExp for searching, e.g. `/__ESCAPER_QUOT__(\d+)_/g`.
|
||||
|
||||
`@return {string}`
|
||||
|
||||
## [License](https://github.com/kobezzza/Escaper/blob/master/LICENSE)
|
||||
|
||||
The MIT License.
|
||||
Reference in New Issue
Block a user