Git提交前自动进行代码格式化 prettier pre-commit Hook eslint-config-prettier

prettier

 pre-commit Hook 

eslint-config-prettier冲突解决

conventional-changelog/commitlint

一、create-react-app环境配置prettier,在git commit前进行代码格式化,统一团队开发代码格式,并且规范git commit message 提示信息格式

prettier官方网站:https://prettier.io/

二、具体实现步骤

第一步:搭建create-react-app typescript环境

npx create-react-app my-app --template typescript

第二步:

安装 prettier包

yarn add --dev --exact prettier

安装报错:eslint@8.8需要指定版本或大于等于16+


安装prettier过程中,eslint和nodejs版本不匹配报错

解决:卸载:nodejs,下载并安装nodejs@16+

   第三步:生成prettier配置文件.prettierrc.json

echo {}> .prettierrc.json  --建议手动创建.prettierrc.json文件,不然字符集不对,不要使用这个命令创建(坑)

.prettierrc.json文件中,只有:  {}


第四步:新建prettier忽略文件 .prettierignore 

#Ignore artifacts:

build

coverage

提示:如果要手动格式化--执行代码格式化命令

yarn prettier --write .

            一般开发的时候,都是自动化执行格式化命令


第五步:安装并配置pre-commit

Hook 在git

commit前自动格式化代码

    npxmrm@2 lint-staged

         修改package.json

            "lint-staged": {

            "*.{js,css,md,ts,tsx}":

                 "prettier --write"

            }

      修改:package.json

"husky":

{

                  "hooks": {

                  "pre-commit": "lint-staged"

                    }

                  },



第六步:

create-react-app 自带eslint,在开发中eslint和prettier有可能有冲突,需要解决


安装eslint-config-prettier开发Dev依赖

yarn add  eslint-config-prettier@6.15 --dev

   修改:package.json用prettier配置覆盖上面的react-app配置


修改eslint配置,覆盖默认配置

第六步:

      问题:

           解决:  https://www.jianshu.com/p/38f04aef1c9d

           git config --globalcore.autocrlftrue


第七步:团队开发需要规范git

commit message提示信息,统一提示信息的写法

                  conventional-changelog/commitlin

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

                   注意:需要认真阅读文档,如果message不符合规范,则报错

1.安装@commitlint/config-conventional

@commitlint/cli

  yarn add @commitlint/config-conventional@12@commitlint/cli --dev


2.执行命令:

   echo "module.exports= {extends: ['@commitlint/config-conventional']}">

commitlint.config.js     --建议手动创建commitlint.config.js文件,不然字符集不对,不要使用这个命令创建(坑)

文件名:  commitlint.config.js

内容:

module.exports

= { extends: ["@commitlint/config-conventional"]

};


修改:

package.json

  "husky": {

    "hooks": {

      "pre-commit":"lint-staged",

      "commit-msg": "commitlint-E HUSKY-GIT-PARAMS"

    }

  },


npx husky add .husky/commit-msg 'npx --no -- commitlint --edit "$1"'



修改:

App.tsx

git add .

git commit -m “fix: change App.tsx”


三、git message 提示信息规范构成

git message 提示信息规范构成: Header 是必需的,Body 和 Footer 可以省略。

  1.Header包括: 包括三个字段:type(必需)、scope(可选)和subject(必需)。

(1)

type指本次提交的类型,为必填项,必须为以下之一:

feat:一项新功能

fix:一个错误修复

docs:仅文档更改

style:不影响代码逻辑的更改(空白,格式,缺少分号等)

refactor:既不修正错误也不增加功能的代码更改(重构)

perf:改进性能的代码更改

test:添加缺失或更正现有测试

build:影响构建系统或外部依赖项的更改(gulp,npm等)

ci:对CI配置文件和脚本的更改

chore:更改构建过程或辅助工具和库,例如文档生成

(2)Scope用于说明commit 影响的范围,比如数据层、控制层、视图层等等,视项目不同而不同。


(3)subject是commit 目的的简短描述,以动词开头,使用第一人称现在时,比如change,而不是changed或changes;第一个字母小写,结尾不加句号(.)

2.Body可选:Body部分是对本次commit 的详细描述,可以分成多行。

有两个注意点。

(1)使用第一人称现在时,比如使用change而不是changed或changes。

(2)应该说明代码变动的动机,以及与以前行为的对比。

3.Footer 可选

Footer部分只用于两种情况。

(1)不兼容变动

如果当前代码与上一个版本不兼容,则

Footer 部分以BREAKING

CHANGE开头,后面是对变动的描述、以及变动理由和迁移方法。

(2)关闭Issue如果当前

commit 针对某个issue,那么可以在

Footer 部分关闭这个issue 。

命令:Closes #234

具体规范内容:

https://github.com/conventional-changelog/commitlint/tree/master/@commitlint/config-conventional#type-enum

©著作权归作者所有,转载或内容合作请联系作者
  • 序言:七十年代末,一起剥皮案震惊了整个滨河市,随后出现的几起案子,更是在滨河造成了极大的恐慌,老刑警刘岩,带你破解...
    沈念sama阅读 157,198评论 4 359
  • 序言:滨河连续发生了三起死亡事件,死亡现场离奇诡异,居然都是意外死亡,警方通过查阅死者的电脑和手机,发现死者居然都...
    沈念sama阅读 66,663评论 1 290
  • 文/潘晓璐 我一进店门,熙熙楼的掌柜王于贵愁眉苦脸地迎上来,“玉大人,你说我怎么就摊上这事。” “怎么了?”我有些...
    开封第一讲书人阅读 106,985评论 0 237
  • 文/不坏的土叔 我叫张陵,是天一观的道长。 经常有香客问我,道长,这世上最难降的妖魔是什么? 我笑而不...
    开封第一讲书人阅读 43,673评论 0 202
  • 正文 为了忘掉前任,我火速办了婚礼,结果婚礼上,老公的妹妹穿的比我还像新娘。我一直安慰自己,他们只是感情好,可当我...
    茶点故事阅读 51,994评论 3 285
  • 文/花漫 我一把揭开白布。 她就那样静静地躺着,像睡着了一般。 火红的嫁衣衬着肌肤如雪。 梳的纹丝不乱的头发上,一...
    开封第一讲书人阅读 40,399评论 1 211
  • 那天,我揣着相机与录音,去河边找鬼。 笑死,一个胖子当着我的面吹牛,可吹牛的内容都是我干的。 我是一名探鬼主播,决...
    沈念sama阅读 31,717评论 2 310
  • 文/苍兰香墨 我猛地睁开眼,长吁一口气:“原来是场噩梦啊……” “哼!你这毒妇竟也来了?” 一声冷哼从身侧响起,我...
    开封第一讲书人阅读 30,407评论 0 194
  • 序言:老挝万荣一对情侣失踪,失踪者是张志新(化名)和其女友刘颖,没想到半个月后,有当地人在树林里发现了一具尸体,经...
    沈念sama阅读 34,112评论 1 239
  • 正文 独居荒郊野岭守林人离奇死亡,尸身上长有42处带血的脓包…… 初始之章·张勋 以下内容为张勋视角 年9月15日...
    茶点故事阅读 30,371评论 2 241
  • 正文 我和宋清朗相恋三年,在试婚纱的时候发现自己被绿了。 大学时的朋友给我发了我未婚夫和他白月光在一起吃饭的照片。...
    茶点故事阅读 31,891评论 1 256
  • 序言:一个原本活蹦乱跳的男人离奇死亡,死状恐怖,灵堂内的尸体忽然破棺而出,到底是诈尸还是另有隐情,我是刑警宁泽,带...
    沈念sama阅读 28,255评论 2 250
  • 正文 年R本政府宣布,位于F岛的核电站,受9级特大地震影响,放射性物质发生泄漏。R本人自食恶果不足惜,却给世界环境...
    茶点故事阅读 32,881评论 3 233
  • 文/蒙蒙 一、第九天 我趴在偏房一处隐蔽的房顶上张望。 院中可真热闹,春花似锦、人声如沸。这庄子的主人今日做“春日...
    开封第一讲书人阅读 26,010评论 0 8
  • 文/苍兰香墨 我抬头看了看天上的太阳。三九已至,却和暖如春,着一层夹袄步出监牢的瞬间,已是汗流浃背。 一阵脚步声响...
    开封第一讲书人阅读 26,764评论 0 192
  • 我被黑心中介骗来泰国打工, 没想到刚下飞机就差点儿被人妖公主榨干…… 1. 我叫王不留,地道东北人。 一个月前我还...
    沈念sama阅读 35,412评论 2 269
  • 正文 我出身青楼,却偏偏与公主长得像,于是被迫代替她去往敌国和亲。 传闻我的和亲对象是个残疾皇子,可洞房花烛夜当晚...
    茶点故事阅读 35,299评论 2 260

推荐阅读更多精彩内容