prettier-plugin-solidity/src/slang-utils/is-comment.ts

A Prettier Plugin for automatically formatting your Solidity code.

import { TerminalKind } from '@nomicfoundation/slang/cst';
import { createKindCheckFunction } from './create-kind-check-function.js';

import type { Node } from '@nomicfoundation/slang/cst';
import type { AstNode, BlockComment, Comment } from '../slang-nodes/types.d.ts';

export const isBlockComment = createKindCheckFunction([
  TerminalKind.MultiLineComment,
  TerminalKind.MultiLineNatSpecComment
]) as (node: AstNode | Node) => node is BlockComment;

export const isComment = createKindCheckFunction([
  TerminalKind.MultiLineComment,
  TerminalKind.MultiLineNatSpecComment,
  TerminalKind.SingleLineComment,
  TerminalKind.SingleLineNatSpecComment
]) as (node: AstNode | Node) => node is Comment;