JSESC(1)

💖 JSESC(1) 💖

okay so bestie, listen — jsesc is the little command-line baddie that escapes strings for use in JavaScript string literals. that's the whole vibe. she's giving "shortest possible valid ASCII-only output" and she ate, no cap. ✨

🌸 SYNOPSIS 🌸

jsesc [-s | --single-quotes string]
      [-d | --double-quotes string]
      [-w | --wrap string]
      [-e | --escape-everything string]
      [-6 | --es6 string]
      [-l | --lowercase-hex string]
      [-j | --json string]
      [-p | --object string]
      [-p | --pretty string]
      [-v | --version]
      [-h | --help]

🦋 DESCRIPTION 🦋

so like, jsesc escapes strings for use in JavaScript string literals while generating the shortest possible valid ASCII-only output. that's it. that's the mission. main character energy fr fr. 💅

✨ OPTIONS ✨

• -s, --single-quotes — escapes any occurrences of ' in the input string as \', so that the output can be used in a JavaScript string literal wrapped in single quotes. keeping it cozy in single quotes, periodt. 🎀
• -d, --double-quotes — escapes any occurrences of " in the input string as \", so that the output can be used in a JavaScript string literal wrapped in double quotes. the double-quote girlies are eating today. 💜
• -w, --wrap — makes sure the output is a valid JavaScript string literal wrapped in quotes. which kind of quotes? you get to pick, using the -s | --single-quotes or -d | --double-quotes settings. choose your fighter. 🫶
• -6, --es6 — escapes any astral Unicode symbols using ECMAScript 6 Unicode code point escape sequences. astral symbols get the es6 treatment, iconic. 🔥
• -e, --escape-everything — escapes all the symbols in the output, even printable ASCII symbols. literally everything, she does not discriminate. 😭
• -j, --json — makes 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. json mode: unlocked. ⭐
• -o, --object — treats 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. flat only bestie, no nesting shenanigans. 🌈
• -p, --pretty — pretty-prints the output for objects, using whitespace to make it more readable. setting this flag enables the
• -l, --lowercase-hex — uses lowercase for alphabetical hexadecimal digits in escape sequences. -o | --object setting.

💀 okay so ngl, the source manpage text for -p | --pretty and -l | --lowercase-hex is scrambled — the -p description cuts off at "enables the" and the -l description has the -o | --object fragment dangling at the end. i'm not fixing it, i'm just telling you, because i keep every detail. iykyk. 🙈

• -v, --version — prints jsesc's version. vibe check on the version number. 👑
• -h, --help — shows the help screen. when in doubt, ask for help bestie. 🧚

💅 EXIT STATUS 💅

the jsesc utility exits with one of these values:

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

🍓 EXAMPLES 🍓

• jsesc 'foo bar baz' — print an escaped version of the given string.
• echo 'foo bar baz' | jsesc — print an escaped version of the string that gets piped in.

💀 BUGS 💀

jsesc's bug tracker is located at <https://github.com/mathiasbynens/jsesc/issues>. found something cursed? take it there bestie, they wanna know. 🐛

🌟 AUTHOR 🌟

Mathias Bynens <https://mathiasbynens.be/> — the icon, the moment, the legend. 👑

🌈 WWW 🌈

<https://mths.be/jsesc> — go look, go lurk, go be obsessed. 🦋

and that's the whole page bestie — written up on May 13, 2016, part of the jsesc(1) manual, so when you're deep in a terminal at 2am escaping strings, just know she's got you. bye mwah 💖✨