prettier-plugin-imports/src/utils/get-sorted-import-specifiers.test.ts

A prettier plugins to sort imports in provided RegEx order

import { expect, test } from 'vitest';
import { getImportNodes } from './get-import-nodes';
import { getSortedImportSpecifiers } from './get-sorted-import-specifiers';
import { getSortedNodesModulesNames } from './get-sorted-nodes-modules-names';

test('should return correct sorted nodes', () => {
  const code = `import { filter, reduce, eventHandler } from '@server/z';`;
  const [importNode] = getImportNodes(code);
  const sortedImportSpecifiers = getSortedImportSpecifiers(importNode);
  const specifiersList = getSortedNodesModulesNames(
    sortedImportSpecifiers.specifiers,
  );

  expect(specifiersList).toEqual(['eventHandler', 'filter', 'reduce']);
});

test('should return correct sorted nodes with default import', () => {
  const code = `import Component, { filter, reduce, eventHandler } from '@server/z';`;
  const [importNode] = getImportNodes(code);
  const sortedImportSpecifiers = getSortedImportSpecifiers(importNode);
  const specifiersList = getSortedNodesModulesNames(
    sortedImportSpecifiers.specifiers,
  );

  expect(specifiersList).toEqual([
    'Component',
    'eventHandler',
    'filter',
    'reduce',
  ]);
});

test('should group type imports after value imports - typescript', () => {
  const code = `import Component, { type TypeB, filter, type TypeA, reduce, eventHandler } from '@server/z';`;
  const [importNode] = getImportNodes(code, {
    plugins: ['typescript'],
  });
  const sortedImportSpecifiers = getSortedImportSpecifiers(importNode);
  const specifiersList = getSortedNodesModulesNames(
    sortedImportSpecifiers.specifiers,
  );

  expect(specifiersList).toEqual([
    'Component',
    'eventHandler',
    'filter',
    'reduce',
    'TypeA',
    'TypeB',
  ]);
});

test('should group type imports after value imports - flow', () => {
  const code = `import Component, { type TypeB, filter, type TypeA, reduce, eventHandler } from '@server/z';`;
  const [importNode] = getImportNodes(code, {
    plugins: ['flow'],
  });
  const sortedImportSpecifiers = getSortedImportSpecifiers(importNode);
  const specifiersList = getSortedNodesModulesNames(
    sortedImportSpecifiers.specifiers,
  );

  expect(specifiersList).toEqual([
    'Component',
    'eventHandler',
    'filter',
    'reduce',
    'TypeA',
    'TypeB',
  ]);
});

test('should sort case-sensitively', () => {
  const code = `import { ExampleComponent, ExamplesList, ExampleWidget } from '@components/e';`;
  const [importNode] = getImportNodes(code);
  const sortedImportSpecifiers = getSortedImportSpecifiers(importNode, {
    importOrderCaseSensitive: true,
  });
  const specifiersList = getSortedNodesModulesNames(
    sortedImportSpecifiers.specifiers,
  );

  expect(specifiersList).toEqual([
    'ExampleComponent',
    'ExampleWidget',
    'ExamplesList',
  ]);
});