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

A Prettier Plugin for automatically formatting your Solidity code.

import { doc } from 'prettier';
import { NonterminalKind } from '@nomicfoundation/slang/cst';
import { sortContractSpecifiers } from '../slang-utils/sort-contract-specifiers.js';
import { printSeparatedList } from '../slang-printers/print-separated-list.js';
import { getNodeMetadata, updateMetadata } from '../slang-utils/metadata.js';
import { ContractSpecifier } from './ContractSpecifier.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 { group, ifBreak, line, softline } = doc.builders;

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

  comments;

  loc;

  items: ContractSpecifier[];

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

    this.items = ast.items.map((item) => new ContractSpecifier(item, options));

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

    this.comments = metadata.comments;
    this.loc = metadata.loc;

    this.items = this.items.sort(sortContractSpecifiers);
  }

  print(path: AstPath<ContractSpecifiers>, print: PrintFunction): Doc {
    if (this.items.length === 0) return '';

    const [specifier1, specifier2] = path.map(print, 'items');
    if (typeof specifier2 === 'undefined') return [' ', specifier1];

    const groupId = Symbol('Slang.ContractSpecifiers.inheritance');
    return printSeparatedList(
      [group(specifier1, { id: groupId }), specifier2],
      {
        firstSeparator: line,
        separator: ifBreak('', softline, { groupId })
      }
    );
  }
}