首页
/ Angular ESLint 新增规则:强制信号(Signal)声明为只读

Angular ESLint 新增规则:强制信号(Signal)声明为只读

2025-07-09 04:41:01作者:俞予舒Fleming

在 Angular 16 中引入的信号(Signal)机制是现代 Angular 应用状态管理的核心特性之一。信号提供了一种响应式的方式来管理应用状态,但为了确保信号的使用符合最佳实践,Angular ESLint 工具新增了 prefer-signals 规则,其中包含了强制信号声明为只读的重要检查。

为什么需要强制信号为只读

信号的核心设计理念是通过特定的方法(set()update())来修改其值,而不是直接重新赋值。将信号声明为readonly可以:

  1. 防止意外地直接覆盖信号变量
  2. 明确表达开发者的意图:这个变量应该通过信号API来操作
  3. 提高代码的可维护性和一致性
  4. 在编译阶段就能捕获潜在的错误用法

规则覆盖的信号类型

该规则会检查以下Angular信号创建函数的返回值是否被声明为readonly

  • signal() - 基础信号创建函数
  • computed() - 计算信号,基于其他信号派生值
  • input() - 组件输入信号
  • model() - 双向绑定信号
  • toSignal() - 从RxJS可观察对象转换的信号
  • 查询相关的信号函数:
    • contentChild()
    • contentChildren()
    • viewChild()
    • viewChildren()

正确与错误示例

错误用法(会被规则标记):

count = signal(0);  // 缺少readonly修饰符
userData = computed(() => fetchUserData()); 
initialValue = input(10);

正确用法

readonly count = signal(0);
readonly userData = computed(() => fetchUserData());
readonly initialValue = input(10);

技术实现原理

该规则通过以下方式工作:

  1. 识别TypeScript变量声明
  2. 检查变量初始化表达式是否调用了特定的信号创建函数
  3. 验证变量是否被readonly修饰符标记
  4. 对于不符合要求的声明,提供自动修复建议

与其他规则的关系

值得注意的是,output()函数虽然也是Angular的响应式API,但它创建的是事件发射器而非信号,因此不包含在此规则中。对于output的只读检查,Angular ESLint提供了专门的prefer-output-readonly规则。

升级建议

对于现有项目:

  1. 首先升级到Angular ESLint v19或更高版本
  2. 在ESLint配置中启用prefer-signals规则
  3. 使用ESLint的--fix选项自动修复大多数可修复的问题
  4. 对于复杂情况,手动审查并添加readonly修饰符

通过采用这一规则,开发团队可以确保信号的使用更加规范和安全,减少潜在的运行时错误,提高代码的整体质量。

登录后查看全文
热门项目推荐
相关项目推荐