pre-commit用法说明

说明

项目要使用git进行代码提交时，使用叫pre-commit的git钩子，在调用git commit 命令时自动执行某些脚本检测代码，若检测出错，则阻止commit代码，也就无法push，保证了出错代码只在我们本地，不会把问题提交到远程仓库

安装

【1】安装husky

npm i husky -save-dev

【2】安装list-staged

npm i lint-staged husky -save-dev

package.json文件

安装好之后，会自动在项目.git目录生成一个hock，这个hock会读取package.json中的内容

1. "husky": {
2. "hooks": {
3. "pre-commit": "npm run lint-staged"
4. }
5. },
6. "lint-staged": {
7. "**/*.js": "eslint --ext .js",
8. "**/*.vue": "eslint --ext .vue"
9. }

测试

首先，故意触犯eslint报错

再执行git commit提交代码

上面代码提交失败说明配置成功生效，每次执行git commit命令，都会自动调用package.json中的precommit命令，在本项目中precommit命令就会执行eslint的代码校验，若校验失败，则无法将代码commit，避免不规范代码提交到远程仓库，特别是在多人协作中能够强制规范代码

git进阶之.gitignore 和 .gitmodules

 

• .gitignore文件的使用

开发中常遇到不需要跟踪的文件或文件夹，包括不限于编译生成的文件(如.pyc)、调试结果(如rst文件夹)等,原则是不想让其被看到，此时可使用".gitignore"文件进行管理，同时需要。如该文件的内容为：

#compile
*.pyc
#rst 目录
rst

• .gitimodules文件的使用

从git官网上down了个开源代码，在此基础上开发出适合项目需求的程序，如果不想重复的上传别人的代码，此时需要将新添加的程序和改动的程序利用git保存，同时利用".gitimodules"指明依赖的程序地址。

[submodule "ssd"]	#子模块名称
	path = Detect/ssd		#存放子模块的地址
	url = https://github.com/weiliu89/caffe/tree/ssd  #子模块的原始路径

子模块使用时通过以下命令拉取即可。

git submodule update --init

上述两个文件均需要添加至git的版本库，以便对其改动进行跟踪。

git中submodule子模块的添加、使用和删除

背景

项目中经常使用别人维护的模块，在git中使用子模块的功能能够大大提高开发效率。

使用子模块后，不必负责子模块的维护，只需要在必要的时候同步更新子模块即可。

本文主要讲解子模块相关的基础命令，详细使用请参考man page。

子模块的添加

添加子模块非常简单，命令如下：

git submodule add <url> <path>

其中，url为子模块的路径，path为该子模块存储的目录路径。

执行成功后，git status会看到项目中修改了.gitmodules，并增加了一个新文件（为刚刚添加的路径）

git diff --cached查看修改内容可以看到增加了子模块，并且新文件下为子模块的提交hash摘要

git commit提交即完成子模块的添加

子模块的使用

克隆项目后，默认子模块目录下无任何内容。需要在项目根目录执行如下命令完成子模块的下载：

git submodule init
git submodule update

• 1
• 2

或：

git submodule update --init --recursive

• 1

执行后，子模块目录下就有了源码，再执行相应的makefile即可。

子模块的更新

子模块的维护者提交了更新后，使用子模块的项目必须手动更新才能包含最新的提交。

在项目中，进入到子模块目录下，执行 git pull更新，查看git log查看相应提交。

完成后返回到项目目录，可以看到子模块有待提交的更新，使用git add，提交即可。

删除子模块

有时子模块的项目维护地址发生了变化，或者需要替换子模块，就需要删除原有的子模块。

删除子模块较复杂，步骤如下：

1. rm -rf 子模块目录 删除子模块目录及源码
2. vi .gitmodules 删除项目目录下.gitmodules文件中子模块相关条目
3. vi .git/config 删除配置项中子模块相关条目
4. rm .git/module/* 删除模块下的子模块目录，每个子模块对应一个目录，注意只删除对应的子模块目录即可

---

执行完成后，再执行添加子模块命令即可，如果仍然报错，执行如下：

git rm --cached 子模块名称

完成删除后，提交到仓库即可。