@ministryofjustice/hmpps-precommit-hooks 0.0.1-alpha.4 → 0.0.2

package/CHANGELOG.md

@@ -1,5 +1,13 @@
 # Change log
 
+## 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
 

package/README.md

@@ -4,7 +4,8 @@ This package aims to automatically install and configure husky with gitleaks to
 
 ## Status
 
-This library is in alpha. Teams are free to use this library but further breaking changes may occur.
+**This library is currently: ready to adopt.**
+Teams are welcome to use this library. Please provide feedback via slack to the `#typescript` channel.
 
 ## Migrating existing projects
 
@@ -44,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/init.sh

@@ -6,11 +6,11 @@
 set -euo pipefail
 
 startStage() {
-  printf "\x1b[1;97m%s\x1b[0m" "$1"
+  printf "%s" "$1"
 }
 
 endStage() {
-  printf "\x1b[1;97m%s\x1b[0m\n" "$1"
+  printf "%s\n" "$1"
 }
 
 printError() {
@@ -18,7 +18,6 @@ printError() {
 }
 
 endStage "Setting up precommit hooks" 
-endStage "Checking prerequisites..." 
 
 if ! [ -f ./package.json ]; then
   printError "Not a node project: $(pwd)! exiting!"
@@ -45,8 +44,6 @@ else
   npm --silent  install
 fi
 
-endStage "Installing precommit hooks..."
-
 startStage "  * Adding npm scripts"
 npm pkg --silent set scripts.precommit:secrets="gitleaks git --pre-commit --redact --staged --verbose --config .gitleaks/config.toml" 
 npm pkg --silent set scripts.precommit:lint="node_modules/.bin/lint-staged"

package/bin/prepare.sh

@@ -1,4 +1,4 @@
-#!/bin/bash
+#!/bin/sh
 #
 # This runs as part of any `npm install` via `prepare`
 # 
@@ -6,19 +6,19 @@
 set -eo pipefail
 
 startStage() {
-  printf "\x1b[1;97m%s\x1b[0m" "$1"
+  printf "%s" "$1"
 }
 
 endStage() {
-  printf "\x1b[1;97m%s\x1b[0m\n" "$1"
+  printf "%s\n" "$1"
 }
 
 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
-  printError "Brew is not installed, WARNING: no precommit hook protection. exiting..."
+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-alpha.4",
+  "version": "0.0.2",
   "description": "Precommit hooks for HMPPS typescript projects",
   "keywords": [
     "precommit"
@@ -17,6 +17,9 @@
     "hmpps-precommit-hooks-prepare": "./bin/prepare.sh",
     "test-secret-protection": "./bin/test.sh"
   },
+  "scripts": {
+    "check-for-updates": "npx npm-check-updates -u"
+  },
   "files": [
     "*.md",
     "bin/*.sh",