项目创建——代码规范prettier, commitlint

Posted lin-fighting

tags:

篇首语:本文由小常识网(cha138.com)小编为大家整理,主要介绍了项目创建——代码规范prettier, commitlint相关的知识,希望对你有一定的参考价值。

preitter

首先安装


运行后应该是这样

prettierrc就是用来写规则的文件,ignore顾名思义就是忽略哪些文件。

第二,预提交钩子


执行npx mrm lint-staged。它会在代码每次提交之前,进行格式化。


对所有js css md ts tsx文件都会使用piettier格式化代码。

兼容eslint


prettier工作的时候跟eslint有一些冲突,所以我们要安装这个。
再在eslint的规则后面加上prettier,表示eslint工作的时候用prettier的一些规则。

实验


代码杂乱无章,运行 git add . , 运行git commit -m “”

Commit完
可以看到已经成功格式化了。
如果你遇到这个问题,可能是

vscode的编码设置为utf-16LE,需要改为utf-8 然后重新建下commitlint.config.js文件。

在这里可以配置

配置commitlint

https://github.com/conventional-changelog/commitlint

安装
npm install --save-dev @commitlint/config-conventional @commitlint/cli
在命令行运行
echo “module.exports = {extends: [’@commitlint/config-conventional’]}” > commitlint.config.js
可以看到出现这个文件

在commit之前检查

利用这个commit-msg hooks
husky我们是安装了的,所以直接执行最后一行

然后执行


失败了,我们必须按他的规则来


成功,这样commitlint也配置好了。

以上是关于项目创建——代码规范prettier, commitlint的主要内容,如果未能解决你的问题,请参考以下文章

Vue项目中使用ellint和prettier-规范和约束我们的代码

React 创建项目流程+配置 eslint prettier 和 commitlint 规范工程

React 创建项目流程+配置 eslint prettier 和 commitlint 规范工程

15分钟快速配置eslint,prettier,lint-staged,husky,commitizen实现前端项目代码规范化

规范化:Eslint + Prettier + Husky

使用eslint+prettier+husky+lint-staged+commitlint+stylelint规范项目格式