Merge #56: Add githooks

f8c7e35 Add --all-features when running clippy in ci (Tobin C. Harding)
cfbfc7e Add git pre-commit hook (Tobin C. Harding)

Pull request description:

  Add a pre-commit git hook as we did in `rust-bitcoin`.

  Patch 2 adds `--all-features` to the clippy CI run, this is just future proofing, no effect on the current code.

ACKs for top commit:
  apoelstra:
    ACK f8c7e35

Tree-SHA512: 1fc23921fdfdd097b436d62bf84d947e46297a27dd10c7477f5c9f29a7dfd8129bc8e0d294b016de649d368298228946681ac82cba6a71089fe1e999d55e672a

Author: apoelstra

.github/workflows/rust.yml

@@ -103,7 +103,7 @@ jobs:
       - uses: actions-rs/cargo@v1
         with:
           command: clippy
-          args: --all-targets -- -D warnings
+          args: --all-targets --all-features -- -D warnings
 
   Fmt:
     name: Fmt

README.md

@@ -45,6 +45,18 @@ git subtree pull --prefix='depend/bitcoin' git@github.com:bitcoin/bitcoin.git v0
 The MSRV of this crate is **1.41.1**.
 
 
+## Githooks
+
+To assist devs in catching errors _before_ running CI we provide some githooks. If you do not
+already have locally configured githooks you can use the ones in this repository by running, in the
+root directory of the repository:
+```
+git config --local core.hooksPath githooks/
+```
+
+Alternatively add symlinks in your `.git/hooks` directory to any of the githooks we provide.
+
+
 ## API
 
 The API is very basic, exposing Bitcoin's API as is.

githooks/pre-commit

@@ -0,0 +1,52 @@
+#!/bin/sh
+#
+# Verify what is about to be committed. Called by "git commit" with no
+# arguments. The hook should exit with non-zero status after issuing an
+# appropriate message if it wants to stop the commit.
+
+if git rev-parse --verify HEAD >/dev/null 2>&1
+then
+	against=HEAD
+else
+	# Initial commit: diff against an empty tree object
+	against=$(git hash-object -t tree /dev/null)
+fi
+
+# If you want to allow non-ASCII filenames set this variable to true.
+allownonascii=$(git config --bool hooks.allownonascii)
+
+# Redirect output to stderr.
+exec 1>&2
+
+# Cross platform projects tend to avoid non-ASCII filenames; prevent
+# them from being added to the repository. We exploit the fact that the
+# printable range starts at the space character and ends with tilde.
+if [ "$allownonascii" != "true" ] &&
+	# Note that the use of brackets around a tr range is ok here, (it's
+	# even required, for portability to Solaris 10's /usr/bin/tr), since
+	# the square bracket bytes happen to fall in the designated range.
+	test $(git diff --cached --name-only --diff-filter=A -z $against |
+	  LC_ALL=C tr -d '[ -~]\0' | wc -c) != 0
+then
+	cat <<\EOF
+Error: Attempt to add a non-ASCII file name.
+
+This can cause problems if you want to work with people on other platforms.
+
+To be portable it is advisable to rename the file.
+
+If you know what you are doing you can disable this check using:
+
+  git config hooks.allownonascii true
+EOF
+	exit 1
+fi
+
+# If there are whitespace errors, print the offending file names and fail.
+git diff-index --check --cached $against -- || exit 1
+
+# Check that code lints cleanly.
+cargo clippy --all-targets --all-features -- -D warnings || exit 1
+
+# Check that there are no formatting issues.
+cargo +nightly fmt --check || exit 1