如何在eslint-plugin-unicorn项目中创建新规则

如何在eslint-plugin-unicorn项目中创建新规则

eslint-plugin-unicorn More than 100 powerful ESLint rules 项目地址: https://gitcode.com/gh_mirrors/es/eslint-plugin-unicorn

eslint-plugin-unicorn是一个提供高质量ESLint规则的插件，本文将详细介绍如何为该项目贡献新规则。

前期准备

在开始创建新规则前，需要确认以下几点：

1. 确认ESLint核心规则中尚未包含该功能
2. 熟悉ESLint官方文档中关于创建新规则的部分
3. 参考项目中已有规则的实现方式，了解编码风格和最佳实践

工具推荐

使用AST Explorer工具可以极大提高开发效率：

• 选择espree解析器
• 使用ESLint v4转换
• 实时查看代码的抽象语法树(AST)结构
• 测试自动修复功能的实现效果

规则创建步骤

1. 初始化规则文件

运行项目提供的脚手架命令创建规则模板文件：

npm run create-rule

这会自动生成规则实现文件、测试文件和文档模板。

2. 编写测试用例

采用测试驱动开发(TDD)方式：

• 先编写测试用例
• 包含各种边界情况和预期行为
• 确保覆盖率达到要求

3. 实现规则逻辑

在规则文件中：

• 定义规则元信息(meta)
• 实现规则逻辑
• 考虑提供自动修复功能
• 必要时提供代码建议

4. 编写规则文档

文档应包含：

• 规则用途说明
• 触发条件的代码示例
• 正确用法的代码示例
• 配置选项说明(如果有)

5. 集成测试

• 运行完整测试套件
• 在真实项目上测试规则
• 确保不会产生误报或漏报

实现注意事项

自动修复相关

1. 优先考虑提供自动修复功能
2. 自动修复必须保证不改变代码运行时行为
3. 无法自动修复时考虑提供代码建议

边界情况处理

1. 括号处理：确保表达式转换后语法正确

   // 错误示例
   1.toString()
   
   // 正确示例
   (1).toString()
   

2. 分号处理：避免ASI(自动分号插入)问题

   // 错误示例
   foo
   [1].forEach(...)
   
   // 正确示例
   foo
   ;[1].forEach(...)
   

3. 符号边界处理：注意标识符边界

   // 错误示例
   for(constfooof[])
   
   // 正确示例
   for(const foo of[])
   

4. 注释保留：自动修复不应删除原有注释

提交规则

提交PR时注意：

• 标题格式：Add rule-name rule
• 描述中关联相关issue
• 确保代码库自身也符合新规则要求

通过遵循这些指南，你可以为eslint-plugin-unicorn项目贡献高质量的ESLint规则，帮助开发者写出更健壮的JavaScript代码。

eslint-plugin-unicorn More than 100 powerful ESLint rules 项目地址: https://gitcode.com/gh_mirrors/es/eslint-plugin-unicorn