prettier-plugin-imports/src/utils/get-chunk-type-of-node.test.ts

A prettier plugins to sort imports in provided RegEx order

import { expect, test } from 'vitest';
import { chunkTypeOther, chunkTypeUnsortable } from '../constants';
import { getChunkTypeOfNode } from './get-chunk-type-of-node';
import { getImportNodes } from './get-import-nodes';

test('it classifies a default import as other', () => {
  const importNodes = getImportNodes(`import a from "a";`);
  expect(importNodes.length).toBe(1);
  expect(getChunkTypeOfNode(importNodes[0])).toBe(chunkTypeOther);
});

test('it classifies a named import as other', () => {
  const importNodes = getImportNodes(`import {a} from "a";`);
  expect(importNodes.length).toBe(1);
  expect(getChunkTypeOfNode(importNodes[0])).toBe(chunkTypeOther);
});

test('it classifies a type import as other', () => {
  const importNodes = getImportNodes(`import type {a, b} from "a";`, {
    plugins: ['typescript'],
  });
  expect(importNodes.length).toBe(1);
  expect(getChunkTypeOfNode(importNodes[0])).toBe(chunkTypeOther);
});

test('it classifies an import with type modifiers as other', () => {
  const importNodes = getImportNodes(`import {type a, b} from "a";`, {
    plugins: ['typescript'],
  });
  expect(importNodes.length).toBe(1);
  expect(getChunkTypeOfNode(importNodes[0])).toBe(chunkTypeOther);
});

test('it classifies a side-effect import as unsortable', () => {
  const importNodes = getImportNodes(`import "a";`);
  expect(importNodes.length).toBe(1);
  expect(getChunkTypeOfNode(importNodes[0])).toBe(chunkTypeUnsortable);
});

test('it classifies a named import with an ignore next line comment as unsortable', () => {
  const importNodes = getImportNodes(`// prettier-ignore
    import {a} from "a";`);
  expect(importNodes.length).toBe(1);
  expect(getChunkTypeOfNode(importNodes[0])).toBe(chunkTypeUnsortable);
});

test('it classifies a side-effect import with a ignore next line comment as unsortable', () => {
  const importNodes = getImportNodes(`// prettier-ignore
    import "a";`);
  expect(importNodes.length).toBe(1);
  expect(getChunkTypeOfNode(importNodes[0])).toBe(chunkTypeUnsortable);
});

test('it classifies a type import with an ignore next line comment as unsortable', () => {
  const importNodes = getImportNodes(
    `// prettier-ignore
    import type { a } from "a";`,
    { plugins: ['typescript'] },
  );
  expect(importNodes.length).toBe(1);
  expect(getChunkTypeOfNode(importNodes[0])).toBe(chunkTypeUnsortable);
});

test('it classifies an import with a type modifier and an ignore next line comment as unsortable', () => {
  const importNodes = getImportNodes(
    `// prettier-ignore
    import { a, type b } from "a";`,
    { plugins: ['typescript'] },
  );
  expect(importNodes.length).toBe(1);
  expect(getChunkTypeOfNode(importNodes[0])).toBe(chunkTypeUnsortable);
});

test('it only applies the ignore next line comments to the next line', () => {
  const importNodes = getImportNodes(`// prettier-ignore
    import {b} from "b";
    import {a} from "a";`);
  expect(importNodes.length).toBe(2);
  expect(getChunkTypeOfNode(importNodes[0])).toBe(chunkTypeUnsortable);
  expect(getChunkTypeOfNode(importNodes[1])).toBe(chunkTypeOther);
});