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

A prettier plugins to sort imports in provided RegEx order

import { type ImportDeclaration } from '@babel/types';
import { naturalSort, naturalSortCaseSensitive } from './natural-sort';
import type { PluginConfig } from '../plugin';

/**
 * This function returns import nodes with alphabetically sorted module
 * specifiers.
 *
 * Type imports are sorted separately, and placed after value imports.
 *
 * Comments need to be fixed up so they attach to the right objects.
 *
 * @param node Import declaration node
 */
export const getSortedImportSpecifiers = (
  node: ImportDeclaration,
  options?: Pick<PluginConfig, 'importOrderCaseSensitive'>,
) => {
  const { importOrderCaseSensitive } = options || {};
  node.specifiers.sort((a, b) => {
    if (a.type !== b.type) {
      return a.type === 'ImportDefaultSpecifier' ? -1 : 1;
    }
    if (
      a.type === 'ImportSpecifier' &&
      b.type === 'ImportSpecifier' &&
      a.importKind !== b.importKind
    ) {
      // flow uses null for value import specifiers
      return a.importKind === 'value' || a.importKind == null ? -1 : 1;
    }
    const sortFn = importOrderCaseSensitive
      ? naturalSortCaseSensitive
      : naturalSort;
    return sortFn(a.local.name, b.local.name);
  });
  return node;
};