Skip to content

Commit

Permalink
Add parens around all string literals at top level (prettier#1999)
Browse files Browse the repository at this point in the history
  • Loading branch information
@danez @vjeux
danez authored and vjeux committed Jun 6, 2017
1 parent c80e82c commit df7311a
Show file tree
Hide file tree
Showing 4 changed files with 128 additions and 117 deletions.
18 changes: 15 additions & 3 deletions src/fast-path.js
View file
Original file line number Diff line number Diff line change
Expand Up @@ -405,8 +405,23 @@ FastPath.prototype.needsParens = function() {
parent.type === "IntersectionTypeAnnotation"
);

case "StringLiteral":
case "NumericLiteral":
case "Literal":
if (
typeof node.value === "string" &&
parent.type === "ExpressionStatement" &&
!parent.directive
) {
// To avoid becoming a directive
const grandParent = this.getParentNode(1);

return (
grandParent.type === "Program" ||
grandParent.type === "BlockStatement"
);
}

return (
parent.type === "MemberExpression" &&
typeof node.value === "number" &&
Expand Down Expand Up @@ -523,9 +538,6 @@ FastPath.prototype.needsParens = function() {

case "ClassExpression":
return parent.type === "ExportDefaultDeclaration";

case "StringLiteral":
return parent.type === "ExpressionStatement"; // To avoid becoming a directive
}

return false;
Expand Down
4 changes: 2 additions & 2 deletions tests/do/__snapshots__/jsfmt.spec.js.snap
View file
Original file line number Diff line number Diff line change
Expand Up @@ -11,8 +11,8 @@ const envSpecific = {
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
const envSpecific = {
domain: do {
if (env === "production") ("https://abc.mno.com/");
else if (env === "development") ("http://localhost:4000");
if (env === "production") "https://abc.mno.com/";
else if (env === "development") "http://localhost:4000";
}
};
Expand Down
3 changes: 1 addition & 2 deletions tests/expression_statement/jsfmt.spec.js
View file
Original file line number Diff line number Diff line change
@@ -1,2 +1 @@
// TODO: Re-enable Flow when the following fix is merged facebook/flow#3234.
run_spec(__dirname, { parser: "babylon" } /*, ["typescript"] */);
run_spec(__dirname, { parser: "babylon" }, ["flow"]);
220 changes: 110 additions & 110 deletions tests/quotes/__snapshots__/jsfmt.spec.js.snap
View file
Original file line number Diff line number Diff line change
Expand Up @@ -145,79 +145,79 @@ exports[`strings.js 1`] = `
// for consistency.
// Simple strings.
"abc";
"abc";
("abc");
("abc");
// Escape.
"\\0";
("\\0");
// Emoji.
"🐶";
("🐶");
// Empty string.
"";
"";
("");
("");
// Single double quote.
'"';
'"';
('"');
('"');
// Single single quote.
"'";
"'";
("'");
("'");
// Unnecessary escapes.
"'";
'"';
"a";
"a";
"hola";
"hola";
"hol\\\\a (the a is not escaped)";
"hol\\\\a (the a is not escaped)";
"multiple a unnecessary a escapes";
"multiple a unnecessary a escapes";
"unnecessarily escaped character preceded by escaped backslash \\\\a";
"unnecessarily escaped character preceded by escaped backslash \\\\a";
"unescaped character preceded by two escaped backslashes \\\\\\\\a";
"unescaped character preceded by two escaped backslashes \\\\\\\\a";
"aa"; // consecutive unnecessarily escaped characters
"aa"; // consecutive unnecessarily escaped characters
"escaped \\u2030 ‰ (should not stay escaped)";
("'");
('"');
("a");
("a");
("hola");
("hola");
("hol\\\\a (the a is not escaped)");
("hol\\\\a (the a is not escaped)");
("multiple a unnecessary a escapes");
("multiple a unnecessary a escapes");
("unnecessarily escaped character preceded by escaped backslash \\\\a");
("unnecessarily escaped character preceded by escaped backslash \\\\a");
("unescaped character preceded by two escaped backslashes \\\\\\\\a");
("unescaped character preceded by two escaped backslashes \\\\\\\\a");
("aa"); // consecutive unnecessarily escaped characters
("aa"); // consecutive unnecessarily escaped characters
("escaped \\u2030 ‰ (should not stay escaped)");
// Meaningful escapes
"octal escapes \\0 \\1 \\2 \\3 \\4 \\5 \\6 \\7";
"octal escapes \\0 \\1 \\2 \\3 \\4 \\5 \\6 \\7";
"meaningfully escaped alphabetical characters \\n \\r \\v \\t \\b \\f \\u2713 \\x61";
"meaningfully escaped alphabetical characters \\n \\r \\v \\t \\b \\f \\u2713 \\x61";
"escaped newline \\
";
"escaped carriage return \\
";
"escaped \\u2028 \\
";
"escaped \\u2029 \\
";
("octal escapes \\0 \\1 \\2 \\3 \\4 \\5 \\6 \\7");
("octal escapes \\0 \\1 \\2 \\3 \\4 \\5 \\6 \\7");
("meaningfully escaped alphabetical characters \\n \\r \\v \\t \\b \\f \\u2713 \\x61");
("meaningfully escaped alphabetical characters \\n \\r \\v \\t \\b \\f \\u2713 \\x61");
("escaped newline \\
");
("escaped carriage return \\
");
("escaped \\u2028 \\
");
("escaped \\u2029 \\
");
// One of each.
"\\"'";
"\\"'";
("\\"'");
("\\"'");
// One of each with unnecessary escapes.
"\\"'";
"\\"'";
("\\"'");
("\\"'");
// More double quotes than single quotes.
'"\\'"';
'"\\'"';
('"\\'"');
('"\\'"');
// More single quotes than double quotes.
"\\"''";
"\\"''";
("\\"''");
("\\"''");
// Two of each.
"\\"\\"''";
"\\"\\"''";
("\\"\\"''");
("\\"\\"''");
// Single backslash.
"\\\\";
"\\\\";
("\\\\");
("\\\\");
// Backslases.
"\\"\\\\\\"\\\\\\\\\\" ''\\\\'\\\\'\\\\\\\\'";
'\\'\\\\\\'\\\\\\\\\\' ""\\\\"\\\\"\\\\\\\\"';
("\\"\\\\\\"\\\\\\\\\\" ''\\\\'\\\\'\\\\\\\\'");
('\\'\\\\\\'\\\\\\\\\\' ""\\\\"\\\\"\\\\\\\\"');
// Somewhat more real-word example.
"He's sayin': \\"How's it goin'?\\" Don't ask me why.";
"He's sayin': \\"How's it goin'?\\" Don't ask me why.";
("He's sayin': \\"How's it goin'?\\" Don't ask me why.");
("He's sayin': \\"How's it goin'?\\" Don't ask me why.");
// Somewhat more real-word example 2.
'var backslash = "\\\\", doubleQuote = \\'"\\';';
'var backslash = "\\\\", doubleQuote = \\'"\\';';
('var backslash = "\\\\", doubleQuote = \\'"\\';');
('var backslash = "\\\\", doubleQuote = \\'"\\';');
`;

Expand Down Expand Up @@ -336,78 +336,78 @@ exports[`strings.js 2`] = `
// for consistency.
// Simple strings.
'abc';
'abc';
('abc');
('abc');
// Escape.
'\\0';
('\\0');
// Emoji.
'🐶';
('🐶');
// Empty string.
'';
'';
('');
('');
// Single double quote.
'"';
'"';
('"');
('"');
// Single single quote.
"'";
"'";
("'");
("'");
// Unnecessary escapes.
"'";
'"';
'a';
'a';
'hola';
'hola';
'hol\\\\a (the a is not escaped)';
'hol\\\\a (the a is not escaped)';
'multiple a unnecessary a escapes';
'multiple a unnecessary a escapes';
'unnecessarily escaped character preceded by escaped backslash \\\\a';
'unnecessarily escaped character preceded by escaped backslash \\\\a';
'unescaped character preceded by two escaped backslashes \\\\\\\\a';
'unescaped character preceded by two escaped backslashes \\\\\\\\a';
'aa'; // consecutive unnecessarily escaped characters
'aa'; // consecutive unnecessarily escaped characters
'escaped \\u2030 ‰ (should not stay escaped)';
("'");
('"');
('a');
('a');
('hola');
('hola');
('hol\\\\a (the a is not escaped)');
('hol\\\\a (the a is not escaped)');
('multiple a unnecessary a escapes');
('multiple a unnecessary a escapes');
('unnecessarily escaped character preceded by escaped backslash \\\\a');
('unnecessarily escaped character preceded by escaped backslash \\\\a');
('unescaped character preceded by two escaped backslashes \\\\\\\\a');
('unescaped character preceded by two escaped backslashes \\\\\\\\a');
('aa'); // consecutive unnecessarily escaped characters
('aa'); // consecutive unnecessarily escaped characters
('escaped \\u2030 ‰ (should not stay escaped)');
// Meaningful escapes
'octal escapes \\0 \\1 \\2 \\3 \\4 \\5 \\6 \\7';
'octal escapes \\0 \\1 \\2 \\3 \\4 \\5 \\6 \\7';
'meaningfully escaped alphabetical characters \\n \\r \\v \\t \\b \\f \\u2713 \\x61';
'meaningfully escaped alphabetical characters \\n \\r \\v \\t \\b \\f \\u2713 \\x61';
'escaped newline \\
';
'escaped carriage return \\
';
'escaped \\u2028 \\
';
'escaped \\u2029 \\
';
('octal escapes \\0 \\1 \\2 \\3 \\4 \\5 \\6 \\7');
('octal escapes \\0 \\1 \\2 \\3 \\4 \\5 \\6 \\7');
('meaningfully escaped alphabetical characters \\n \\r \\v \\t \\b \\f \\u2713 \\x61');
('meaningfully escaped alphabetical characters \\n \\r \\v \\t \\b \\f \\u2713 \\x61');
('escaped newline \\
');
('escaped carriage return \\
');
('escaped \\u2028 \\
');
('escaped \\u2029 \\
');
// One of each.
'"\\'';
'"\\'';
('"\\'');
('"\\'');
// One of each with unnecessary escapes.
'"\\'';
'"\\'';
('"\\'');
('"\\'');
// More double quotes than single quotes.
'"\\'"';
'"\\'"';
('"\\'"');
('"\\'"');
// More single quotes than double quotes.
"\\"''";
"\\"''";
("\\"''");
("\\"''");
// Two of each.
'""\\'\\'';
'""\\'\\'';
('""\\'\\'');
('""\\'\\'');
// Single backslash.
'\\\\';
'\\\\';
('\\\\');
('\\\\');
// Backslases.
"\\"\\\\\\"\\\\\\\\\\" ''\\\\'\\\\'\\\\\\\\'";
'\\'\\\\\\'\\\\\\\\\\' ""\\\\"\\\\"\\\\\\\\"';
("\\"\\\\\\"\\\\\\\\\\" ''\\\\'\\\\'\\\\\\\\'");
('\\'\\\\\\'\\\\\\\\\\' ""\\\\"\\\\"\\\\\\\\"');
// Somewhat more real-word example.
"He's sayin': \\"How's it goin'?\\" Don't ask me why.";
"He's sayin': \\"How's it goin'?\\" Don't ask me why.";
("He's sayin': \\"How's it goin'?\\" Don't ask me why.");
("He's sayin': \\"How's it goin'?\\" Don't ask me why.");
// Somewhat more real-word example 2.
'var backslash = "\\\\", doubleQuote = \\'"\\';';
'var backslash = "\\\\", doubleQuote = \\'"\\';';
('var backslash = "\\\\", doubleQuote = \\'"\\';');
('var backslash = "\\\\", doubleQuote = \\'"\\';');
`;

0 comments on commit df7311a

Please sign in to comment.