git的预提交挂钩
git-pre-commit-hook的Python项目详细描述
阻止错误提交的钩子。 对python开发很有用。
安装
您可以安装、升级、卸载git预提交挂钩 使用这些命令:
$ pip install git-pre-commit-hook $ pip install --upgrade git-pre-commit-hook $ pip uninstall git-pre-commit-hook
功能
- 在初次提交时工作良好。
- 对所有文件名都很好。
- 使用索引内容而不是工作副本。
- 插件架构:添加新的检查很容易。
- 内置插件:
- 验证json文件
- 使用验证python代码 flake8 ( mccabe plugin 启用 ) 和 pep8-naming
- 使用验证python代码 frosted
- 使用验证.rst文件 restructuredtext_lint
- 使用验证.ini文件 configparser
- 使用PyYAML 验证.yaml文件
- 使用验证.xml文件 xml.etree.ElementTree
- 检查文件大小
示例
将钩子安装到当前git存储库:
git-pre-commit-hook install \ --plugin flake8 \ --plugin frosted \ --plugin json \ --plugin file_size \ --plugin rst \ --plugin yaml
已安装的挂钩拒绝提交:
- 如果任何文件的大小大于10MB
- 如果扩展名为.json的文件包含无效的json
- 如果python代码没有通过flake8的检查(使用pep8命名)
- 如果python代码没有通过磨砂检查
- 如果扩展名为.rst的文件包含无效的rst
- 如果扩展名为.yaml的文件包含无效的yaml
列出可用的插件:
git-pre-commit-hook list-plugins
显示有关插件的信息:
git-pre-commit-hook show-plugin-info json
贡献
克隆您的叉子
安装tox:
pip install tox
创建开发环境:
tox -e devenv source devenv/bin/activate
编辑代码
运行测试:
tox
发送拉取请求