js-string-escape 0.1.0

Escape a string for use as a JavaScript string literal body. A faithful port of the js-string-escape npm package. Zero deps, no_std.
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66

# js-string-escape

[![All Contributors](https://img.shields.io/badge/all_contributors-1-orange.svg?style=flat-square)](#contributors-)

[![crates.io](https://img.shields.io/crates/v/js-string-escape.svg)](https://crates.io/crates/js-string-escape)
[![docs.rs](https://docs.rs/js-string-escape/badge.svg)](https://docs.rs/js-string-escape)
[![CI](https://github.com/trananhtung/js-string-escape/actions/workflows/ci.yml/badge.svg)](https://github.com/trananhtung/js-string-escape/actions/workflows/ci.yml)
[![license](https://img.shields.io/crates/l/js-string-escape.svg)](#license)

**Escape a string for use as a JavaScript string literal body.**

Escapes the characters that aren't valid inside a single- or double-quoted JavaScript string
literal: `"`, `'`, `\`, and the line terminators `\n`, `\r`, `U+2028`, and `U+2029`.
Everything else passes through unchanged. A faithful Rust port of the
[`js-string-escape`](https://www.npmjs.com/package/js-string-escape) npm package.

- **Zero dependencies**, **`#![no_std]`**
- Differential-tested against the reference `js-string-escape` implementation

## Install

```toml
[dependencies]
js-string-escape = "0.1"
```

## Usage

```rust
use js_string_escape::js_string_escape;

assert_eq!(js_string_escape(r#"a"b'c\d"#), r#"a\"b\'c\\d"#);
assert_eq!(js_string_escape("line1\nline2"), "line1\\nline2");

// Tabs, other control characters, and non-ASCII pass through:
assert_eq!(js_string_escape("café\t😀"), "café\t😀");
```

For richer escaping (ASCII-only output, JSON mode, backtick quotes, …) see
[`jsesc`](https://crates.io/crates/jsesc).

## Contributors ✨

This project follows the [all-contributors](https://github.com/all-contributors/all-contributors) specification. Contributions of any kind are welcome — code, docs, bug reports, ideas, reviews! See the [emoji key](https://allcontributors.org/docs/en/emoji-key) for how each contribution is recognized, and open a PR or issue to get involved.

Thanks goes to these wonderful people:

<!-- ALL-CONTRIBUTORS-LIST:START - Do not remove or modify this section -->
<!-- prettier-ignore-start -->
<!-- markdownlint-disable -->
<table>
  <tbody>
    <tr>
      <td align="center" valign="top" width="14.28%"><a href="https://github.com/trananhtung"><img src="https://avatars.githubusercontent.com/u/30992229?v=4?s=100" width="100px;" alt="Tung Tran"/><br /><sub><b>Tung Tran</b></sub></a><br /><a href="https://github.com/trananhtung/./commits?author=trananhtung" title="Code">💻</a> <a href="#maintenance-trananhtung" title="Maintenance">🚧</a></td>
    </tr>
  </tbody>
</table>

<!-- markdownlint-restore -->
<!-- prettier-ignore-end -->

<!-- ALL-CONTRIBUTORS-LIST:END -->

## License

Licensed under either of [MIT](LICENSE-MIT) or [Apache-2.0](LICENSE-APACHE) at your option.