prettier-plugin-imports/src/utils/get-all-comments-from-nodes.test.ts

A prettier plugins to sort imports in provided RegEx order

import { expect, test } from 'vitest';
import { DEFAULT_IMPORT_ORDER } from '../constants';
import { getAllCommentsFromNodes } from './get-all-comments-from-nodes';
import { getImportNodes } from './get-import-nodes';
import { getSortedNodes } from './get-sorted-nodes';
import { testingOnly } from './normalize-plugin-options';
import type { ParserOptions } from '@babel/parser';
import type {
  CommentBlock,
  CommentLine,
  ImportDeclaration,
} from '@babel/types';

const getSortedImportNodes = (code: string, options?: ParserOptions) => {
  const importNodes: ImportDeclaration[] = getImportNodes(code, options);

  return getSortedNodes(importNodes, {
    importOrder: testingOnly.normalizeImportOrderOption(DEFAULT_IMPORT_ORDER),
    importOrderCombineTypeAndValueImports: true,
  });
};

const getComments = (commentNodes: (CommentBlock | CommentLine)[]) =>
  commentNodes.map((node) => node.value);

test('it returns empty array when there is no comment', () => {
  const result = getSortedImportNodes(`import z from 'z';
    `);
  const commentNodes = getAllCommentsFromNodes(result);
  const comments = getComments(commentNodes);
  expect(comments).toEqual([]);
});

test('it returns single comment of a node', () => {
  const result = getSortedImportNodes(`// first comment
import z from 'z';
`);
  const commentNodes = getAllCommentsFromNodes(result);
  const comments = getComments(commentNodes);
  expect(comments).toEqual([' first comment']);
});

test('it returns all comments for a node', () => {
  const result = getSortedImportNodes(`// first comment
// second comment
import z from 'z';
`);
  const commentNodes = getAllCommentsFromNodes(result);
  const comments = getComments(commentNodes);
  expect(comments).toEqual([' first comment', ' second comment']);
});

test('it returns comment block for a node', () => {
  const result = getSortedImportNodes(`
/**
 * some block
 */
import z from 'z';
`);
  const commentNodes = getAllCommentsFromNodes(result);
  const comments = getComments(commentNodes);
  expect(comments).toEqual(['*\n * some block\n ']);
});