Installations

npm install escape-latex

Score

99.6

Supply Chain

89.8

Quality

75.7

Maintenance

100

Vulnerability

100

License

Pull Requests

Open

2

Total

85

Closed

42

Merged

41

Issues

Open

0

Total

8

Closed

8

Releases

Unable to fetch releases

Developer

dangmai

Developer Guide

BETA

Module System

CommonJS

Min. Node Version

Typescript Support

No

Node Version

8.12.0

NPM Version

6.4.1 Statistics

19 Stars

142 Commits

4 Forks

3 Watching

23 Branches

1 Contributors

Updated on 19 Nov 2024

Languages

JavaScript (100%)

Total Downloads

Cumulative downloads

Total Downloads

112,742,138

Last day

-28.6%

161,480

Compared to previous day

Last week

0.3%

1,103,940

Compared to previous week

Last month

7.9%

4,570,316

Compared to previous month

Last year

40.5%

36,498,746

Compared to previous year

Daily Downloads

Weekly Downloads

Monthly Downloads

Yearly Downloads

Dev Dependencies

12

babel-cli babel-core babel-plugin-transform-object-assign babel-preset-env chai eslint eslint-config-google eslint-config-prettier husky lint-staged mocha prettier

Versions

escape-latex

$Build Status$ $codecov$

Escape LaTeX special characters with Javascript in NodeJS (>= 14.x) environment.

Usage

1npm install escape-latex
2var lescape = require('escape-latex');
3lescape("String to be escaped here #yolo");

API

1lescape((input: String), {
2  preserveFormatting: Boolean,
3  escapeMapFn: Function,
4});

By default, escape-latex only escapes characters that would result in malformed LaTeX. These characters include # $ % & \ ^ _ { }.

This means that the final LaTeX output might not look the same as your input Javascript string. For example, multiple spaces are kept as-is, which may be truncated to 1 space by your LaTeX software.

If you want the final output string to be as similar to your input Javascript string as possible, you can set the preserveFormatting param to true, like so:

1lescape("Hello   World", { preserveFormatting: true });
2// Hello~~~World

Which will be converted to three non-breaking spaces by your LaTeX software.

The list of format characters that are escaped include space, \t (tab), – (en-dash), — (em-dash).

There is also the param escapeMapFn to modify the mapping of escaped characters, so you can add/modify/remove your own escapes if necessary.

It accepts a callback function that takes in the default character escapes and the formatting escapes as parameters, and returns a complete escape mapping. Here's an example:

1lescape("Hello   World", {
2  preserveFormatting: true,
3  escapeMapFn: function (defaultEscapes, formattingEscapes) {
4    formattingEscapes[" "] = "\\\\";
5    return Object.assign({}, defaultEscapes, formattingEscapes);
6  },
7});
8// Hello\\\\\\world

Testing

npm test

Notes

If you are updating from escape-latex < 1.0.0, the en-dash and em-dash are no longer escaped by default. Please use preserveFormatting to turn them on if necessary.

License

MIT

No vulnerabilities found.

10

Binary-Artifacts

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

10

Dangerous-Workflow

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

10

Vulnerabilities

Determines if the project has open, known unfixed vulnerabilities.

10

License

Determines if the project has defined a license.

2

Maintained

Determines if the project is "actively maintained".

0

Code-Review

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

0

Pinned-Dependencies

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

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.

Score

3.6

/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