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

package/README.md

@@ -1,4 +1,4 @@
-# @ministryofjustice/precommit-hooks
+# @ministryofjustice/hmpps-precommit-hooks
 
 This package aims to automatically install and configure husky with gitleaks to help catch potential secrets before committing them to github.
 
@@ -11,7 +11,7 @@ This library is in alpha. Teams are free to use this library but further breakin
 #### Automatically installing the library
 
 The package will self install and initialised by running via npx:
-`npx @ministryofjustice/precommit-hooks`
+`npx @ministryofjustice/hmpps-precommit-hooks`
 
 Note: The project needs to be initialised before use - solely adding the library will make no difference.
 Once the project has been initialised, other developers should be able to develop against it without further configuration.
@@ -67,13 +67,13 @@ See the gitleaks documentation for how to create rules and [examples](https://gi
 Secret protection can be tested using the following command:
 
 ```bash
-npx -p @ministryofjustice/precommit-hooks -c test-secret-protection
+npx -p @ministryofjustice/hmpps-precommit-hooks -c test-secret-protection
 ```
 
 This should fail similarly to:
 
 ```bash
-> npx -p @ministryofjustice/precommit-hooks -c test-secret-protection
+> npx -p @ministryofjustice/hmpps-precommit-hooks -c test-secret-protection
 Creating test file containing dummy AWS_KEY=AKIA<SOME-VALUE>ASD
 Attempting to commit file containing secret
 

package/bin/init.sh

@@ -26,7 +26,7 @@ if ! [ -f ./package.json ]; then
 fi
 
 startStage "  * Setting prepare script"
-npm pkg set --silent scripts.prepare="hmpps-precommit-hooks" 
+npm pkg set --silent scripts.prepare="hmpps-precommit-hooks-prepare" 
 endStage "  ✅"
 
 if npm list husky > /dev/null 2>&1; then
@@ -35,12 +35,12 @@ if npm list husky > /dev/null 2>&1; then
   endStage " ✅"
 fi
 
-if ! npm list @ministryofjustice/precommit-hooks > /dev/null 2>&1; then
-  startStage "  * Installing @ministryofjustice/precommit-hooks"
-  npm install --silent --save-dev @ministryofjustice/precommit-hooks
+if ! npm list @ministryofjustice/hmpps-precommit-hooks > /dev/null 2>&1; then
+  startStage "  * Installing @ministryofjustice/hmpps-precommit-hooks"
+  npm install --silent --save-dev @ministryofjustice/hmpps-precommit-hooks
   endStage " ✅"
 else
-  endStage "  * @ministryofjustice/precommit-hooks already installed ✅"
+  endStage "  * @ministryofjustice/hmpps-precommit-hooks already installed ✅"
   # Run npm install to trigger prepare script
   npm --silent  install
 fi
@@ -73,7 +73,7 @@ startStage "  * Creating project gitleaks config"
 printf "%s\n" \
      "title = \"HMPPS Gitleaks configuration\"" \
      "[extend]" \
-     "path = \"./node_modules/@ministryofjustice/precommit-hooks/config.toml\"" \
+     "path = \"./node_modules/@ministryofjustice/hmpps-precommit-hooks/config.toml\"" \
        > .gitleaks/config.toml
 endStage " ✅"
 

package/bin/prepare.sh

@@ -3,7 +3,7 @@
 # This runs as part of any `npm install` via `prepare`
 # 
 
-set -euo pipefail
+set -eo pipefail
 
 startStage() {
   printf "\x1b[1;97m%s\x1b[0m" "$1"
@@ -17,6 +17,11 @@ printError() {
   printf "\x1b[1;31m%s\x1b[0m\n" "$1"
 }
 
+if [ "$CI" = "true" ]; then
+  endStage "Not initialising precommit hooks in CI..."
+  exit 0
+fi 
+
 # Initialise husky
 node_modules/.bin/husky
 

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@ministryofjustice/hmpps-precommit-hooks",
-  "version": "0.0.1-alpha.2",
+  "version": "0.0.1-alpha.4",
   "description": "Precommit hooks for HMPPS typescript projects",
   "keywords": [
     "precommit"
@@ -14,7 +14,7 @@
   },
   "bin": {
     "@ministryofjustice/hmpps-precommit-hooks": "./bin/init.sh",
-    "hmpps-precommit-hooks": "./bin/prepare.sh",
+    "hmpps-precommit-hooks-prepare": "./bin/prepare.sh",
     "test-secret-protection": "./bin/test.sh"
   },
   "files": [