首页
/ lint-staged 项目新增对 TypeScript 配置文件的支持

lint-staged 项目新增对 TypeScript 配置文件的支持

2025-05-16 20:35:18作者:胡易黎Nicole

随着 TypeScript 在前端生态中的普及,越来越多的工具开始原生支持 TypeScript 配置文件。近日,流行的 Git 钩子工具 lint-staged 在最新版本 v15.4.0 中正式加入了对 TypeScript 配置文件的支持。

背景与需求

lint-staged 是一个用于在 Git 暂存区文件上运行 linters 的工具,通常用于在提交前自动格式化代码和修复问题。长期以来,它支持 JavaScript 配置文件(如 lint-staged.config.js),但对于使用 TypeScript 的项目,开发者不得不采用变通方案或放弃类型检查的优势。

技术实现方案

在 Node.js 生态中,原生并不支持直接加载 TypeScript 文件。lint-staged 团队考虑了两种实现路径:

  1. 内置 TypeScript 解析器:需要引入额外的依赖,会增加包体积和复杂度
  2. 依赖 Node.js 原生能力:利用 Node.js 未来的原生 TypeScript 支持

经过评估,团队选择了第二种方案,这主要基于以下考虑:

  • 保持项目轻量,不增加额外依赖
  • Node.js 23.6.0 及以上版本已开始原生支持 TypeScript 文件
  • 对于旧版本 Node.js,开发者可以通过 ts-node 等工具实现兼容

支持的文件类型

新版本支持以下 TypeScript 配置文件格式:

  • lint-staged.config.ts - 标准 TypeScript 配置文件
  • lint-staged.config.mts - ES 模块格式的 TypeScript 配置文件
  • lint-staged.config.cts - CommonJS 模块格式的 TypeScript 配置文件

使用方法

对于不同环境,开发者可以采用以下配置方式:

Node.js 23.6.0+ 用户: 直接创建 TypeScript 配置文件即可自动识别,无需额外配置。

旧版本 Node.js 用户: 可以通过 ts-node 加载器启用支持:

NODE_OPTIONS="--loader ts-node/esm" npx lint-staged

类型支持说明

虽然支持了 TypeScript 配置文件,但需要注意的是,当前版本尚未提供内置的类型定义。这意味着开发者需要自行确保配置对象的类型正确性。团队表示未来可能会考虑添加 @types/lint-staged 包来完善类型支持。

总结

这一改进显著提升了 TypeScript 项目中使用 lint-staged 的体验,使开发者能够在配置文件中获得类型检查和自动补全等 TypeScript 优势功能。随着 Node.js 对 TypeScript 原生支持的不断完善,预计会有更多工具采用类似的方案来简化 TypeScript 项目的配置工作。

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

热门内容推荐

项目优选

收起
docsdocs
OpenHarmony documentation | OpenHarmony开发者文档
Dockerfile
152
1.96 K
kernelkernel
deepin linux kernel
C
22
6
ops-mathops-math
本项目是CANN提供的数学类基础计算算子库,实现网络在NPU上加速计算。
C++
431
34
communitycommunity
本项目是CANN开源社区的核心管理仓库,包含社区的治理章程、治理组织、通用操作指引及流程规范等基础信息
251
9
openGauss-serveropenGauss-server
openGauss kernel ~ openGauss is an open source relational database management system
C++
145
190
openHiTLSopenHiTLS
旨在打造算法先进、性能卓越、高效敏捷、安全可靠的密码套件,通过轻量级、可剪裁的软件技术架构满足各行业不同场景的多样化要求,让密码技术应用更简单,同时探索后量子等先进算法创新实践,构建密码前沿技术底座!
C
989
394
nop-entropynop-entropy
Nop Platform 2.0是基于可逆计算理论实现的采用面向语言编程范式的新一代低代码开发平台,包含基于全新原理从零开始研发的GraphQL引擎、ORM引擎、工作流引擎、报表引擎、规则引擎、批处理引引擎等完整设计。nop-entropy是它的后端部分,采用java语言实现,可选择集成Spring框架或者Quarkus框架。中小企业可以免费商用
Java
8
0
ohos_react_nativeohos_react_native
React Native鸿蒙化仓库
C++
193
274
RuoYi-Vue3RuoYi-Vue3
🎉 (RuoYi)官方仓库 基于SpringBoot,Spring Security,JWT,Vue3 & Vite、Element Plus 的前后端分离权限管理系统
Vue
936
554
金融AI编程实战金融AI编程实战
为非计算机科班出身 (例如财经类高校金融学院) 同学量身定制,新手友好,让学生以亲身实践开源开发的方式,学会使用计算机自动化自己的科研/创新工作。案例以量化投资为主线,涉及 Bash、Python、SQL、BI、AI 等全技术栈,培养面向未来的数智化人才 (如数据工程师、数据分析师、数据科学家、数据决策者、量化投资人)。
Python
75
69