TypeScript ESLint 规则优化:建议用 PropertyKey 替代 keyof any
2025-05-14 21:12:57作者:管翌锬
在 TypeScript 开发中,keyof any 是一个常见但可能令人困惑的类型表达式。typescript-eslint 项目中的 no-explicit-any 规则最近提出了一个增强建议:当检测到 keyof any 时,建议开发者使用更明确的 PropertyKey 类型。
背景知识
在 TypeScript 类型系统中,keyof any 表示可以作为对象键的类型,其实际类型是 string | number | symbol 的联合类型。TypeScript 提供了一个内置的实用类型 PropertyKey 来精确表示这个概念。
问题现状
当前,许多开发者可能直接从其他代码中复制了 keyof any 的用法,但并不完全理解其含义。这会导致:
- 代码可读性降低
- 新手开发者困惑
- 类型表达不够直观
解决方案
typescript-eslint 的 no-explicit-any 规则计划增加一个检查,当发现 keyof any 时:
- 报告为可修复的问题
- 建议使用
PropertyKey替代 - 提供自动修复功能
代码示例对比
改进前代码
const integer = <TKey extends keyof any, TTarget extends { [K in TKey]: number }>(
target: TTarget,
key: TKey
) => { /* ... */ };
改进后代码
const integer = <TKey extends PropertyKey, TTarget extends { [K in TKey]: number }>(
target: TTarget,
key: TKey
) => { /* ... */ };
技术优势
- 语义更明确:
PropertyKey直接表达了"可作为属性键的类型"的意图 - 一致性更好:使用标准库提供的类型而非语言特性
- 可维护性:减少了对 TypeScript 特定语法的依赖
- 工具支持:IDE 对内置类型的支持通常更好
实现考虑
这个改进可以作为一个可选规则加入,因为:
- 不影响现有代码行为
- 完全向后兼容
- 可以通过自动修复无痛升级
- 对性能无影响
总结
这个改进虽然看似微小,但对于提升 TypeScript 代码的质量和可读性有着重要意义。它体现了 TypeScript 社区对代码清晰性和一致性的持续追求,也是 typescript-eslint 工具不断完善的一个例证。
登录后查看全文
热门项目推荐
相关项目推荐
atomcodeClaude Code 的开源替代方案。连接任意大模型,编辑代码,运行命令,自动验证 — 全自动执行。用 Rust 构建,极致性能。 | An open-source alternative to Claude Code. Connect any LLM, edit code, run commands, and verify changes — autonomously. Built in Rust for speed. Get StartedRust0148- DDeepSeek-V4-ProDeepSeek-V4-Pro(总参数 1.6 万亿,激活 49B)面向复杂推理和高级编程任务,在代码竞赛、数学推理、Agent 工作流等场景表现优异,性能接近国际前沿闭源模型。Python00
GLM-5.1GLM-5.1是智谱迄今最智能的旗舰模型,也是目前全球最强的开源模型。GLM-5.1大大提高了代码能力,在完成长程任务方面提升尤为显著。和此前分钟级交互的模型不同,它能够在一次任务中独立、持续工作超过8小时,期间自主规划、执行、自我进化,最终交付完整的工程级成果。Jinja00
auto-devAutoDev 是一个 AI 驱动的辅助编程插件。AutoDev 支持一键生成测试、代码、提交信息等,还能够与您的需求管理系统(例如Jira、Trello、Github Issue 等)直接对接。 在IDE 中,您只需简单点击,AutoDev 会根据您的需求自动为您生成代码。Kotlin03
Intern-S2-PreviewIntern-S2-Preview,这是一款高效的350亿参数科学多模态基础模型。除了常规的参数与数据规模扩展外,Intern-S2-Preview探索了任务扩展:通过提升科学任务的难度、多样性与覆盖范围,进一步释放模型能力。Python00
skillhubopenJiuwen 生态的 Skill 托管与分发开源方案,支持自建与可选 ClawHub 兼容。Python0111
项目优选
收起
暂无描述
Dockerfile
731
4.73 K
Ascend Extension for PyTorch
Python
609
786
本项目是CANN提供的数学类基础计算算子库,实现网络在NPU上加速计算。
C++
1 K
1.01 K
openEuler内核是openEuler操作系统的核心,既是系统性能与稳定性的基石,也是连接处理器、设备与服务的桥梁。
C
433
392
华为昇腾面向大规模分布式训练的多模态大模型套件,支撑多模态生成、多模态理解。
Python
145
237
Claude Code 的开源替代方案。连接任意大模型,编辑代码,运行命令,自动验证 — 全自动执行。用 Rust 构建,极致性能。 | An open-source alternative to Claude Code. Connect any LLM, edit code, run commands, and verify changes — autonomously. Built in Rust for speed.
Get Started
Rust
1.15 K
148
暂无简介
Dart
983
250
Oohos_react_native
React Native鸿蒙化仓库
C++
347
401
昇腾LLM分布式训练框架
Python
166
197
🎉 (RuoYi)官方仓库 基于SpringBoot,Spring Security,JWT,Vue3 & Vite、Element Plus 的前后端分离权限管理系统
Vue
1.67 K
985