prettier 1.6.1 → 2.0.0.pre.rc1

data/src/ruby/nodes/undef.js

@@ -1,42 +0,0 @@
-const {
-  addTrailingComment,
-  align,
-  concat,
-  group,
-  join,
-  line
-} = require("../../prettier");
-
-function printUndefSymbol(path, opts, print) {
-  const node = path.getValue();
-
-  // Since we're going to descend into the symbol literal to grab out the ident
-  // node, then we need to make sure we copy over any comments as well,
-  // otherwise we could accidentally skip printing them.
-  if (node.comments) {
-    node.comments.forEach((comment) => {
-      addTrailingComment(node.body[0], comment);
-    });
-  }
-
-  return path.call(print, "body", 0);
-}
-
-function printUndef(path, opts, print) {
-  const keyword = "undef ";
-  const argNodes = path.map(
-    (symbolPath) => printUndefSymbol(symbolPath, opts, print),
-    "body"
-  );
-
-  return group(
-    concat([
-      keyword,
-      align(keyword.length, join(concat([",", line]), argNodes))
-    ])
-  );
-}
-
-module.exports = {
-  undef: printUndef
-};

data/src/ruby/nodes.js

@@ -1,34 +0,0 @@
-module.exports = Object.assign(
-  {},
-  require("./nodes/alias"),
-  require("./nodes/aref"),
-  require("./nodes/args"),
-  require("./nodes/arrays"),
-  require("./nodes/assign"),
-  require("./nodes/blocks"),
-  require("./nodes/calls"),
-  require("./nodes/case"),
-  require("./nodes/class"),
-  require("./nodes/commands"),
-  require("./nodes/conditionals"),
-  require("./nodes/constants"),
-  require("./nodes/flow"),
-  require("./nodes/hashes"),
-  require("./nodes/heredocs"),
-  require("./nodes/hooks"),
-  require("./nodes/ints"),
-  require("./nodes/lambdas"),
-  require("./nodes/loops"),
-  require("./nodes/massign"),
-  require("./nodes/methods"),
-  require("./nodes/operators"),
-  require("./nodes/params"),
-  require("./nodes/patterns"),
-  require("./nodes/regexp"),
-  require("./nodes/rescue"),
-  require("./nodes/return"),
-  require("./nodes/statements"),
-  require("./nodes/strings"),
-  require("./nodes/super"),
-  require("./nodes/undef")
-);

data/src/ruby/parser.js

@@ -1,37 +0,0 @@
-const parseSync = require("../parser/parseSync");
-
-// This function is responsible for taking an input string of text and returning
-// to prettier a JavaScript object that is the equivalent AST that represents
-// the code stored in that string. We accomplish this by spawning a new Ruby
-// process of parser.rb and reading JSON off STDOUT.
-function parse(text, _parsers, opts) {
-  return parseSync("ruby", text, opts);
-}
-
-// This function handles checking whether or not the source string has the
-// pragma for prettier. This is an optional workflow for incremental adoption.
-function hasPragma(text) {
-  return /^\s*#[^\S\n]*@(format|prettier)\s*(\n|$)/.test(text);
-}
-
-// This function is critical for comments and cursor support, and is responsible
-// for returning the index of the character within the source string that is the
-// beginning of the given node.
-function locStart(node) {
-  return node.sc;
-}
-
-// This function is critical for comments and cursor support, and is responsible
-// for returning the index of the character within the source string that is the
-// ending of the given node.
-function locEnd(node) {
-  return node.ec;
-}
-
-module.exports = {
-  parse,
-  astFormat: "ruby",
-  hasPragma,
-  locStart,
-  locEnd
-};

data/src/ruby/printer.js

@@ -1,147 +0,0 @@
-const { concat, trim } = require("../prettier");
-
-const embed = require("./embed");
-const nodes = require("./nodes");
-
-// This is the generic node print function, used to convert any node in the AST
-// into its equivalent Doc representation.
-function printNode(path, opts, print) {
-  const { type, body } = path.getValue();
-
-  if (type in nodes) {
-    return nodes[type](path, opts, print);
-  }
-
-  if (type[0] === "@") {
-    return body;
-  }
-
-  const ast = JSON.stringify(body, null, 2);
-  throw new Error(`Unsupported node encountered: ${type}\n${ast}`);
-}
-
-// This is an escape-hatch to ignore nodes in the tree. If you have a comment
-// that includes this pattern, then the entire node will be ignored and just the
-// original source will be printed out.
-function hasPrettierIgnore(path) {
-  const node = path.getValue();
-
-  return (
-    node.comments &&
-    node.comments.some((comment) => comment.value.includes("prettier-ignore"))
-  );
-}
-
-const noComments = [
-  "args",
-  "args_add_block",
-  "args_add_star",
-  "mlhs",
-  "mlhs_add_post",
-  "mlhs_add_star",
-  "mlhs_paren"
-];
-
-// Certain nodes are used more for organizational purposed than for actually
-// displaying content, so we tell prettier that we don't want comments attached
-// to them.
-function canAttachComment(node) {
-  return !noComments.includes(node.type);
-}
-
-// This function tells prettier how to recurse down our AST so that it can find
-// where it needs to attach the comments.
-function getCommentChildNodes(node) {
-  switch (node.type) {
-    case "heredoc":
-      return [node.beging];
-    case "aryptn":
-      return [node.body[0]]
-        .concat(node.body[1])
-        .concat(node.body[2])
-        .concat(node.body[3]);
-    case "hshptn": {
-      const pairs = node.body[1];
-      const values = pairs.reduce((left, right) => left.concat(right), []);
-
-      return [node.body[0]].concat(values).concat(node.body[2]);
-    }
-    case "params": {
-      const [reqs, optls, rest, post, kwargs, kwargRest, block] = node.body;
-      let parts = reqs || [];
-
-      (optls || []).forEach((optl) => {
-        parts = parts.concat(optl);
-      });
-
-      if (rest) {
-        parts.push(rest);
-      }
-
-      parts = parts.concat(post || []);
-
-      (kwargs || []).forEach((kwarg) => {
-        if (kwarg[1]) {
-          parts = parts.concat(kwarg);
-        } else {
-          parts.push(kwarg[0]);
-        }
-      });
-
-      if (kwargRest && kwargRest !== "nil") {
-        parts.push(kwargRest);
-      }
-
-      if (block) {
-        parts.push(block);
-      }
-
-      return parts;
-    }
-    default: {
-      if (Array.isArray(node.body)) {
-        return node.body.filter((child) => child && typeof child === "object");
-      }
-      return [];
-    }
-  }
-}
-
-// This is the generic print function for any comment in the AST. It handles
-// both regular comments that begin with a # and embdoc comments, which are
-// surrounded by =begin..=end.
-function printComment(path, _opts) {
-  const comment = path.getValue();
-
-  if (comment.type === "@comment") {
-    return `#${comment.value}`;
-  }
-
-  return concat([trim, comment.value]);
-}
-
-// To be honest I'm not 100% sure this function is actually necessary, but it
-// *feels* like a block comment equivalent in JavaScript so I'm going to leave
-// it in place for now.
-function isBlockComment(comment) {
-  return comment.type === "@embdoc";
-}
-
-// This function handles adding the format pragma to a source string. This is an
-// optional workflow for incremental adoption.
-function insertPragma(text) {
-  const boundary = text.startsWith("#") ? "\n" : "\n\n";
-
-  return `# @format${boundary}${text}`;
-}
-
-module.exports = {
-  embed,
-  print: printNode,
-  hasPrettierIgnore,
-  canAttachComment,
-  getCommentChildNodes,
-  printComment,
-  isBlockComment,
-  insertPragma
-};

data/src/ruby/toProc.js

@@ -1,105 +0,0 @@
-const isCall = (node) => ["::", "."].includes(node) || node.type === "@period";
-
-// If you have a simple block that only calls a method on the single required
-// parameter that is passed to it, then you can replace that block with the
-// simpler `Symbol#to_proc`. Meaning, it would go from:
-//
-//     [1, 2, 3].map { |i| i.to_s }
-//
-// to:
-//
-//     [1, 2, 3].map(&:to_s)
-//
-// This works with `do` blocks as well.
-const toProc = (path, node) => {
-  const [variables, blockContents] = node.body;
-
-  // Ensure that there are variables being passed to this block.
-  const params = variables && variables.body[0];
-  if (!params) {
-    return null;
-  }
-
-  // Ensure there is one and only one parameter, and that it is required.
-  const reqParams = params.body[0];
-  const otherParams = params.body.slice(1);
-  if (
-    !Array.isArray(reqParams) ||
-    reqParams.length !== 1 ||
-    otherParams.some(Boolean)
-  ) {
-    return null;
-  }
-
-  let statements;
-  if (blockContents.type === "bodystmt") {
-    // We’re in a `do` block
-    const blockStatements = blockContents.body[0];
-    const rescueElseEnsure = blockContents.body.slice(1);
-
-    // You can’t use the to_proc shortcut if you’re rescuing
-    if (rescueElseEnsure.some(Boolean)) {
-      return null;
-    }
-
-    statements = blockStatements;
-  } else {
-    // We’re in a brace block
-    statements = blockContents;
-  }
-
-  // Ensure the block contains only one statement
-  if (statements.body.length !== 1) {
-    return null;
-  }
-
-  // Ensure that statement is a call and that it has no comments attached
-  const [statement] = statements.body;
-  if (statement.type !== "call" || statement.comments) {
-    return null;
-  }
-
-  // Ensure the call is a method of the block argument
-  const [varRef, call, method, args] = statement.body;
-
-  if (
-    varRef.type !== "var_ref" ||
-    varRef.body[0].body !== reqParams[0].body ||
-    !isCall(call) ||
-    method.type !== "@ident" ||
-    args
-  ) {
-    return null;
-  }
-
-  // Ensure that we're not inside of a hash that is being passed to a key that
-  // corresponds to `:if` or `:unless` to avoid problems with callbacks with
-  // Rails. For more context, see:
-  // https://github.com/prettier/plugin-ruby/issues/449
-  let assocNode = null;
-
-  if (path.getValue().type === "method_add_block") {
-    assocNode = path.getParentNode();
-  } else {
-    assocNode = path.getParentNode(2);
-  }
-
-  if (assocNode && assocNode.type === "assoc_new") {
-    const [key] = assocNode.body;
-
-    if (key.type === "@label" && ["if:", "unless:"].includes(key.body)) {
-      return null;
-    }
-
-    if (
-      key.type === "symbol_literal" &&
-      ["if", "unless"].includes(key.body[0].body)
-    ) {
-      return null;
-    }
-  }
-
-  return `&:${method.body}`;
-};
-
-module.exports = toProc;

data/src/utils/containsAssignment.js

@@ -1,11 +0,0 @@
-// If the node is a type of assignment or if the node is a paren and nested
-// inside that paren is a node that is a type of assignment.
-function containsAssignment(node) {
-  return (
-    node &&
-    (["assign", "massign", "opassign"].includes(node.type) ||
-      (Array.isArray(node.body) && node.body.some(containsAssignment)))
-  );
-}
-
-module.exports = containsAssignment;

data/src/utils/getTrailingComma.js

@@ -1,5 +0,0 @@
-function getTrailingComma(opts) {
-  return ["all", "es5"].includes(opts.trailingComma);
-}
-
-module.exports = getTrailingComma;

data/src/utils/hasAncestor.js

@@ -1,17 +0,0 @@
-function hasAncestor(path, types) {
-  let parent = 0;
-  let parentNode = path.getParentNode();
-
-  while (parentNode) {
-    if (types.includes(parentNode.type)) {
-      return true;
-    }
-
-    parent += 1;
-    parentNode = path.getParentNode(parent);
-  }
-
-  return false;
-}
-
-module.exports = hasAncestor;

data/src/utils/isEmptyBodyStmt.js

@@ -1,7 +0,0 @@
-const isEmptyStmts = require("./isEmptyStmts");
-
-function isEmptyBodyStmt(node) {
-  return isEmptyStmts(node.body[0]) && !node.body.slice(1).some(Boolean);
-}
-
-module.exports = isEmptyBodyStmt;

data/src/utils/isEmptyStmts.js

@@ -1,11 +0,0 @@
-function isEmptyStmts(node) {
-  return (
-    node &&
-    node.type === "stmts" &&
-    node.body.length === 1 &&
-    node.body[0].type === "void_stmt" &&
-    !node.body[0].comments
-  );
-}
-
-module.exports = isEmptyStmts;

data/src/utils/literal.js

@@ -1,7 +0,0 @@
-function literal(value) {
-  return function printLiteral() {
-    return value;
-  };
-}
-
-module.exports = literal;

data/src/utils/literallineWithoutBreakParent.js

@@ -1,7 +0,0 @@
-const literallineWithoutBreakParent = {
-  type: "line",
-  hard: true,
-  literal: true
-};
-
-module.exports = literallineWithoutBreakParent;

data/src/utils/makeCall.js

@@ -1,14 +0,0 @@
-function makeCall(path, opts, print) {
-  const operation = path.getValue().body[1];
-
-  // Ignoring the next block for coverage information because it's only relevant
-  // in Ruby 2.5 and below.
-  /* istanbul ignore next */
-  if ([".", "&."].includes(operation)) {
-    return operation;
-  }
-
-  return operation === "::" ? "." : path.call(print, "body", 1);
-}
-
-module.exports = makeCall;

data/src/utils/noIndent.js

@@ -1,10 +0,0 @@
-const noIndent = [
-  "array",
-  "hash",
-  "heredoc",
-  "if",
-  "unless",
-  "xstring_literal"
-];
-
-module.exports = noIndent;

data/src/utils/printEmptyCollection.js

@@ -1,49 +0,0 @@
-const { concat, group, hardline, indent, join, line } = require("../prettier");
-
-function containedWithin(node) {
-  return function containedWithinNode(comment) {
-    return comment.sc >= node.sc && comment.ec <= node.ec;
-  };
-}
-
-// Empty collections are array or hash literals that do not contain any
-// contents. They can, however, have comments inside the body. You can solve
-// this by having a child node inside the array that gets the comments attached
-// to it, but that requires modifying the parser. Instead, we can just manually
-// print out the non-leading comments here.
-function printEmptyCollection(path, opts, startToken, endToken) {
-  const node = path.getValue();
-  const containedWithinNode = containedWithin(node);
-
-  // If there are no comments or only leading comments, then we can just print
-  // out the start and end token and be done, as there are no comments inside
-  // the body of this node.
-  if (!node.comments || !node.comments.some(containedWithinNode)) {
-    return `${startToken}${endToken}`;
-  }
-
-  const comments = [];
-
-  // For each comment, go through its path and print it out manually.
-  const printComment = (commentPath) => {
-    const comment = commentPath.getValue();
-
-    if (containedWithinNode(comment)) {
-      comment.printed = true;
-      comments.push(opts.printer.printComment(commentPath));
-    }
-  };
-
-  path.each(printComment, "comments");
-
-  return group(
-    concat([
-      startToken,
-      indent(concat([hardline, join(hardline, comments)])),
-      line,
-      endToken
-    ])
-  );
-}
-
-module.exports = printEmptyCollection;

data/src/utils/skipAssignIndent.js

@@ -1,17 +0,0 @@
-const skippable = [
-  "array",
-  "dyna_symbol",
-  "hash",
-  "heredoc",
-  "lambda",
-  "regexp_literal"
-];
-
-function skipAssignIndent(node) {
-  return (
-    skippable.includes(node.type) ||
-    (node.type === "call" && skipAssignIndent(node.body[0]))
-  );
-}
-
-module.exports = skipAssignIndent;

data/src/utils.js

@@ -1,13 +0,0 @@
-module.exports = {
-  containsAssignment: require("./utils/containsAssignment"),
-  getTrailingComma: require("./utils/getTrailingComma"),
-  isEmptyBodyStmt: require("./utils/isEmptyBodyStmt"),
-  isEmptyStmts: require("./utils/isEmptyStmts"),
-  hasAncestor: require("./utils/hasAncestor"),
-  literal: require("./utils/literal"),
-  literallineWithoutBreakParent: require("./utils/literallineWithoutBreakParent"),
-  makeCall: require("./utils/makeCall"),
-  noIndent: require("./utils/noIndent"),
-  printEmptyCollection: require("./utils/printEmptyCollection"),
-  skipAssignIndent: require("./utils/skipAssignIndent")
-};