development/deno
development/deno
1
0
Fork 0
mirror of https://github.com/denoland/deno synced 2024-10-30 02:21:11 +00:00
Code Issues Projects Releases Packages Wiki Activity

fix(cli/js/web/console): Improve string quoting behaviour (#6457)

Browse source
This commit is contained in:
Nayeem Rahman 2020-06-24 14:47:05 +01:00 committed by GitHub
parent 702547d65a
commit 3314b46321
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
2 changed files with 26 additions and 1 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

20
cli/js/web/console.ts
View file

@ -300,6 +300,24 @@ function stringify(
}
}
// We can match Node's quoting behavior exactly by swapping the double quote and
// single quote in this array. That would give preference to single quotes.
// However, we prefer double quotes as the default.
const QUOTES = ['"', "'", "`"];
/** Surround the string in quotes.
*
* The quote symbol is chosen by taking the first of the `QUOTES` array which
* does not occur in the string. If they all occur, settle with `QUOTES[0]`.
*
* Insert a backslash before any occurrence of the chosen quote symbol and
* before any backslash. */
function quoteString(string: string): string {
const quote = QUOTES.find((c) => !string.includes(c)) ?? QUOTES[0];
const escapePattern = new RegExp(`(?=[${quote}\\\\])`, "g");
return `${quote}${string.replace(escapePattern, "\\")}${quote}`;
}
// Print strings when they are inside of arrays or objects with quotes
function stringifyWithQuotes(
value: unknown,
@ -313,7 +331,7 @@ function stringifyWithQuotes(
value.length > STR_ABBREVIATE_SIZE
? value.slice(0, STR_ABBREVIATE_SIZE) + "..."
: value;
return green(`"${trunc}"`); // Quoted strings are green
return green(quoteString(trunc)); // Quoted strings are green
default:
return stringify(value, ctx, level, maxLevel);
}

7
cli/tests/unit/console_test.ts
View file

@ -64,6 +64,13 @@ unitTest(function consoleTestStringifyComplexObjects(): void {
assertEquals(stringify({ foo: "bar" }), `{ foo: "bar" }`);
});
unitTest(function consoleTestStringifyQuotes(): void {
assertEquals(stringify(["\\"]), `[ "\\\\" ]`);
assertEquals(stringify(['\\,"']), `[ '\\\\,"' ]`);
assertEquals(stringify([`\\,",'`]), `[ \`\\\\,",'\` ]`);
assertEquals(stringify(["\\,\",',`"]), `[ "\\\\,\\",',\`" ]`);
});
unitTest(function consoleTestStringifyLongStrings(): void {
const veryLongString = "a".repeat(200);
// If we stringify an object containing the long string, it gets abbreviated.