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

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

2025-07-09 04:21:39作者:俞予舒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修饰符

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

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

最新内容推荐

项目优选

收起
ohos_react_nativeohos_react_native
React Native鸿蒙化仓库
C++
176
261
RuoYi-Vue3RuoYi-Vue3
🎉 (RuoYi)官方仓库 基于SpringBoot,Spring Security,JWT,Vue3 & Vite、Element Plus 的前后端分离权限管理系统
Vue
858
511
openGauss-serveropenGauss-server
openGauss kernel ~ openGauss is an open source relational database management system
C++
129
182
openHiTLSopenHiTLS
旨在打造算法先进、性能卓越、高效敏捷、安全可靠的密码套件,通过轻量级、可剪裁的软件技术架构满足各行业不同场景的多样化要求,让密码技术应用更简单,同时探索后量子等先进算法创新实践,构建密码前沿技术底座!
C
258
298
ShopXO开源商城ShopXO开源商城
🔥🔥🔥ShopXO企业级免费开源商城系统,可视化DIY拖拽装修、包含PC、H5、多端小程序(微信+支付宝+百度+头条&抖音+QQ+快手)、APP、多仓库、多商户、多门店、IM客服、进销存,遵循MIT开源协议发布、基于ThinkPHP8框架研发
JavaScript
93
15
Cangjie-ExamplesCangjie-Examples
本仓将收集和展示高质量的仓颉示例代码,欢迎大家投稿,让全世界看到您的妙趣设计,也让更多人通过您的编码理解和喜爱仓颉语言。
Cangjie
332
1.08 K
HarmonyOS-ExamplesHarmonyOS-Examples
本仓将收集和展示仓颉鸿蒙应用示例代码,欢迎大家投稿,在仓颉鸿蒙社区展现你的妙趣设计!
Cangjie
398
371
note-gennote-gen
一款跨平台的 Markdown AI 笔记软件,致力于使用 AI 建立记录和写作的桥梁。
TSX
83
4
CangjieCommunityCangjieCommunity
为仓颉编程语言开发者打造活跃、开放、高质量的社区环境
Markdown
1.07 K
0
kernelkernel
deepin linux kernel
C
22
5