Function attachComments

src/main/comments/attach.js:113–262

(ast, options)

const returnFalse = () => false;
function attachComments(ast, options) {
  const { comments } = ast;
  delete ast.comments;

  if (!isNonEmptyArray(comments) || !options.printer.canAttachComment) {
    return;
  }

  const tiesToBreak = [];
  const {
    printer: {
      features: { experimental_avoidAstMutation: avoidAstMutation },
      handleComments = {},
    },
    originalText: text,
  } = options;
  const {
    ownLine: handleOwnLineComment = returnFalse,
    endOfLine: handleEndOfLineComment = returnFalse,
    remaining: handleRemainingComment = returnFalse,
  } = handleComments;

  const decoratedComments = comments.map((comment, index) => ({
    ...decorateComment(ast, comment, options),
    comment,
    text,
    options,
    ast,
    isLastComment: comments.length - 1 === index,
    // TODO: Move placement here
    placement: undefined,
  }));

  // For easier debug, save these to comment even `avoidAstMutation`
  const attachPropertiesToComment =
    process.env.NODE_ENV !== "production" || !avoidAstMutation;

  for (const [index, context] of decoratedComments.entries()) {
    const {
      comment,
      precedingNode,
      enclosingNode,
      followingNode,
      text,
      options,
      ast,
      isLastComment,
    } = context;

    const placement = isOwnLineComment(text, options, decoratedComments, index)
      ? "ownLine"
      : isEndOfLineComment(text, options, decoratedComments, index)
        ? "endOfLine"
        : "remaining";

    let args;
    if (avoidAstMutation) {
      context.placement = placement;