@ministryofjustice/hmpps-precommit-hooks 0.0.1 → 0.0.3

package/CHANGELOG.md

@@ -1,10 +1,18 @@
 # Change log
 
+## 0.0.3
+
+Remove pipefail from prepare script
+
+## 0.0.2
+
+Fix issue with alpine not having bash installed.
+Also providing ability to disable running script inside docker
+
 ## 0.0.1
 
 Initial release
 
-
 ## 0.0.1-alpha.1
 
 Pre-releases which should not be used in projects.

package/README.md

@@ -45,6 +45,10 @@ The prepare script will trigger on any install and ensure that `gitleaks` is ins
 
 Note: `gitleaks` is installed by `brew`, if `brew` is not available then `prepare` will currently fail loudly and display a message.
 
+### Prevent precommit script initialising on prepare
+
+To disable the tool running on `npm install` and initialising husky and installing gitleaks, you can pass the `SKIP_PRECOMMIT_INIT=true` env var.
+
 ### Dealing with false positives
 
 When a secret is detected, gitleaks will create a fingerprint. If the secret is a false positive then this can be added to the `./gitleaks/.gitleaksignore` to exclude from future scans.

package/bin/prepare.sh

@@ -1,9 +1,9 @@
-#!/bin/bash
+#!/bin/sh
 #
 # This runs as part of any `npm install` via `prepare`
 # 
 
-set -eo pipefail
+set -e
 
 startStage() {
   printf "%s" "$1"
@@ -17,8 +17,8 @@ printError() {
   printf "\x1b[1;31m%s\x1b[0m\n" "$1"
 }
 
-if [ "$CI" = "true" ]; then
-  endStage "Not initialising precommit hooks in CI..."
+if [ "$CI" = "true" ] || [ "$SKIP_PRECOMMIT_INIT" = "true" ]; then
+  endStage "Not initialising precommit hooks..."
   exit 0
 fi 
 
@@ -26,15 +26,14 @@ fi
 node_modules/.bin/husky
 
 # Check brew exists
-if ! command -v brew &> /dev/null; then
+if ! command -v brew > /dev/null 2> /dev/null; then
   printError "Brew is not installed. You will need to install gitleaks separately and ensure it's on your PATH. exiting..."
   exit 0
 fi
 
 # Initialise gitleaks
-if ! command -v gitleaks &> /dev/null; then
+if ! command -v gitleaks > /dev/null 2> /dev/null; then
   startStage "Installing gitleaks"
   brew install gitleaks
   endStage " ✅ "
 fi
-

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@ministryofjustice/hmpps-precommit-hooks",
-  "version": "0.0.1",
+  "version": "0.0.3",
   "description": "Precommit hooks for HMPPS typescript projects",
   "keywords": [
     "precommit"