返回
git提交代码自动格式化?别再瞎折腾了,这样做才叫顺手!
前端
2023-09-20 12:53:17
在当今的开发过程中,代码格式化已经成为了一项必不可少的任务。代码格式化不仅能保证代码整洁统一,还能减少代码审查的难度,提高开发效率。
然而,手动格式化代码是一项繁琐且容易出错的任务。为了解决这个问题,我们可以使用代码格式化工具来帮助我们自动格式化代码。
在本文中,我们将介绍如何使用prettier代码格式化模块、husky git的钩子,在git的hook中执行一些命令、lint-staged对git暂存的文件进行lint检查,以及eslint代码检测工具,来实现代码提交前自动格式化代码。
前提条件
- 需要Node.js环境
- 需要git版本控制工具
- 需要安装prettier
- 需要安装husky
- 需要安装lint-staged
- 需要安装eslint
安装依赖
npm install --save-dev prettier husky lint-staged eslint
创建 .prettierrc 文件
在项目根目录中创建 .prettierrc
文件,并添加以下内容:
{
"semi": false,
"trailingComma": "es5",
"singleQuote": true,
"printWidth": 80,
"tabWidth": 2
}
创建 .huskyrc 文件
在项目根目录中创建 .huskyrc
文件,并添加以下内容:
{
"hooks": {
"pre-commit": "lint-staged"
}
}
创建 .lintstagedrc 文件
在项目根目录中创建 .lintstagedrc
文件,并添加以下内容:
{
"*.js": [
"eslint --fix",
"prettier --write"
]
}
运行命令
运行以下命令来安装husky:
npx husky install
运行以下命令来安装lint-staged:
npx lint-staged
运行以下命令来安装eslint:
npx eslint --init
使用
现在,当你在项目中提交代码时,husky会自动执行lint-staged命令,lint-staged会对git暂存的文件进行lint检查,eslint会检测代码是否符合代码规范,prettier会自动格式化代码。
总结
使用代码格式化工具可以帮助我们自动格式化代码,从而保证代码整洁统一,减少代码审查的难度,提高开发效率。
本文介绍了如何使用prettier代码格式化模块、husky git的钩子,在git的hook中执行一些命令、lint-staged对git暂存的文件进行lint检查,以及eslint代码检测工具,来实现代码提交前自动格式化代码。