@ianchoi/eslint-config-standard
v0.0.2
Published
ESLint standard configuration for JavaScript/TypeScript based on ESLint 9 Flat Config
Downloads
10
Maintainers
Readme
@ianchoi/eslint-config-standard
ESLint 标准配置包,基于 ESLint 9 Flat Config 格式。
特性
- ✅ 基于 ESLint 9 Flat Config 格式
- ✅ 支持 JavaScript/TypeScript
- ✅ 集成 import-x 插件,提供导入规则检查
- ✅ 强制驼峰命名规范
- ✅ 自动检测未使用的变量
- ✅ 模块导入顺序规范
安装
从 npm 安装(发布后)
npm install --save-dev @ianchoi/eslint-config-standard
# 或
pnpm add -D @ianchoi/eslint-config-standard
# 或
yarn add -D @ianchoi/eslint-config-standard本地引用(开发/测试)
在 monorepo 中使用 workspace(pnpm)
如果使用 pnpm workspace,在根目录创建 pnpm-workspace.yaml:
packages:
- 'packages/*'然后在其他包的 package.json 中:
{
"devDependencies": {
"@ianchoi/eslint-config-standard": "workspace:*",
"eslint": "^9.0.0"
}
}使用方法
ESLint 9+ (Flat Config)
在你的 eslint.config.js 或 eslint.config.mjs 文件中:
import standardConfig from '@ianchoi/eslint-config-standard'
export default [
...standardConfig,
// 你的其他配置
]依赖要求
- ESLint >= 9.0.0
规则说明
代码规范
- camelcase: 强制使用驼峰命名法
- no-unused-vars: 禁止未使用的变量(支持
_前缀忽略) - prefer-promise-reject-errors: 要求使用 Error 对象作为 Promise 拒绝的原因
- no-restricted-globals: 禁止使用特定的全局变量(如
isNaN,应使用Number.isNaN)
导入规范
- import-x/no-extraneous-dependencies: 禁止导入未在 package.json 中声明的依赖
- import-x/no-unresolved: 确保导入的模块可以被解析
- import-x/order: 强制模块导入顺序规范
- 内置模块 → 外部依赖 → 内部模块 → 父级/同级 → index → object → type
- 自动按字母顺序排序
- 组之间必须有空行
许可证
ISC
