如何为ESLint新配置文件eslint.config.js获取类型提示?
为ESLint新扁平配置对象添加TypeScript类型提示
要在eslint.config.js中给ESLint新配置对象加上TypeScript类型提示,你可以通过以下两种方式实现:
方式一:在JS文件中使用JSDoc类型标注
直接通过import()类型引用ESLint内置的扁平配置类型,在JSDoc的@type中指定:
/** @type {import('eslint').Linter.FlatConfig[]} */ export default [ { rules: { // 这里编写你的ESLint规则 } } ];
Linter.FlatConfig是ESLint官方定义的扁平配置对象类型,因为配置本身是数组结构,所以末尾加上[]来标识数组类型。
方式二:改用TS配置文件(eslint.config.ts)
如果你的项目支持TypeScript,可以直接将配置文件改为.ts格式,直接使用TypeScript原生类型注解:
import type { Linter } from 'eslint'; const config: Linter.FlatConfig[] = [ { rules: { // 这里编写你的ESLint规则 } } ]; export default config;
这种方式无需依赖JSDoc,直接通过TypeScript的类型系统就能获得完整的代码提示。
注意:请确保安装ESLint v8.21.0及以上版本,该版本开始正式支持扁平配置的类型定义,无需额外安装
@types/eslint包。
内容的提问来源于stack exchange,提问作者Chiawen
相关产品推荐
相关产品推荐

