ESLint-Plugin-React 中禁止组件使用带连字符的 Props 的技术探讨

背景介绍

在 React 和 TypeScript 的开发实践中，我们经常会遇到组件属性的命名规范问题。特别是在处理自定义组件时，使用带有连字符(-)的属性名(如 aria-label)会带来一些类型检查方面的挑战。

问题本质

TypeScript 在处理带有连字符的组件属性时存在一个已知的限制：它无法对这些属性进行严格的类型检查。这是因为 TypeScript 的类型系统在处理带有特殊字符(如连字符)的属性名时存在技术限制。

技术影响

对于原生 HTML 元素，如 <div>，使用带连字符的属性(如 aria-* 系列属性)是标准做法，浏览器能够正确解析。然而，当我们为自定义 React 组件设计 API 时，如果允许使用带连字符的属性名，就会导致：

1. 这些属性无法获得 TypeScript 的类型检查保护
2. 代码维护性降低，因为开发者无法通过类型系统快速发现属性使用错误
3. 潜在的运行时错误风险增加

解决方案探讨

在 eslint-plugin-react 中，可以通过扩展现有规则来实现这一限制。具体思路是：

1. 修改 forbid-component-props 规则，增加对属性名模式的匹配能力
2. 只针对自定义组件应用此限制，不影响原生 HTML 元素
3. 通过正则表达式来识别带连字符的属性名

实现建议

理想的实现方式是在规则配置中增加一个 propNamePattern 选项，允许开发者指定一个正则表达式来匹配需要禁止的属性名模式。例如：

{
  "rules": {
    "react/forbid-component-props": [
      "error",
      {
        "propNamePattern": "-",
        "message": "请使用驼峰式命名代替连字符命名"
      }
    ]
  }
}

最佳实践

基于这一限制，推荐的自定义组件属性命名规范是：

1. 对于常规属性，使用小驼峰命名法(如 myProp)
2. 对于可访问性相关属性，也使用小驼峰命名(如 ariaLabel 代替 aria-label)
3. 保持与 JavaScript/TypeScript 命名规范的一致性

总结

通过在 ESLint 中实施这一限制，开发团队可以：

1. 确保自定义组件 API 的一致性
2. 充分利用 TypeScript 的类型检查能力
3. 提高代码的可维护性和开发体验
4. 避免潜在的运行时错误

这一实践特别适合大型项目或需要长期维护的代码库，能够显著提升代码质量和开发效率。