prettier 1.2.3 → 1.5.0

data/src/ruby/embed.js

@@ -20,8 +20,12 @@ const parsers = {
   scss: "scss"
 };
 
-const replaceNewlines = (doc) =>
-  mapDoc(doc, (currentDoc) =>
+// This function is in here because it handles embedded parser values. I don't
+// have a test that exercises it because I'm not sure for which parser it is
+// necessary, but since it's in prettier core I'm keeping it here.
+/* istanbul ignore next */
+function replaceNewlines(doc) {
+  return mapDoc(doc, (currentDoc) =>
     typeof currentDoc === "string" && currentDoc.includes("\n")
       ? concat(
           currentDoc
@@ -30,8 +34,44 @@ const replaceNewlines = (doc) =>
         )
       : currentDoc
   );
+}
 
-const embed = (path, print, textToDoc, _opts) => {
+// Returns a number that represents the minimum amount of leading whitespace
+// that is present on every line in the given string. So for example if you have
+// the following heredoc:
+//
+//     <<~HERE
+//       my
+//       content
+//       here
+//     HERE
+//
+// then the return value of this function would be 2. If you indented every line
+// of the inner content 2 more spaces then this function would return 4.
+function getCommonLeadingWhitespace(content) {
+  const pattern = /^\s+/;
+
+  return content
+    .split("\n")
+    .slice(0, -1)
+    .reduce((minimum, line) => {
+      const matched = pattern.exec(line);
+      const length = matched ? matched[0].length : 0;
+
+      return minimum === null ? length : Math.min(minimum, length);
+    }, null);
+}
+
+// Returns a new string with the common whitespace stripped out. Effectively it
+// emulates what a squiggly heredoc does in Ruby.
+function stripCommonLeadingWhitespace(content) {
+  const lines = content.split("\n");
+  const minimum = getCommonLeadingWhitespace(content);
+
+  return lines.map((line) => line.slice(minimum)).join("\n");
+}
+
+function embed(path, print, textToDoc, _opts) {
   const node = path.getValue();
 
   // Currently we only support embedded formatting on heredoc nodes
@@ -41,6 +81,8 @@ const embed = (path, print, textToDoc, _opts) => {
 
   // First, ensure that we don't have any interpolation
   const { beging, body, ending } = node;
+  const isSquiggly = beging.body[2] === "~";
+
   if (body.some((part) => part.type !== "@tstring_content")) {
     return null;
   }
@@ -52,9 +94,17 @@ const embed = (path, print, textToDoc, _opts) => {
     return null;
   }
 
-  // Get the content as if it were a source string, and then pass that content
-  // into the embedded parser. Get back the doc node.
-  const content = body.map((part) => part.body).join("");
+  // Get the content as if it were a source string.
+  let content = body.map((part) => part.body).join("");
+
+  // If we're using a squiggly heredoc, then we're going to manually strip off
+  // the leading whitespace of each line up to the minimum leading whitespace so
+  // that the embedded parser can handle that for us.
+  if (isSquiggly) {
+    content = stripCommonLeadingWhitespace(content);
+  }
+
+  // Pass that content into the embedded parser. Get back the doc node.
   const formatted = concat([
     literalLineNoBreak,
     replaceNewlines(stripTrailingHardline(textToDoc(content, { parser })))
@@ -62,7 +112,7 @@ const embed = (path, print, textToDoc, _opts) => {
 
   // If we're using a squiggly heredoc, then we can properly handle indentation
   // ourselves.
-  if (beging.body[2] === "~") {
+  if (isSquiggly) {
     return concat([
       path.call(print, "beging"),
       lineSuffix(
@@ -85,6 +135,6 @@ const embed = (path, print, textToDoc, _opts) => {
       lineSuffix(group(concat([formatted, literalLineNoBreak, ending.trim()])))
     ])
   );
-};
+}
 
 module.exports = embed;

data/src/ruby/nodes/args.js

@@ -8,9 +8,26 @@ const {
   softline
 } = require("../../prettier");
 const { getTrailingComma } = require("../../utils");
-
 const toProc = require("../toProc");
 
+const noTrailingComma = ["command", "command_call"];
+
+function getArgParenTrailingComma(node) {
+  // If we have a block, then we don't want to add a trailing comma.
+  if (node.type === "args_add_block" && node.body[1]) {
+    return "";
+  }
+
+  // If we only have one argument and that first argument necessitates that we
+  // skip putting a comma (because it would interfere with parsing the argument)
+  // then we don't want to add a trailing comma.
+  if (node.body.length === 1 && noTrailingComma.includes(node.body[0].type)) {
+    return "";
+  }
+
+  return ifBreak(",", "");
+}
+
 function printArgParen(path, opts, print) {
   const argsNode = path.getValue().body[0];
 
@@ -32,9 +49,6 @@ function printArgParen(path, opts, print) {
     );
   }
 
-  const args = path.call(print, "body", 0);
-  const hasBlock = argsNode.type === "args_add_block" && argsNode.body[1];
-
   // Now here we return a doc that represents the whole grouped expression,
   // including the surrouding parentheses.
   return group(
@@ -43,8 +57,8 @@ function printArgParen(path, opts, print) {
       indent(
         concat([
           softline,
-          join(concat([",", line]), args),
-          getTrailingComma(opts) && !hasBlock ? ifBreak(",", "") : ""
+          join(concat([",", line]), path.call(print, "body", 0)),
+          getTrailingComma(opts) && getArgParenTrailingComma(argsNode)
         ])
       ),
       softline,

data/src/ruby/nodes/blocks.js

@@ -10,76 +10,81 @@ const {
 } = require("../../prettier");
 const { hasAncestor } = require("../../utils");
 
-const printBlock = (braces) => (path, opts, print) => {
-  const [variables, statements] = path.getValue().body;
-  const stmts =
-    statements.type === "stmts" ? statements.body : statements.body[0].body;
+function printBlockVar(path, opts, print) {
+  const parts = ["|", removeLines(path.call(print, "body", 0))];
 
-  let doBlockBody = "";
-  if (
-    stmts.length !== 1 ||
-    stmts[0].type !== "void_stmt" ||
-    stmts[0].comments
-  ) {
-    doBlockBody = indent(concat([softline, path.call(print, "body", 1)]));
+  // The second part of this node is a list of optional block-local variables
+  if (path.getValue().body[1]) {
+    parts.push("; ", join(", ", path.map(print, "body", 1)));
   }
 
-  // If this block is nested underneath a command or command_call node, then we
-  // can't use `do...end` because that will get associated with the parent node
-  // as opposed to the current node (because of the difference in operator
-  // precedence). Instead, we still use a multi-line format but switch to using
-  // braces instead.
-  const useBraces = braces && hasAncestor(path, ["command", "command_call"]);
+  parts.push("| ");
+  return concat(parts);
+}
 
-  const doBlock = concat([
-    useBraces ? " {" : " do",
-    variables ? concat([" ", path.call(print, "body", 0)]) : "",
-    doBlockBody,
-    concat([softline, useBraces ? "}" : "end"])
-  ]);
+function printBlock(braces) {
+  return function printBlockWithBraces(path, opts, print) {
+    const [variables, statements] = path.getValue().body;
+    const stmts =
+      statements.type === "stmts" ? statements.body : statements.body[0].body;
 
-  // We can hit this next pattern if within the block the only statement is a
-  // comment.
-  if (
-    stmts.length === 1 &&
-    stmts[0].type === "void_stmt" &&
-    stmts[0].comments
-  ) {
-    return concat([breakParent, doBlock]);
-  }
+    let doBlockBody = "";
+    if (
+      stmts.length !== 1 ||
+      stmts[0].type !== "void_stmt" ||
+      stmts[0].comments
+    ) {
+      doBlockBody = indent(concat([softline, path.call(print, "body", 1)]));
+    }
 
-  // If the parent node is a command node, then there are no parentheses around
-  // the arguments to that command, so we need to break the block
-  if (["command", "command_call"].includes(path.getParentNode().body[0].type)) {
-    return concat([breakParent, doBlock]);
-  }
+    // If this block is nested underneath a command or command_call node, then
+    // we can't use `do...end` because that will get associated with the parent
+    // node as opposed to the current node (because of the difference in
+    // operator precedence). Instead, we still use a multi-line format but
+    // switch to using braces instead.
+    const useBraces = braces && hasAncestor(path, ["command", "command_call"]);
 
-  const hasBody = stmts.some(({ type }) => type !== "void_stmt");
-  const braceBlock = concat([
-    " {",
-    hasBody || variables ? " " : "",
-    variables ? path.call(print, "body", 0) : "",
-    path.call(print, "body", 1),
-    hasBody ? " " : "",
-    "}"
-  ]);
+    const doBlock = concat([
+      useBraces ? " {" : " do",
+      variables ? concat([" ", path.call(print, "body", 0)]) : "",
+      doBlockBody,
+      concat([softline, useBraces ? "}" : "end"])
+    ]);
 
-  return group(ifBreak(doBlock, braceBlock));
-};
+    // We can hit this next pattern if within the block the only statement is a
+    // comment.
+    if (
+      stmts.length === 1 &&
+      stmts[0].type === "void_stmt" &&
+      stmts[0].comments
+    ) {
+      return concat([breakParent, doBlock]);
+    }
 
-module.exports = {
-  block_var: (path, opts, print) => {
-    const parts = ["|", removeLines(path.call(print, "body", 0))];
+    const blockReceiver = path.getParentNode().body[0];
 
-    // The second part of this node is a list of optional block-local variables
-    if (path.getValue().body[1]) {
-      parts.push("; ", join(", ", path.map(print, "body", 1)));
+    // If the parent node is a command node, then there are no parentheses
+    // around the arguments to that command, so we need to break the block
+    if (["command", "command_call"].includes(blockReceiver.type)) {
+      return concat([breakParent, doBlock]);
     }
 
-    parts.push("| ");
-    return concat(parts);
-  },
+    const hasBody = stmts.some(({ type }) => type !== "void_stmt");
+    const braceBlock = concat([
+      " {",
+      hasBody || variables ? " " : "",
+      variables ? path.call(print, "body", 0) : "",
+      path.call(print, "body", 1),
+      hasBody ? " " : "",
+      "}"
+    ]);
+
+    return group(ifBreak(doBlock, braceBlock));
+  };
+}
+
+module.exports = {
+  block_var: printBlockVar,
   brace_block: printBlock(true),
-  do_block: printBlock(false),
-  excessed_comma: () => ""
+  do_block: printBlock(false)
 };

data/src/ruby/nodes/calls.js

@@ -24,6 +24,12 @@ function printCall(path, opts, print) {
   // call syntax so if `call` is implicit, we don't print it out.
   const messageDoc = messageNode === "call" ? "" : path.call(print, "body", 2);
 
+  // For certain left sides of the call nodes, we want to attach directly to
+  // the } or end.
+  if (noIndent.includes(receiverNode.type)) {
+    return concat([receiverDoc, operatorDoc, messageDoc]);
+  }
+
   // The right side of the call node, as in everything including the operator
   // and beyond.
   const rightSideDoc = concat([
@@ -37,7 +43,7 @@ function printCall(path, opts, print) {
 
   // If our parent node is a chained node then we're not going to group the
   // right side of the expression, as we want to have a nice multi-line layout.
-  if (chained.includes(parentNode.type)) {
+  if (chained.includes(parentNode.type) && !node.comments) {
     parentNode.chain = (node.chain || 0) + 1;
     parentNode.callChain = (node.callChain || 0) + 1;
     parentNode.breakDoc = (node.breakDoc || [receiverDoc]).concat(rightSideDoc);
@@ -47,18 +53,10 @@ function printCall(path, opts, print) {
   // If we're at the top of a chain, then we're going to print out a nice
   // multi-line layout if this doesn't break into multiple lines.
   if (!chained.includes(parentNode.type) && (node.chain || 0) >= 3) {
-    let breakDoc = concat(node.breakDoc.concat(rightSideDoc));
-    if (!noIndent.includes(node.firstReceiverType)) {
-      breakDoc = indent(breakDoc);
-    }
-
-    return ifBreak(group(breakDoc), concat([receiverDoc, group(rightSideDoc)]));
-  }
-
-  // For certain left sides of the call nodes, we want to attach directly to
-  // the } or end.
-  if (noIndent.includes(receiverNode.type)) {
-    return concat([receiverDoc, operatorDoc, messageDoc]);
+    return ifBreak(
+      group(indent(concat(node.breakDoc.concat(rightSideDoc)))),
+      concat([receiverDoc, group(rightSideDoc)])
+    );
   }
 
   return group(concat([receiverDoc, group(indent(rightSideDoc))]));
@@ -105,7 +103,7 @@ function printMethodAddArg(path, opts, print) {
 
   // If our parent node is a chained node then we're not going to group the
   // right side of the expression, as we want to have a nice multi-line layout.
-  if (chained.includes(parentNode.type)) {
+  if (chained.includes(parentNode.type) && !node.comments) {
     parentNode.chain = (node.chain || 0) + 1;
     parentNode.breakDoc = (node.breakDoc || [methodDoc]).concat(argsDoc);
     parentNode.firstReceiverType = node.firstReceiverType;
@@ -138,41 +136,12 @@ function printMethodAddArg(path, opts, print) {
   return concat([methodDoc, argsDoc]);
 }
 
-// Sorbet type annotations look like the following:
-//
-//     {method_add_block
-//       [{method_add_arg
-//          [{fcall
-//             [{@ident "sig"}]},
-//           {args []}]},
-//        {brace_block [nil, {stmts}]}}]}
-//
-function isSorbetTypeAnnotation(node) {
-  const [callNode, blockNode] = node.body;
-
-  return (
-    callNode.type === "method_add_arg" &&
-    callNode.body[0].type === "fcall" &&
-    callNode.body[0].body[0].body === "sig" &&
-    callNode.body[1].type === "args" &&
-    callNode.body[1].body.length === 0 &&
-    blockNode
-  );
-}
-
 function printMethodAddBlock(path, opts, print) {
   const node = path.getValue();
 
   const [callNode, blockNode] = node.body;
   const [callDoc, blockDoc] = path.map(print, "body");
 
-  // Very special handling here for sorbet type annotations. They look like Ruby
-  // code, but they're not actually Ruby code, so we're not going to mess with
-  // them at all.
-  if (isSorbetTypeAnnotation(node)) {
-    return opts.originalText.slice(opts.locStart(node), opts.locEnd(node));
-  }
-
   // Don't bother trying to do any kind of fancy toProc transform if the option
   // is disabled.
   if (opts.rubyToProc) {

data/src/ruby/nodes/class.js

@@ -1,34 +1,22 @@
-const {
-  concat,
-  group,
-  hardline,
-  ifBreak,
-  indent,
-  line
-} = require("../../prettier");
+const { concat, group, hardline, indent } = require("../../prettier");
+const { isEmptyBodyStmt } = require("../../utils");
 
 function printClass(path, opts, print) {
   const [_constant, superclass, bodystmt] = path.getValue().body;
-  const stmts = bodystmt.body[0];
 
   const parts = ["class ", path.call(print, "body", 0)];
   if (superclass) {
     parts.push(" < ", path.call(print, "body", 1));
   }
 
-  // If the body is empty and does not contain any comments, we can just
-  // replace the body with a semi-colon.
-  if (
-    stmts.body.length === 1 &&
-    stmts.body[0].type === "void_stmt" &&
-    !stmts.body[0].comments
-  ) {
-    return group(concat([concat(parts), ifBreak(line, "; "), "end"]));
+  const declaration = group(concat(parts));
+  if (isEmptyBodyStmt(bodystmt)) {
+    return group(concat([declaration, hardline, "end"]));
   }
 
   return group(
     concat([
-      concat(parts),
+      declaration,
       indent(concat([hardline, path.call(print, "body", 2)])),
       concat([hardline, "end"])
     ])
@@ -36,16 +24,11 @@ function printClass(path, opts, print) {
 }
 
 function printModule(path, opts, print) {
+  const node = path.getValue();
   const declaration = group(concat(["module ", path.call(print, "body", 0)]));
 
-  // If the body is empty, we can replace with a ;
-  const stmts = path.getValue().body[1].body[0];
-  if (
-    stmts.body.length === 1 &&
-    stmts.body[0].type === "void_stmt" &&
-    !stmts.body[0].comments
-  ) {
-    return group(concat([declaration, ifBreak(line, "; "), "end"]));
+  if (isEmptyBodyStmt(node.body[1])) {
+    return group(concat([declaration, hardline, "end"]));
   }
 
   return group(
@@ -58,9 +41,16 @@ function printModule(path, opts, print) {
 }
 
 function printSClass(path, opts, print) {
+  const bodystmt = path.getValue().body[1];
+  const declaration = concat(["class << ", path.call(print, "body", 0)]);
+
+  if (isEmptyBodyStmt(bodystmt)) {
+    return group(concat([declaration, hardline, "end"]));
+  }
+
   return group(
     concat([
-      concat(["class << ", path.call(print, "body", 0)]),
+      declaration,
       indent(concat([hardline, path.call(print, "body", 1)])),
       concat([hardline, "end"])
     ])