logo
Free, unlimited AI code reviews that run on commit
git-lrc git-lrc GitHub Install Now We'd appreciate a star git-lrc - Free, unlimited AI code reviews that run on commit | Product Hunt git-lrc - Free, unlimited AI code reviews that run on commit | Product Hunt

jsesc — escape strings for use in JavaScript string literals

Author

       Mathias Bynens <https://mathiasbynens.be/>

Bugs

       jsesc's bug tracker is located at <https://github.com/mathiasbynens/jsesc/issues>.

Description

jsesc  escapes strings for use in JavaScript string literals while generating the shortest possible valid
       ASCII-only output.

Examples

jsesc'foobarbaz'
       Print an escaped version of the given string.

       echo'foobarbaz'|jsesc
       Print an escaped version of the string that gets piped in.

Exit Status

       The jsesc utility exits with one of the following values:

       0jsesc successfully escaped the given string and printed the result.
       1jsesc  wasn't  instructed  to  escape anything (for example, the --help flag was set); or, an error
             occurred.

Name

       jsesc — escape strings for use in JavaScript string literals

Options

-s,--single-quotes
       Escape any occurrences of ' in the input string as \', so that the output can be  used  in  a  JavaScript
       string literal wrapped in single quotes.

       -d,--double-quotes
       Escape  any  occurrences  of  " in the input string as \", so that the output can be used in a JavaScript
       string literal wrapped in double quotes.

       -w,--wrap
       Make sure the output is a valid JavaScript string literal wrapped in quotes. The type of  quotes  can  be
       specified using the -s | --single-quotes or -d | --double-quotes settings.

       -6,--es6
       Escape any astral Unicode symbols using ECMAScript 6 Unicode code point escape sequences.

       -e,--escape-everything
       Escape all the symbols in the output, even printable ASCII symbols.

       -j,--json
       Make  sure  the  output  is  valid  JSON.  Hexadecimal character escape sequences and the \v or \0 escape
       sequences will not be used. Setting this flag enables the -d | --double-quotes and -w | --wrap settings.

       -o,--object
       Treat the input as a JavaScript object rather than a string. Accepted values are flat  arrays  containing
       only string values, and flat objects containing only string values.

       -p,--pretty
       Pretty-print the output for objects, using whitespace to make it more readable. Setting this flag enables
       the

       -l,--lowercase-hex
       Use lowercase for alphabetical hexadecimal digits in escape sequences.  -o | --object setting.

       -v,--version
       Print jsesc's version.

       -h,--help
       Show the help screen.

Synopsis

jsesc [-s | --single-quotesstring]
             [-d | --double-quotesstring]
             [-w | --wrapstring]
             [-e | --escape-everythingstring]
             [-6 | --es6string]
             [-l | --lowercase-hexstring]
             [-j | --jsonstring]
             [-p | --objectstring]
             [-p | --prettystring]
             [-v | --version]
             [-h | --help]

Www

       <https://mths.be/jsesc>

                                                  May 13, 2016                                          jsesc(1)

See Also