代码提交时自动格式化配置

本文介绍了如何通过husky、prettier、eslint和lint-staged在代码提交时自动进行格式化,确保团队代码风格一致性和规范性。husky作为git钩子工具,prettier用于代码格式化,eslint则专注于代码错误检查,lint-staged允许在提交指定文件时运行自定义指令。
摘要由CSDN通过智能技术生成

前言

多人合作的问题就在于大家代码风格都不一样,有了代码提交时自动格式化,可以避免再开发过程中去考虑代码格式的问题(经常气的想关掉eslint),同时保证了一定的规范性

husky

一个git钩子工具,这里主要用pre-commit钩子。通俗点讲就是husky可以在你commit之前帮你做一些事情。

prettier

一个很流行的代码格式化工具,你很容易在编辑器找到实现它的各种插件,像vscode,atom,webstom都可以找到。这里用它在代码提交前做代码格式化。

eslint

代码检查工具。eslint也可以负责一部分代码格式检查的工作,但是prettier已经做的很好了,所以我便没用eslint的代码格式检查,只让其负责代码错误检查。

lint-staged

在你提交的文件中,执行自定义的指令

安装依赖

// eslint依赖
eslint 
babel-eslint 
eslint-config-airbnb  // 导入默认eslint选项
eslint-config-airbnb-typescript  // 支持ts与js
eslint-plugin-import  // import规则插件
eslint-plugin-jsx-a11y 
eslint-plugin-react   // react规则插件
eslint-plugin-react-hooks  // react 16.8+ 以上版本规则插件

// 如果需要对tsx文件进行语法规范
@typescript-eslint/parser 
@typescript-eslint/eslint-plugin

//当prettier规则与 eslint-plugin-react 规则冲突时使用
eslint-config-prettier/react

//在tsconfig配置了paths时帮助
//eslint-plugin-import 找到正确的 .ts 和 .tsx 文件
eslint-import-resolver-typescript

//prettier依赖
prettier 
eslint-plugin-prettier  // 将perttier当作eslint规范
eslint-config-prettier  // 以prettier规范为主

//husky
husky

//lint-staged
lint-staged
pretty-quick

eslint文件配置
个人配置习惯

// eslint中文配置文档:https://cn.eslint.org/docs/user-guide/configuring
评论
添加红包

请填写红包祝福语或标题

红包个数最小为10个

红包金额最低5元

当前余额3.43前往充值 >
需支付:10.00
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包
实付
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明:

1.余额是钱包充值的虚拟货币,按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载,可以购买VIP、付费专栏及课程。

余额充值