@leverege/build-tools 2.57.2 → 2.57.3

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@leverege/build-tools",
-  "version": "2.57.2",
+  "version": "2.57.3",
   "description": "A collection of build / support tools for Leverege developers",
   "main": "index.js",
   "repository": {

package/src/hook-and-release/Config.mjs

@@ -44,29 +44,18 @@ const cliSections = [
 handle git hooks in standard git repositories as well as git monorepos. It
 connects into a repository's git hook system after a repo is cloned. The hook
 connection is made during the {yellow.bold npm install} phase, which will execute the
-{yellow.bold npm prepare} script as defined in the package.json scripts section:
+{yellow.bold npm prepare} script as defined in the package.json scripts section.
 
   {yellow.bold "scripts": {
     ...
     "prepare": "[ $SKIP_PREPARE ] && exit 0 || hook-and-release",
     ...
-  }
+  \\} }
 
-Note the {yellow SKIP_PREPARE} flag will be set in the docker-to-registry Dockerfile
-template in order to avoid setting up the hooks during the image build
+The {yellow SKIP_PREPARE} flag will be set in the {yellow docker-to-registry} Dockerfile
+template in order to avoid setting up the hook during the image build
 process. The hook is only relevant when doing local development and is
 totally divorced from the image building process.
-
-The hook-and-release script can be invoked directly from the command line,
-typically for first-time initialization, or from the git hook scripts located
-in the .har subdirectory in the root of a repository. Running with the {yellow.bold --init}
-command line switch will create the .har subdirectory at the repo root with a
-config.json file and two standard hook scripts, pre-commit and pre-push:
-
-  {yellow.bold .har
-  ├── config.json
-  ├── pre-commit
-  └── pre-push}
 }`
   },
   {
@@ -74,8 +63,21 @@ config.json file and two standard hook scripts, pre-commit and pre-push:
     optionList : cliOptionList,
   },
   {
-    header : 'Configuration File and Hook Scripts',
+    header : `
+Configuration Setup and Hook Scripts`,
     content : [
+      `{green To add hook-and-release to a repository simply run:
+
+  {yellow.bold hook-and-release --init}
+
+which will create the {yellow.bold .har} subdirectory at the repo root with a {yellow.bold config.json}
+file and two standard hook scripts, {yellow.bold pre-commit} and {yellow.bold pre-push}:
+
+  {yellow.bold .har
+  ├── config.json
+  ├── pre-commit
+  └── pre-push}
+}`,
       `{bold .har/config.json}   {green controls branch, script and package config
 {white.bold protected-branches} list of branch names to protect
 {white.bold npm-scripts}        list of npm scripts to run on protected branches
@@ -98,11 +100,11 @@ config.json file and two standard hook scripts, pre-commit and pre-push:
 
 {white.bold Example pre-commit script file contents}
 
-  hook-and-release --debug
+  {yellow hook-and-release --debug}
 
-which tell HAR to run with debugging enabled. This will print out copious
+which tells HAR to run with debugging enabled. This will display copious
 amounts of information and prevents the git command from succeeding, so
-it's more like a debug with dry-run. Removing the {yellow.bold --debug} will
+it's more like a debug with dry-run. Removing the {yellow --debug} will
 allow everything to run normally.
 }`
     ]
@@ -140,6 +142,7 @@ export default class Config {
 
     if ( this.cliArgs.init ) {
       await this.initializeConfiguration( this.harDir )
+      process.exit( 0 )
     }
 
     // Start with the basics, is there a root har directory?
@@ -224,6 +227,14 @@ export default class Config {
 
     makeHarHookScript( `${harDir}/pre-commit` )
     makeHarHookScript( `${harDir}/pre-push` )
+
+    const huskyWarningAndPrepare = `
+    Heads Up! Remove ${chalk.red.bold( 'husky' )} references from the package.json dependencies
+    and replace the ${chalk.yellow.bold( 'prepare' )} script with this:
+
+    ${chalk.green.bold( '"prepare": "[ $SKIP_PREPARE ] && exit 0 || hook-and-release",' )}
+`
+    log( huskyWarningAndPrepare )
   }
 
   async runNpmScripts( runDirectories = [] ) {