@hhfe/config
v0.1.6
Published
代码规范配置文件包,包含 ESLint、Stylelint、Prettier 等配置
Readme
@hhfe/config
代码规范配置文件包,包含 ESLint、Stylelint、Prettier 等配置。
安装
pnpm add -D @hhfe/config使用方法
ESLint 配置
在你的项目中创建 .eslintrc.js 文件:
module.exports = {
extends: [require.resolve('@hhfe/config/eslint')],
// 你的项目特定配置
};Prettier 配置
在你的项目中创建 .prettierrc.js 文件:
module.exports = require('@hhfe/config/prettier');Stylelint 配置
在你的项目中创建 .stylelintrc.js 文件:
module.exports = {
extends: ['@hhfe/config/stylelint'],
// 你的项目特定配置
};Commitlint 配置
在你的项目中创建 commitlint.config.js 文件:
module.exports = {
extends: ['@hhfe/config/commitlint'],
// 你的项目特定配置
};配置说明
ESLint
- 支持 TypeScript
- 支持 Vue 3
- 集成 Prettier 避免冲突
- 包含常用的代码质量规则
Prettier
- 统一的代码格式化规则
- 支持 JavaScript、TypeScript、Vue、CSS、Less 等
Stylelint
- 支持 CSS、Less、Vue 样式
- 包含样式顺序规则
- 基于 standard 配置
Commitlint
- 基于 conventional commits 规范
- 支持多种 commit 类型
- 包含详细的格式验证规则
- 支持中文注释说明
更新配置
当需要更新配置时,只需要更新这个包,然后所有使用该配置的项目都会自动获得最新的规范配置。
