@leverege/build-tools 2.56.0 → 2.56.2

package/.husky/pre-commit

@@ -0,0 +1 @@
+unleash

package/.husky/pre-push

@@ -0,0 +1 @@
+unleash

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@leverege/build-tools",
-  "version": "2.56.0",
+  "version": "2.56.2",
   "description": "A collection of build / support tools for Leverege developers",
   "main": "index.js",
   "repository": {
@@ -10,7 +10,8 @@
   "scripts": {
     "clean": "rm -rf lib",
     "lint": "find ./src -name \\*.\\*js | xargs npx eslint --report-unused-disable-directives",
-    "test": "echo \"Error: no test specified\" && exit 1"
+    "prepare": "npx husky",
+    "test": "echo \"no tests specified\" && exit 0"
   },
   "bin": {
     "build-tools": "src/build-tools.mjs",
@@ -56,7 +57,7 @@
   "author": "Leverege Devs",
   "license": "SEE LICENSE IN LICENSE.md",
   "dependencies": {
-    "@google-cloud/artifact-registry": "^3.4.0",
+    "@google-cloud/artifact-registry": "^3.5.0",
     "ansi-colors": "^4.1.3",
     "chalk": "^5.3.0",
     "command-line-args": "^6.0.1",
@@ -66,7 +67,7 @@
     "execa": "^9.5.1",
     "glob": "^11.0.0",
     "handlebars": "^4.7.8",
-    "inquirer": "^12.0.1",
+    "inquirer": "^12.1.0",
     "js-yaml": "^4.1.0",
     "ms": "^2.1.3",
     "npm-registry-fetch": "^18.0.2",
@@ -76,10 +77,11 @@
     "readline-sync": "^1.4.10",
     "semver": "^7.6.3",
     "simple-git": "^3.27.0",
-    "zx": "^8.2.0"
+    "zx": "^8.2.1"
   },
   "devDependencies": {
     "@leverege/eslint-config-leverege": "^5.0.1",
+    "husky": "^9.1.6",
     "npm": "^10.9.0"
   }
 }

package/src/Utils.mjs

@@ -9,6 +9,7 @@ import YAML from 'js-yaml'
 
 let debugEnabled = process.env.BUILD_TOOLS_DEBUG === '1'
 
+export const enableDebug = () => { debugEnabled = true }
 export const disableDebug = () => { debugEnabled = false }
 
 /* eslint-disable no-console */
@@ -382,13 +383,14 @@ export const parseHelmChart = async ( helmroot = './helm' ) => {
   } )
 }
 
-export const analyzeRepository = async ( giveGuidance ) => {
+export const getRepositoryDescr = async () => {
+  const currentDir = process.cwd()
+  const workingDir = process.env.PWD
   const gitRoot = await getGitRootDirectory()
+  const { branch : gitBranch, upstream : gitUpstream } = await getGitUpstream()
   const subPkgs = await glob( `${gitRoot}/packages/**/package.json`, { ignore : '/**/node_modules/**' } )
   const helmChart = await parseHelmChart()
   const isMonoRepo = subPkgs?.length > 0
-
-  // Verify the presence of a root package.json file for all monorepos
   let rootPackageJson
   try {
     rootPackageJson = await parseJsonFile( `${gitRoot}/package.json` )
@@ -396,6 +398,31 @@ export const analyzeRepository = async ( giveGuidance ) => {
     rootPackageJson = { isInvalid : true, error : 'invalid or non-existent root package.json file' }
   }
   const isNpmWorkspace = rootPackageJson?.workspaces?.length > 0
+
+  return {
+    currentDir,
+    workingDir,
+    gitBranch,
+    gitRoot,
+    gitUpstream,
+    helmChart,
+    isMonoRepo,
+    isNpmWorkspace,
+    rootPackageJson,
+    subPkgs,
+  }
+}
+
+export const analyzeRepository = async ( giveGuidance ) => {
+  const {
+    gitRoot,
+    subPkgs,
+    helmChart,
+    isMonoRepo,
+    rootPackageJson,
+    isNpmWorkspace,
+  } = await getRepositoryDescr()
+
   if ( isMonoRepo && rootPackageJson.isInvalid ) {
     log( chalk.red.bold( `
   ***REQUIRED: A package.json file is required at the monorepo root` ) )

package/src/chart-compass.mjs

@@ -22,7 +22,7 @@ import {
   shellCmd } from './Utils.mjs'
 
 const commandLineOptions = [ // Use commandLineOptions to tie into the Usage statements
-  /* eslint-disable max-len */
+   
   {
     name : 'location',
     type : String,
@@ -48,7 +48,7 @@ const commandLineOptions = [ // Use commandLineOptions to tie into the Usage sta
     type : Boolean,
     description : '{green display this help screen}',
   },
-  /* eslint-enable max-len */
+   
 ]
 
 const sections = [

package/src/chart-to-registry.mjs

@@ -20,7 +20,6 @@ import {
   shellCmd } from './Utils.mjs'
 
 const commandLineOptions = [ // Use commandLineOptions to tie into the Usage statements
-  /* eslint-disable max-len */
   {
     name : 'location',
     type : String,
@@ -51,7 +50,6 @@ const commandLineOptions = [ // Use commandLineOptions to tie into the Usage sta
     type : Boolean,
     description : '{green display this help screen}',
   },
-  /* eslint-enable max-len */
 ]
 
 const sections = [

package/src/docker-to-registry.mjs

@@ -118,7 +118,6 @@ await shellCmd( 'npm install', { stdio : 'inherit' } )
 
 if ( giveGuidance ) {
   await docker.repoCleanup() // adjusts gitignore files and removes cruft
-  /* eslint-disable max-len */
   log( `
 
 

package/src/firebaseDeploy.mjs

@@ -1,7 +1,6 @@
 #!/usr/bin/env node
 /* eslint-disable no-console */
 // https://github.com/google/zx
-/* eslint-disable max-len */
 import pkg from 'enquirer'
 import { $, fs, argv, path, chalk } from 'zx'
 

package/src/firebaseServe.mjs

@@ -1,6 +1,5 @@
 #!/usr/bin/env node
 // https://github.com/google/zx
-/* eslint-disable max-len */
 /* eslint-disable no-console */
 import pkg from 'enquirer'
 import { $, fs, argv, path, chalk } from 'zx'

package/src/hook-and-release.mjs

@@ -0,0 +1,161 @@
+#!/usr/bin/env node
+
+import fs from 'node:fs'
+import path from 'node:path'
+
+import chalk from 'chalk'
+import commandLineArgs from 'command-line-args'
+import commandLineUsage from 'command-line-usage'
+import SimpleGit from 'simple-git'
+
+import {
+  condir,
+  debug,
+  enableDebug,
+  getRepositoryDescr,
+  log,
+  shellCmd,
+} from './Utils.mjs'
+
+const git = new SimpleGit()
+const repoDescr = await getRepositoryDescr()
+
+debug( { repoDescr }, '--------LOCAL UNLEASH-------' )
+
+const hookAndReleaseOptions = [
+  {
+    name : 'init',
+    type : Boolean,
+    default : false,
+    description : '{green bootstraps the repo .har directory and adds appropriate git hook}',
+  },
+  {
+    name : 'debug',
+    type : Boolean,
+    default : false,
+    description : '{yellow enables verbose debugging}',
+  },
+  {
+    name : 'help',
+    type : Boolean,
+    default : false,
+    description : '{green display this help screen}',
+  },
+]
+
+const sections = [
+  {
+    header : 'Leverege Hook and Release Script',
+    content : '{green This tool help...}',
+  },
+  {
+    header : 'Options',
+    optionList : hookAndReleaseOptions,
+  },
+]
+
+const args = commandLineArgs( hookAndReleaseOptions, { camelCase : true, partial : true } )
+const usage = commandLineUsage( sections )
+
+if ( args.debug ) {
+  enableDebug()
+}
+
+if ( args.help ) {
+  log( usage )
+  process.exit( 0 )
+}
+
+/* eslint-disable no-underscore-dangle */
+if ( args._unknown ) {
+  log( usage )
+    log( `\nUnrecognized argument [${chalk.bold.red( args._unknown )}]\n` )
+    process.exit( 1 )
+}
+/* eslint-enable no-underscore-dangle */
+
+if ( args.init ) {
+  const harDir = `${repoDescr.gitRoot}/.har`
+  if ( fs.existsSync( harDir ) ) {
+    log( `this repo already has ${harDir}` )
+    process.exit( 1 )
+  }
+
+  fs.mkdirSync( harDir )
+  await git.addConfig( 'core.hookspath', '.har' )
+  process.exit( 0 )
+}
+
+const getCurrentBranchName = async () => {
+  const branchInfo = await git.branch()
+
+  // first check to see if there are no branches - new repo?
+  if ( Object.keys( branchInfo.branches ).length === 0 ) { return '' }
+
+  return Object
+    .entries( branchInfo.branches )
+    .find( ( [ name, info ] ) => ( info.current ) )[0]
+}
+
+const isProtected = async () => {
+  const theBranch = await getCurrentBranchName()
+
+  const protectedBranches = [ 'main', 'master', 'development' ]
+  const additionalProtectedBranches = [ ...process.argv.slice( 2 ) ]
+
+  // Check if the current branch starts with any of the additional
+  // protected branch name
+  let matchesAdditionalBranch = false
+  for ( let i = 0; i < additionalProtectedBranches.length; i++ ) {
+    matchesAdditionalBranch = matchesAdditionalBranch ||
+      theBranch.startsWith( additionalProtectedBranches[i] )
+  }
+
+  return protectedBranches.includes( theBranch ) || matchesAdditionalBranch
+}
+
+// Identify the package directory based on staged files
+const getPackageDirectory = async () => {
+  const gitDiff = await git.diff( [ '--name-only', '--cached' ] )
+  const stagedFiles = gitDiff.split( '\n' )
+  const packageDirs = new Set()
+
+  // Loop through staged files and extract package directories
+  stagedFiles.forEach( ( file ) => {
+    const parts = file.split( path.sep ) // Split path to identify package
+    if ( parts.length > 1 && parts[0] === 'packages' ) {
+      const packageDir = parts[1]
+      packageDirs.add( packageDir )
+    }
+  } )
+
+  const packageDirsArray = Array.from( packageDirs )
+  debug( { stagedFiles, packageDirsArray }, '<==unleash: getPackageDirectory' )
+  return packageDirsArray
+}
+
+const npmRunner = async ( script, packageDir ) => {
+  try {
+    const cmd = `npm run ${script}`
+    const results = await shellCmd( cmd, { cwd : path.join( process.cwd(), 'packages', packageDir ), stdio : 'inherit' } )
+    return results
+  } catch ( err ) {
+    process.exit( 1 )
+  }
+  return undefined
+}
+
+( async () => {
+  if ( await isProtected() ) {
+    const packageDirs = await getPackageDirectory()
+    for ( let pi = 0; pi < packageDirs.length; pi++ ) {
+      const packageDir = packageDirs[pi]
+      const script = [ 'test', 'lint' ]
+      for ( let i = 0; i < script.length; i++ ) {
+        await npmRunner( script[i], packageDir ) // eslint-disable-line no-await-in-loop
+      }
+    }
+  } else {
+    process.exit( 0 )
+  }
+} )()

package/src/overwhelm.mjs

@@ -266,19 +266,20 @@ const ahoy = glob.sync( '*/', opt )
 
 // Verifies that all values in a config block are quoted
 const validValuesLocalConfig = ( vlf ) => {
-  if ( ! fs.existsSync( vlf ) ) { return undefined }
+  if ( !fs.existsSync( vlf ) ) { return undefined }
 
   const valuesLocal = YAML.load( fs.readFileSync( vlf, { encoding : 'utf-8' } ) )
-  const configBlock = valuesLocal.config
+  const configBlock = valuesLocal?.config
 
   // only care about validating config at this time
   if ( configBlock ) {
-    for ( const [ key, value ] of Object.entries( configBlock ) ) {
-      if( ! isString( value ) ) {
+    Object.entries( configBlock ).forEach( ( cfgLine ) => {
+      const [ key, value ] = cfgLine
+      if ( !isString( value ) ) {
         err( { configBlock }, '***Bad config block' )
         errorExit( `Is ${key} missing quotes around ${value} in ${vlf}?` )
       }
-    }
+    } )
   }
 
   return true // TODO: return the already read valuesLocal info?

package/src/refresh-npm-token.mjs

@@ -29,7 +29,6 @@ import { lt as semverLt } from 'semver'
 import { debug, log, shellCmd } from './Utils.mjs'
 
 const refreshTokenOptions = [ // Use refreshTokenOptions to tie into the Usage statements
-  /* eslint-disable max-len */
   {
     name : 'project',
     type : String,
@@ -60,7 +59,6 @@ const refreshTokenOptions = [ // Use refreshTokenOptions to tie into the Usage s
     default : false,
     description : '{green display this help screen}',
   },
-  /* eslint-enable max-len */
 ]
 
 const sections = [
@@ -245,7 +243,6 @@ try {
 const now = ( new Date() ).toLocaleString()
 const account = await shellCmd( 'gcloud config get account' )
 const slackData = {
-  // eslint-disable-next-line max-len
   text : `--- npmrc refreshed by \`${account}\` at ${now}\n     tokens RW [\`${npmrc.token}\`] RO [\`${npmrcRo.token}\`]`,
   channel : slackConfig.channel,
 }

package/src/tag-release.mjs

@@ -1,7 +1,6 @@
 #!/usr/bin/env node
 /* eslint-disable security/detect-unsafe-regex */
 /* eslint-disable no-console */
-/* eslint-disable max-len */
 
 import path from 'node:path'