prettier-plugin-solidity/src/slang-nodes/SourceUnit.ts

A Prettier Plugin for automatically formatting your Solidity code.

import { doc } from 'prettier';
import { NonterminalKind } from '@nomicfoundation/slang/cst';
import { getNodeMetadata, updateMetadata } from '../slang-utils/metadata.js';
import { SourceUnitMembers } from './SourceUnitMembers.js';

import type * as ast from '@nomicfoundation/slang/ast';
import type { AstPath, Doc, ParserOptions } from 'prettier';
import type { AstNode } from './types.d.ts';
import type { PrintFunction, SlangNode } from '../types.d.ts';

const { line } = doc.builders;

export class SourceUnit implements SlangNode {
  readonly kind = NonterminalKind.SourceUnit;

  comments;

  loc;

  members: SourceUnitMembers;

  constructor(ast: ast.SourceUnit, options: ParserOptions<AstNode>) {
    let metadata = getNodeMetadata(ast);

    this.members = new SourceUnitMembers(ast.members, options);

    metadata = updateMetadata(metadata, [this.members]);

    // Because of comments being extracted like a russian doll, the order needs
    // to be fixed at the end.
    this.comments = metadata.comments.sort((a, b) => a.loc.start - b.loc.start);
    this.loc = metadata.loc;
  }

  print(
    path: AstPath<SourceUnit>,
    print: PrintFunction,
    options: ParserOptions<AstNode>
  ): Doc {
    return [
      path.call(print, 'members'),
      // Prettier's Markdown formatter already appends a new line on code
      // blocks, therefore we avoid trailing with a new line at the end of
      // a file in this case.
      // https://github.com/prettier-solidity/prettier-plugin-solidity/issues/764
      options.parentParser ? '' : line
    ];
  }
}