From fba0a8045b2e752b6506f7737b0fd285cd298102 Mon Sep 17 00:00:00 2001 From: Ohad Dahan Date: Sat, 15 Aug 2020 17:05:34 +0300 Subject: [PATCH 1/2] pre-commit hooks --- .git_hooks/pre-commit | 18 ++++++++++++++++++ README.md | 11 +++++++++++ 2 files changed, 29 insertions(+) create mode 100755 .git_hooks/pre-commit diff --git a/.git_hooks/pre-commit b/.git_hooks/pre-commit new file mode 100755 index 000000000..872c2cdda --- /dev/null +++ b/.git_hooks/pre-commit @@ -0,0 +1,18 @@ +#!/usr/bin/env sh +if ! cargo fmt -- --check ; then + printf "\n" + printf "\033[0;31mpre-commit hook failed during:\033[0m\n" + printf "\033[0;31m\tcargo fmt -- --check\033[0m\n" + exit 1 +fi + +if ! cargo clippy --locked -- -D warnings ; then + printf "\n" + printf "\033[0;31mpre-commit hook failed during:\033[0m\n" + printf "\033[0;31m\tclippy --locked -- -D warning\033[0m\n" + exit 1 +fi + +printf "\n" +printf "\033[0;32mpre-commit hook succeeded\033[0m\n" +exit 0 diff --git a/README.md b/README.md index 8f6155ec7..796d363ee 100644 --- a/README.md +++ b/README.md @@ -22,6 +22,17 @@ The recommended way to develop docs.rs is a combination of `cargo run` for the main binary and [docker-compose](https://docs.docker.com/compose/) for the external services. This gives you reasonable incremental build times without having to add new users and packages to your host machine. +### Git Hooks + +For ease of use, `git_hooks` directory contains useful `git hooks` to make your development easier. + +```bash +# Unix +cd .git/hooks && ln -s ../../.git_hooks/* . && cd ../.. +# Powershell +cd .git/hooks && New-Item -Path ../../.git_hooks/* -ItemType SymbolicLink -Value . && cd ../.. +``` + ### Dependencies Docs.rs requires at least the following native C dependencies. From bb3286fde3ca4420b3e76992110cbac2f981c992 Mon Sep 17 00:00:00 2001 From: ohaddahan Date: Sat, 15 Aug 2020 17:56:05 +0300 Subject: [PATCH 2/2] Update .git_hooks/pre-commit Co-authored-by: Joshua Nelson --- .git_hooks/pre-commit | 1 - 1 file changed, 1 deletion(-) diff --git a/.git_hooks/pre-commit b/.git_hooks/pre-commit index 872c2cdda..0c7b0eb40 100755 --- a/.git_hooks/pre-commit +++ b/.git_hooks/pre-commit @@ -15,4 +15,3 @@ fi printf "\n" printf "\033[0;32mpre-commit hook succeeded\033[0m\n" -exit 0