prettier-plugin-solidity/src/slang-comments/handlers/handle-yul-block-comments.ts

A Prettier Plugin for automatically formatting your Solidity code.

import { NonterminalKind } from '@nomicfoundation/slang/cst';
import { util } from 'prettier';

import type { HandlerParams } from './types.d.ts';

const { addLeadingComment, addDanglingComment } = util;

export default function handleYulBlockComments({
  precedingNode,
  enclosingNode,
  followingNode,
  comment
}: HandlerParams): boolean {
  if (enclosingNode?.kind !== NonterminalKind.YulBlock) {
    return false;
  }

  if (
    precedingNode?.kind === NonterminalKind.YulStatements &&
    precedingNode.items.length === 0
  ) {
    addDanglingComment(precedingNode, comment, false);
    return true;
  }

  if (
    followingNode?.kind === NonterminalKind.YulStatements &&
    followingNode.items.length > 0
  ) {
    addLeadingComment(followingNode.items[0], comment);
    return true;
  }

  return false;
}