Prettier 插件排序导入项教程

项目介绍

prettier-plugin-sort-imports 是一个 Prettier 插件，用于按照提供的正则表达式顺序对导入声明进行排序，同时保留副作用导入的顺序。该项目基于 @trivago/prettier-plugin-sort-imports，但增加了以下特性：

• 不会跨副作用导入重新排序
• 合并来自同一源的导入
• 合并类型和值导入（如果 importOrderTypeScriptVersion 设置为 "4.5.0" 或更高）
• 使用 <TYPES> 关键字对类型导入进行分组
• 将 Node.js 内置模块排序到顶部（可配置使用 <BUILTIN_MODULES> 关键字）
• 支持自定义导入顺序分隔
• 正确处理导入周围的注释
• 简化选项以便于配置

项目快速启动

安装

你可以使用以下命令安装 prettier-plugin-sort-imports：

npm install --save-dev @ianvs/prettier-plugin-sort-imports

或者使用 Yarn：

yarn add --dev @ianvs/prettier-plugin-sort-imports

配置

在你的 Prettier 配置文件中添加以下配置：

// @ts-check
/** @type {import("prettier").Config} */
module.exports = {
  // 标准 Prettier 选项
  singleQuote: true,
  semi: true,
  // 自 Prettier 3.0 起，手动指定插件是必需的
  plugins: ['@ianvs/prettier-plugin-sort-imports'],
  // 该插件的选项
  importOrder: [
    '^@core/(.*)$',
    '',
    '^@server/(.*)$',
    '',
    '^@ui/(.*)$',
    '',
    '^[./]'
  ],
  importOrderSeparation: true,
  importOrderSortSpecifiers: true
};

应用案例和最佳实践

案例1：组织导入顺序

假设你有以下导入声明：

import { useEffect, useRef } from 'react';
import { createConnection } from '@server/database';
import { createServer } from '@server/node';
import { initializeApp } from '@core/app';
import { logger } from '@core/logger';
import { Alert } from '@ui/Alert';
import { Popup } from '@ui/Popup';
import { Message } from ' /Message';
import { add, filter, repeat } from ' /utils';

使用 prettier-plugin-sort-imports 插件后，导入声明将按照配置的顺序进行排序：

import { add, filter, repeat } from ' /utils';
import { Message } from ' /Message';
import { useEffect, useRef } from 'react';
import { initializeApp } from '@core/app';
import { logger } from '@core/logger';
import { createConnection } from '@server/database';
import { createServer } from '@server/node';
import { Alert } from '@ui/Alert';
import { Popup } from '@ui/Popup';

最佳实践

• 保持一致性：确保团队成员使用相同的配置文件，以保持代码风格的一致性。
• 自定义顺序：根据项目需求自定义导入顺序，以便更好地组织代码。
• 避免副作用导入：尽量避免使用副作用导入，以减少插件处理的复杂性。

典型生态项目

Prettier

prettier-plugin-sort-imports 是基于 Prettier 的一个插件。Prettier 是一个流行的代码格式化工具，支持多种编程语言，并提供一致的代码风格。

TypeScript

TypeScript 是 JavaScript 的一个超集，提供了静态类型检查。prettier-plugin-sort-imports 支持 TypeScript 的导入声明排序，特别是在 TypeScript 4.5.0 及以上版本中，可以更好地处理类型和值导入的合并。

React

React 是一个用于构建用户界面的 JavaScript 库。在 React 项目中，prettier-plugin-sort-imports 可以帮助