@bwt-st/eslint
v0.2.1
Published
BWT-ST shared ESLint Flat Config.
Readme
@bwt-st/eslint
面向现代前端项目的 ESLint Flat Config。包提供基础、Vue 和 React 三个入口,适用于 ESLint 9 及以上版本。
安装
pnpm add -D @bwt-st/eslint eslint项目需要使用 ESLint Flat Config,在根目录创建 eslint.config.js。
配置入口
| 入口 | 适用项目 | 已包含内容 |
| ---------------------- | ------------------------------- | -------------------------------------------------- |
| @bwt-st/eslint | 通用 JavaScript/TypeScript 项目 | ESLint 推荐规则、TypeScript 推荐规则和基础全局变量 |
| @bwt-st/eslint/vue | Vue 项目 | 基础配置、Vue Flat Essential 规则和 .vue 解析器 |
| @bwt-st/eslint/react | React 项目 | 基础配置和 JSX/TSX 解析支持 |
Vue 和 React 入口已经包含基础配置,不需要同时展开基础入口。
通用项目
// eslint.config.js
import config from '@bwt-st/eslint'
export default configVue 项目
// eslint.config.js
import config from '@bwt-st/eslint/vue'
export default configReact 项目
// eslint.config.js
import config from '@bwt-st/eslint/react'
export default config运行检查:
pnpm exec eslint .规则与扩展
基础配置覆盖 js、mjs、cjs、ts、tsx 和 jsx 文件,并将 no-console、no-debugger 设置为警告。默认忽略 dist、node_modules、coverage 和 VitePress 构建目录。
业务项目可以在共享配置后追加自己的规则:
import config from '@bwt-st/eslint'
export default [
...config,
{
rules: {
'no-console': 'off',
},
},
]React 入口只提供 JSX/TSX 解析和基础规则,不内置 React Hooks、React Refresh 等业务生态插件;需要时请由业务项目按版本自行添加。
兼容性
- Node.js
>=20.19.0 - ESLint
^9.0.0 || ^10.0.0 - 使用 ESM 配置文件和 Flat Config
