在eslint-plugin-perfectionist中配置接口成员排序规则

eslint-plugin-perfectionist是一个强大的ESLint插件，专门用于强制代码中的各种元素保持一致的排序。其中sort-interfaces规则允许开发者对TypeScript接口中的成员进行排序，这对于保持代码整洁和可读性非常重要。

接口成员排序的基本配置

sort-interfaces规则支持多种排序方式，最常用的是按字母顺序排序。基本配置如下：

"perfectionist/sort-interfaces": [
    "error",
    {
        "type": "alphabetical",
        "order": "asc"
    }
]

这种配置会简单地按照字母升序排列接口中的所有成员。

按属性类型分组排序

在实际开发中，我们经常希望将接口中的属性（properties）和方法（methods）分开排序。eslint-plugin-perfectionist从3.9.0版本开始，提供了预定义的分组功能来实现这一需求。

使用预定义分组

最新版本中可以直接使用"property"和"method"这两个预定义分组：

"perfectionist/sort-interfaces": [
    "error",
    {
        "type": "alphabetical",
        "order": "asc",
        "groups": ["property", "method"]
    }
]

这种配置会先将所有属性按字母顺序排列，然后再排列所有方法。

自定义正则表达式分组

在早期版本中，开发者需要通过自定义正则表达式来实现这一功能：

"perfectionist/sort-interfaces": [
    "error",
    {
        "type": "alphabetical",
        "order": "asc",
        "groups": ["attributes", "methods"],
        "matcher": "regex",
        "customGroups": {
            "attributes": "^(?!.*\\(.*\\))",
            "methods": "^.*\\(.*\\)$"
        }
    }
]

这里的正则表达式：

• ^(?!.*\\(.*\\)) 匹配不包含括号的属性（即非函数属性）
• ^.*\\(.*\\)$ 匹配包含括号的属性（即函数方法）

为什么需要分组排序

将属性和方法分开排序有以下几个好处：

1. 提高可读性：属性通常表示状态，方法表示行为，分开后代码结构更清晰
2. 便于维护：相关功能的属性和方法更容易定位
3. 符合习惯：许多代码风格指南推荐这种组织方式

实际应用示例

假设我们有一个React组件Props接口：

// 未排序的接口
interface Props {
    onOpenUrl: () => void;
    url: string;
    children: ReactNode;
    onClick: (event: MouseEvent) => void;
    disabled: boolean;
}

应用排序规则后：

// 排序后的接口（属性在前，方法在后）
interface Props {
    children: ReactNode;
    disabled: boolean;
    url: string;
    onClick: (event: MouseEvent) => void;
    onOpenUrl: () => void;
}

总结

eslint-plugin-perfectionist的sort-interfaces规则提供了灵活的接口成员排序选项。通过合理配置分组，可以使代码结构更加清晰有序。最新版本中的预定义分组简化了配置过程，使这一功能更易于使用。对于TypeScript项目，特别是大型项目，采用这种排序规范可以显著提高代码的可维护性。