Basic ESLint config for Electron-TypeScript projects.
Requires eslint >= 9.0.0.
This config is specifically designed to be used by @quick-start/create-electron setups.
Installation
npm add -D @electron-toolkit/eslint-config-ts
Usage
This package exports the following:
| name | Description |
|---|
| config | A utility function for creating type-safe flat configs, export form typescript-eslint |
| configs | Built-in configurations: base, recommended and recommendedTypeChecked |
| parser | TypeScript parser for ESLint, export form @typescript-eslint/parser |
| plugin | TypeScript plugin for ESLint, export form @typescript-eslint/eslint-plugin |
Import @electron-toolkit/eslint-config-ts and add it to the configuration array in your eslint.config.js file.
import tseslint from '@electron-toolkit/eslint-config-ts'
export default tseslint.config(
tseslint.configs.recommended
// Any other config
)
关于 @electron-toolkit/eslint-config-ts 的常见问题
@electron-toolkit/eslint-config-ts 是什么？
Basic ESLint config for Electron-TypeScript projects.
如何安装 @electron-toolkit/eslint-config-ts？
在项目目录运行 npm install @electron-toolkit/eslint-config-ts，或使用 pnpm add / yarn add / bun add。它还需要宿主项目提供 peer 依赖：eslint（>=9.0.0）。npm 7 及以上与 pnpm 8 及以上默认会自动安装必需的 peer 依赖，Yarn 需要手动安装。
@electron-toolkit/eslint-config-ts 支持 TypeScript 吗？
支持。包内自带 TypeScript 类型声明（package.json 声明了 types 入口），安装后即可获得类型提示，无需再安装 @types 包。
@electron-toolkit/eslint-config-ts 支持 ESM 还是 CommonJS？
以 CommonJS 形式发布，可以直接 require()；在 ES Module 项目中也可以用 import 引入（Node.js 会把 module.exports 作为默认导出）。
@electron-toolkit/eslint-config-ts 可以商用吗？
@electron-toolkit/eslint-config-ts 使用 MIT 许可。宽松许可：允许商业使用、修改和再分发，通常只需在分发时保留原版权与许可声明。以上为概括，不构成法律意见，请以许可原文为准。
@electron-toolkit/eslint-config-ts 的下载量有多少？
根据 npm 官方下载统计，@electron-toolkit/eslint-config-ts 在 2026/10/14 – 2026/11/12 这 30 天内被下载 382,380 次，日均约 12,746 次。下载量会把 CI 构建、镜像同步和作为其他包依赖的安装一并计入，适合横向比较热度，不能直接等同于使用人数。
@electron-toolkit/eslint-config-ts 还在维护吗？
最新版本 4.0.0 发布于 2026/09/27（1 个月前）；至今共发布 9 个版本，其中过去 12 个月发布了 1 个；首次发布于 2023/07/24。发布频率只是参考信号：功能稳定的工具可能很少需要更新，建议结合源码仓库的 issue 和提交记录判断。