prettier-plugin-imports/src/utils/get-import-nodes-matched-group.test.ts

A prettier plugins to sort imports in provided RegEx order

import { expect, test } from 'vitest';
import { getImportNodes } from './get-import-nodes';
import { getImportNodesMatchedGroup } from './get-import-nodes-matched-group';

const code = `// first comment
// second comment
import z from '@server/z';
import c from '@server/c';
import g from '@ui/g';
import t from '@core/t';
import k from 'k';
import j from './j';
import l from './l';
import a from '@core/a';
`;

const codeWithTypes = `
import z from 'z';
import type T from 't';
import {b} from 'b';
import a from './a';
import type {F} from 'f';
import type Local from './local';
`;

test('should return correct matched groups', () => {
  const importNodes = getImportNodes(code);
  const importOrder = ['^@server/(.*)$', '^@core/(.*)$', '^@ui/(.*)$', '^[./]'];

  let matchedGroups: string[] = [];
  for (const importNode of importNodes) {
    const matchedGroup = getImportNodesMatchedGroup(importNode, importOrder);
    matchedGroups.push(matchedGroup);
  }
  expect(matchedGroups).toEqual([
    '^@server/(.*)$',
    '^@server/(.*)$',
    '^@ui/(.*)$',
    '^@core/(.*)$',
    '<THIRD_PARTY_MODULES>',
    '^[./]',
    '^[./]',
    '^@core/(.*)$',
  ]);
});

test('should return THIRD_PARTY_MODULES as matched group with empty order list', () => {
  const importNodes = getImportNodes(code);
  const importOrder: string[] = [];

  for (const importNode of importNodes) {
    const matchedGroup = getImportNodesMatchedGroup(importNode, importOrder);
    expect(matchedGroup).toEqual('<THIRD_PARTY_MODULES>');
  }
});

test('should sort non-types separately from types if <TYPES> group is present', () => {
  const importNodes = getImportNodes(codeWithTypes, {
    plugins: ['typescript'],
  });
  const importOrder = ['^[./]', '<TYPES>^[./]', '<TYPES>'];

  let matchedGroups: string[] = [];
  for (const importNode of importNodes) {
    const matchedGroup = getImportNodesMatchedGroup(importNode, importOrder);
    matchedGroups.push(matchedGroup);
  }
  expect(matchedGroups).toEqual([
    '<THIRD_PARTY_MODULES>',
    '<TYPES>',
    '<THIRD_PARTY_MODULES>',
    '^[./]',
    '<TYPES>',
    '<TYPES>^[./]',
  ]);
});