Add git hooks for local development

Author: thibaudcolas

.githooks/deploy.sh

@@ -0,0 +1,34 @@
+#!/bin/sh
+
+# https://gist.github.com/apexskier/efb7c1aaa6e77e8127a8
+# Deploy hooks stored in your git repo to everyone!
+#
+# I keep this in $ROOT/$HOOK_DIR/deploy
+# From the top level of your git repo, run ./hook/deploy (or equivalent) after
+# cloning or adding a new hook.
+# No output is good output.
+
+BASE=`git rev-parse --git-dir`
+ROOT=`git rev-parse --show-toplevel`
+HOOK_DIR=.githooks
+HOOKS=$ROOT/$HOOK_DIR/*
+
+if [ ! -d "$ROOT/$HOOK_DIR" ]
+then
+  echo "Couldn't find hooks dir."
+  exit 1
+fi
+
+# Clean up existing hooks.
+rm -f $BASE/hooks/*
+
+# Synlink new hooks.
+for HOOK in $HOOKS
+do
+  (cd $BASE/hooks ; ln -s $HOOK `basename $HOOK` || echo "Failed to link $HOOK to `basename $HOOK`.")
+done
+
+echo "Git hooks deployed to $BASE/hooks. The hooks automatically check your code on every commit."
+echo "To bypass them for a single commit, use: git commit --no-verify"
+
+exit 0

.githooks/pre-commit

@@ -0,0 +1,30 @@
+#!/usr/bin/env bash
+
+# Fail on first line that fails.
+set -e
+
+# Only keep staged files that are added (A), copied (C) or modified (M).
+STAGED=$(git --no-pager diff --name-only --cached --diff-filter=ACM)
+# Files which are only partly staged (eg. git add --patch).
+PATCH_STAGED=$(git --no-pager diff --name-only --diff-filter=ACM $STAGED)
+# Files which are fully staged.
+FULLY_STAGED=$(comm -23 <(echo "$STAGED") <(echo "$PATCH_STAGED"))
+
+JS_STAGED=$(grep -E '.(js|jsx)$' <<< "$STAGED" || true)
+CSS_STAGED=$(grep -E '.(css|scss)$' <<< "$STAGED" || true)
+SNAPSHOT_STAGED=$(grep -E '.snap$' <<< "$STAGED" || true)
+PRETTIER_STAGED=$(grep -E '.(md|css|scss|js|json|yaml|yml|html)$' <<< "$STAGED" || true)
+PRETTIER_FULLY_STAGED=$(grep -E '.(md|css|scss|js|json|yaml|yml|html)$' <<< "$FULLY_STAGED" || true)
+
+# Uncomment, and add more variables to the list, for debugging help.
+# tr ' ' '\n' <<< "STAGED $STAGED PATCH_STAGED $PATCH_STAGED FULLY_STAGED $FULLY_STAGED JS_STAGED $JS_STAGED
+
+# Execute each pre-commit hook.
+PROJECT_ROOT=`git rev-parse --show-toplevel`
+GIT_ROOT=`git rev-parse --git-dir`
+HOOKS=$PROJECT_ROOT/$GIT_ROOT/hooks/pre-commit.*
+
+for HOOK in $HOOKS
+do
+  source $HOOK
+done

.githooks/pre-commit.0.whitespace.sh

@@ -0,0 +1,16 @@
+#!/usr/bin/env bash
+
+# Check if this is the initial commit
+if git rev-parse --verify HEAD >/dev/null 2>&1
+then
+  against=HEAD
+else
+  against=4b825dc642cb6eb9a060e54bf8d69288fbee4904
+fi
+
+# Use git diff-index to check for whitespace errors
+if ! git diff-index --check --cached $against -- ':!*.js.snap' .
+then
+  echo "Aborting commit due to whitespace errors."
+  exit 1
+fi

.githooks/pre-commit.5.prettier.sh

@@ -0,0 +1,13 @@
+#!/usr/bin/env bash
+
+# Format and re-stage fully staged files only.
+if [ -n "$PRETTIER_FULLY_STAGED" ];
+then
+  npx prettier --write $PRETTIER_FULLY_STAGED
+  git add $PRETTIER_FULLY_STAGED
+fi
+
+if [ -n "$PRETTIER_STAGED" ];
+then
+  npx prettier --check $PRETTIER_STAGED
+fi

.githooks/pre-commit.6.lint.sh

@@ -0,0 +1,6 @@
+#!/usr/bin/env bash
+
+if [ -n "$JS_STAGED" ];
+then
+  npx eslint --report-unused-disable-directives $JS_STAGED
+fi

.githooks/pre-commit.8.test.sh

@@ -0,0 +1,7 @@
+#!/usr/bin/env bash
+
+if [ -n "$JS_STAGED" ] || [ -n "$SNAPSHOT_STAGED" ];
+then
+  npm run test
+  npm run test:rules
+fi

package.json

@@ -42,10 +42,11 @@
     "stylelint": "^10.1.0"
   },
   "scripts": {
+    "prepare": "./.githooks/deploy.sh",
     "lint": "eslint --report-unused-disable-directives . && prettier --check '**/?(.)*.{md,css,scss,js,json,yaml,yml,html}'",
     "format": "prettier --write '**/?(.)*.{md,css,scss,js,json,yaml,yml,html}'",
     "build:docs": "node src/documentation.js && prettier --write README.md",
-    "test": "jest --coverage",
+    "test": "jest",
     "test:rules": "stylelint-find-new-rules src/unused.js --unused --deprecated --invalid",
     "test:watch": "jest --watch",
     "prepublishOnly": "npm run build:docs"