--- description: 项目规范和代码检查 globs: alwaysApply: false --- # Vben 项目规范和代码检查 项目遵循严格的代码规范以提高代码质量和开发效率。主要的 lint 工具及其配置位于 `internal/lint-configs` 目录下。 ## 主要工具及配置 - **ESLint**: 用于 JavaScript 和 TypeScript 代码检查。 - 命令: `pnpm eslint .` - 配置文件: [eslint.config.mjs](mdc:eslint.config.mjs) - 核心配置: `internal/lint-configs/eslint-config` - **Stylelint**: 用于 CSS 样式检查。 - 命令: `pnpm stylelint "**/*.{vue,css,less.scss}"` - 配置文件: [stylelint.config.mjs](mdc:stylelint.config.mjs) - 核心配置: `internal/lint-configs/stylelint-config` - **Prettier**: 用于代码格式化。 - 命令: `pnpm prettier .` - 配置文件: [.prettierrc.mjs](mdc:.prettierrc.mjs) - 核心配置: `internal/lint-configs/prettier-config` - **Commitlint**: 用于检查 Git 提交信息的规范。 - 配置文件: [.commitlintrc.js](mdc:.commitlintrc.js) - 核心配置: `internal/lint-configs/commitlint-config` - **Publint**: 用于检查 npm 包的规范 (针对 Monorepo 项目)。 - 相关脚本: `pnpm vsh publint` (详见 CLI 工具规则) - **Lint Staged**: 用于在 Git 提交前运行代码校验。 - 配置文件: [.lintstagedrc.mjs](mdc:.lintstagedrc.mjs) - **Cspell**: 用于检查拼写错误。 - 配置文件: [cspell.json](mdc:cspell.json) ## VSCode 插件推荐 为了更好地遵循代码规范,推荐安装以下 VSCode 插件: - ESLint - Prettier - Code Spell Checker - Stylelint ## 核心配置目录 所有 Lint 相关的核心配置都集中在 [internal/lint-configs/](mdc:internal/lint-configs) 目录下。