ESLint Stylistic 项目中 JSX 属性缩进问题的分析与解决方案

问题背景

在 React 开发中，JSX 的格式化一直是开发者关注的重点。ESLint Stylistic 项目提供了多个规则来处理 JSX 的缩进问题，包括 jsx-indent、jsx-indent-props 和通用的 indent 规则。然而，当这些规则同时启用时，在某些特定场景下会出现冲突，导致开发者难以获得一致的格式化结果。

问题重现

让我们看一个典型的场景：在条件（三元）表达式中使用 JSX 元素。开发者通常会这样编写代码：

const component = (true
  ? <button
    onClick={() => {}}
  />
  : null
);

这种情况下，开发者期望按钮元素的属性缩进为 4 个空格（相对于条件表达式的缩进级别）。然而，jsx-indent-props 规则会报告错误，要求属性缩进为 6 个空格（相对于 JSX 开始标签的位置）。

问题本质

这个问题的根源在于多个缩进规则的交互逻辑：

1. indent 规则处理整体代码结构的缩进
2. jsx-indent 处理 JSX 元素本身的缩进
3. jsx-indent-props 处理 JSX 属性的缩进

当这些规则同时作用于嵌套结构（如三元表达式中的 JSX）时，它们的缩进计算方式会产生冲突。jsx-indent-props 没有考虑到外层条件表达式已经带来的缩进级别，导致它要求的总缩进量超过了开发者的预期。

解决方案

ESLint Stylistic 团队已经意识到这个问题，并制定了长期解决方案：

1. 短期方案：开发者可以暂时禁用 jsx-indent 和 jsx-indent-props 规则，仅使用 indent 规则来处理所有缩进问题。indent 规则已经能够正确处理大多数 JSX 缩进场景。

2. 长期规划：团队计划逐步弃用 jsx-indent 和 jsx-indent-props 规则，统一使用增强版的 indent 规则来处理所有缩进场景，包括 JSX。这将从根本上解决规则间的冲突问题。

最佳实践建议

在等待官方解决方案的同时，开发者可以采取以下措施：

1. 对于新项目，建议仅配置 indent 规则，避免使用专门的 JSX 缩进规则
2. 对于现有项目，如果遇到类似问题，可以暂时调整规则配置或使用 ESLint 的 overrides 功能针对特定文件进行例外处理
3. 考虑使用 Prettier 等专门的格式化工具，它们通常能更好地处理复杂的缩进场景

总结

JSX 缩进问题在复杂表达式中尤为明显，这反映了代码格式化工具在处理嵌套结构时的挑战。ESLint Stylistic 团队正在努力统一缩进处理逻辑，为开发者提供更一致的体验。在此期间，开发者可以通过调整规则配置来获得满意的格式化结果。