Team ESLint Config

团队统一的代码规范和格式化配置，支持 Vue 3、Nuxt 3 和 WXT 项目。

系统要求

• Node.js >= 18.0.0
• npm >= 9.0.0 或 pnpm >= 8.0.0

特性

• ESLint 配置
• Prettier 格式化
• TypeScript 类型检查
• Git Hooks (husky)
• 提交信息规范 (commitlint)
• 交互式提交 (commitizen)
• VS Code 集成

安装

npm install --save-dev team-eslint-config

Vue 项目

npx team-eslint-config vue

Nuxt 项目

npx team-eslint-config nuxt

WXT 项目

npx team-eslint-config wxt

使用

安装完成后，你可以使用以下命令：

• npm run dev - 启动开发服务器（包含实时 ESLint 检查）
• npm run lint - 检查代码风格
• npm run lint:fix - 自动修复代码风格问题
• npm run format - 使用 Prettier 格式化代码

VS Code 集成

安装后会自动配置 VS Code 设置和推荐扩展。建议安装以下扩展：

• ESLint
• Prettier
• Vue - Official
• TypeScript Vue Plugin
• Error Lens
• EditorConfig

Git Hooks

安装后会自动配置 Git pre-commit hook，在提交代码前自动检查和修复代码风格问题。

严格模式

此配置启用了以下严格检查：

TypeScript 严格检查

• strict: true
• noImplicitAny: true
• strictNullChecks: true
• strictFunctionTypes: true
• strictBindCallApply: true
• strictPropertyInitialization: true
• noImplicitThis: true
• alwaysStrict: true
• noUnusedLocals: true
• noUnusedParameters: true
• noImplicitReturns: true
• noFallthroughCasesInSwitch: true

ESLint 严格规则

• @typescript-eslint/no-explicit-any: error
• @typescript-eslint/explicit-module-boundary-types: error
• @typescript-eslint/no-unused-vars: error
• @typescript-eslint/no-non-null-assertion: error
• @typescript-eslint/strict-boolean-expressions: error
• @typescript-eslint/no-floating-promises: error

开发模式

在开发模式下，错误会实时显示在终端和编辑器中：

发布到 NPM

1. 更新 package.json 中的版本号
2. 运行 npm run build 构建项目
3. 运行 npm publish 发布到 NPM

贡献

欢迎提交问题和 PR，共同维护团队代码规范。

许可证

MIT

注意事项

1. 更新依赖后请运行测试确保功能正常
2. 如果只想更新小版本，使用 ncu --target minor
3. 如果想交互式选择更新，使用 ncu --interactive