@leverege/build-tools 2.58.1 → 2.58.3-svcman.1

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@leverege/build-tools",
-  "version": "2.58.1",
+  "version": "2.58.3-svcman.1",
   "description": "A collection of build / support tools for Leverege developers",
   "main": "index.js",
   "repository": {
@@ -11,6 +11,7 @@
     "clean": "rm -rf lib",
     "lint": "find ./src -name \\*.\\*js | xargs npx eslint --report-unused-disable-directives",
     "prepare": "[ $SKIP_PREPARE ] && exit 0 || hook-and-release",
+    "postinstall": "ln -sf node_modules/@leverege/service-man/bin/service-man bin/service-man",
     "test": "echo \"no tests specified\" && exit 0"
   },
   "bin": {
@@ -27,6 +28,7 @@
     "encrypt-secrets": "src/encrypt-secrets.sh",
     "firebaseDeploy": "src/firebaseDeploy.mjs",
     "firebaseServe": "src/firebaseServe.mjs",
+    "generate-docs": "src/generate-docs.mjs",
     "getfbcfg": "src/getfbcfg.mjs",
     "getjson": "src/getjson.mjs",
     "git-tar": "src/git-tar.sh",
@@ -59,17 +61,20 @@
   "license": "SEE LICENSE IN LICENSE.md",
   "dependencies": {
     "@google-cloud/artifact-registry": "^3.5.0",
+    "@leverege/jsdoc-template": "^1.0.1",
+    "@leverege/service-man": "^1.8.0",
     "ansi-colors": "^4.1.3",
     "chalk": "^5.3.0",
     "command-line-args": "^6.0.1",
     "command-line-usage": "^7.0.3",
     "deepmerge": "^4.3.1",
     "enquirer": "^2.4.1",
-    "execa": "^9.5.1",
+    "execa": "^9.5.2",
     "glob": "^11.0.0",
     "handlebars": "^4.7.8",
-    "inquirer": "^12.1.0",
+    "inquirer": "^12.2.0",
     "js-yaml": "^4.1.0",
+    "jsdoc": "^4.0.4",
     "ms": "^2.1.3",
     "npm-registry-fetch": "^18.0.2",
     "package-up": "^5.0.0",

package/src/Docker.mjs

@@ -13,6 +13,9 @@ import {
   warning
 } from './Utils.mjs'
 
+// TODO: change default to node 22 (jod) after 01/01/25
+const dockerfileNodeVersion = process.env.USE_NODEJS_22 ? 'jod-alpine' : 'iron-alpine'
+
 // The contents of these variables were initially located in files that live in
 // the build-tools repository, but it just became simpler to pull the contents
 // directly into these variables and forego the file loading.
@@ -187,7 +190,11 @@ const generateDockerfile = ( options ) => {
 
   const settings = { ...defaultSettings, ...options }
 
-  log( { settings }, chalk.green.bold( 'Validating the docker structure\n' ) )
+  // defaults to the current "official" version of node unless it gets
+  // overridden in the leverege.nodeimg package.json stanza
+  if ( !settings.nodeimage ) {
+    settings.nodeimage = dockerfileNodeVersion
+  }
 
   // Ensure the presence of the docker dir with plugin and bashrc - this code
   // could probably be tightened up a little.
@@ -227,14 +234,14 @@ const generateDockerfile = ( options ) => {
 
   // At this point the plugin template better exist.
   if ( fs.existsSync( dockerfilePlugin ) ) {
-    defaultSettings.pluginfile = fs.readFileSync( dockerfilePlugin )
+    settings.pluginfile = fs.readFileSync( dockerfilePlugin )
   } else {
     errorExit( `***ERROR: something went wrong with ${dockerfilePlugin} plugin creation` )
   }
 
   const dockerfilePrePlugin = './docker/DockerfilePreInstall.plugin'
   if ( fs.existsSync( dockerfilePrePlugin ) ) {
-    defaultSettings.preInstallPluginfile = fs.readFileSync( dockerfilePrePlugin )
+    settings.preInstallPluginfile = fs.readFileSync( dockerfilePrePlugin )
   }
 
   const compiled = handlebars.compile( dockerfileTemplate, { noEscape : true } )
@@ -249,7 +256,7 @@ const generateDockerfile = ( options ) => {
   }
 
   const previousBuild = getPreviousBuild()
-  const dockerInfo = { dockerfile, previousBuild, ...defaultSettings }
+  const dockerInfo = { dockerfile, previousBuild, ...settings }
   delete dockerInfo.pluginfile
   return dockerInfo
 }

package/src/Utils.mjs

@@ -1,4 +1,6 @@
 import { existsSync, readdirSync, readFileSync } from 'node:fs'
+import path from 'node:path'
+import url from 'node:url'
 
 import chalk from 'chalk'
 import { $ } from 'execa'
@@ -36,6 +38,21 @@ export const errorExit = ( error, opts = { errorCode : 1 } ) => {
 }
 /* eslint-enable no-console */
 
+const getFilename = () => {
+    const filename = url.fileURLToPath( import.meta.url )
+    return filename
+}
+
+const getDirname = () => {
+    const dirname = path.dirname( getFilename() )
+    return dirname
+}
+
+// because __dirname goes away with ESM
+export const getSourceTop = () => {
+  return getDirname()
+}
+
 export const isHex = ( hex ) => {
   return hex instanceof Buffer || /^[0-9a-f]+$/i.test( hex )
 }

package/src/generate-docs-conf.json

@@ -0,0 +1,40 @@
+{
+  "tags": {
+    "allowUnknownTags": false
+  },
+  "source": {
+    "includePattern": "\\.(js|mjs|jsx)$",
+    "excludePattern": "(node_modules/|docs)"
+  },
+  "plugins": [],
+  "templates": {
+    "cleverLinks": true,
+    "monospaceLinks": false,
+    "default": {
+      "useLongnameInNav": true,
+      "outputSourceFiles": false
+    }
+  },
+  "opts": {
+    "template": "node_modules/@leverege/jsdoc-template",
+    "encoding": "utf8",
+    "lenient": false
+  },
+  "docdash": {
+    "static": true,
+    "sort": false,
+    "search": true,
+    "collapse": true,
+    "typedefs": true,
+    "removeQuotes": "none",
+    "scripts": [],
+    "menu":{
+      "Bitbucket": {
+	"href":"https://bitbucket.org/leverege/IF_THIS_MAKES_SENSE",
+	"target":"_blank",
+	"class":"menu-item",
+	"id":"repository"
+      }
+    }
+  }
+}

package/src/generate-docs.mjs

@@ -0,0 +1,29 @@
+#!/usr/bin/env node
+/*
+ * Encapsulates the rather lengthy jsdoc / md docs npm script:
+ *
+ *   npx jsdoc -c ./jsdoc.json -R README.md -d docs src && \
+ *   mkdir -p docs/md && \
+ *   npx --package=jsdoc-to-markdown jsdoc2md --files src/*.js --configure ./jsdoc.json > docs/md/API.md
+ *
+ */
+import {
+  condir,
+  debug,
+  getRepositoryDescr,
+  getSourceTop,
+  log,
+  shellCmd,
+} from './Utils.mjs'
+
+
+const jsdocTemplate = `${getSourceTop()}/jsdoc-template`
+const jsdocConfig = `${jsdocTemplate}/jsdoc.json`
+
+const repoDescr = await getRepositoryDescr()
+
+condir( { jsdocTemplate, jsdocConfig, repoDescr }, '<==The Repo' )
+
+await shellCmd( `npx jsdoc -c ${jsdocConfig} -R README.md -d docs src` )
+await shellCmd( 'mkdir -p docs/md' )
+await shellCmd( `npx --package=jsdoc-to-markdown jsdoc2md --files src/*.js --configure ./jsdoc.json`, { stdout : { file : 'docs/md/API.md' } } )

package/src/helm-charts/elasticsearch8/helmup.plugin

@@ -2,7 +2,7 @@
 #
 showInstalling "Elastic Search 8"
 
-[ -z "$ELASTIC_CHART_VERSION" ] && ELASTIC_CHART_VERSION="21.3.22"
+[ -z "$ELASTIC_CHART_VERSION" ] && ELASTIC_CHART_VERSION="21.4.0"
 
 OCI_CHART="oci://registry-1.docker.io/bitnamicharts/elasticsearch"
 

package/src/helm-charts/redis/helmup.plugin

@@ -4,7 +4,7 @@ showInstalling "Redis"
 
 OCI_CHART="oci://registry-1.docker.io/bitnamicharts/redis"
 
-[ -z "$REDIS_CHART_VERSION" ] && REDIS_CHART_VERSION="20.3.0"
+[ -z "$REDIS_CHART_VERSION" ] && REDIS_CHART_VERSION="20.5.0"
 
 helm upgrade --install redis $OCI_CHART       \
              --values  redis/redis-local.yaml \

package/src/helm-charts/velero/helmup.plugin

@@ -4,7 +4,7 @@ showInstalling "Velero Backup System"
 
 addHelmRepo vmware-tanzu https://vmware-tanzu.github.io/helm-charts
 
-[ -z "$VELERO_CHART_VERSION" ] && VELERO_CHART_VERSION="7"
+[ -z "$VELERO_CHART_VERSION" ] && VELERO_CHART_VERSION="8"
 #
 # Build the bucket, region and SA email variables and use --set to mod the
 # chart values as opposed to using an OVH:<label> approach. This eliminates

package/src/helmup.sh

@@ -699,10 +699,10 @@ function installVeleroEnvironment() {
   gcloud config set project $GCP_PROJECT_ID
 
   ## The major chart version will determine the bucket suffix
-  [ -z "$VELERO_HELM_CHART" ] && VELERO_HELM_CHART="7"
+  [ -z "$VELERO_CHART_VERSION" ] && VELERO_CHART_VERSION="8"
 
   ## Create a bucket
-  BUCKET="$GCP_PROJECT_ID-velero-$VELERO_HELM_CHART"
+  BUCKET="$GCP_PROJECT_ID-velero-$VELERO_CHART_VERSION"
   printf "\nCreating storage bucket `color g $BUCKET` in `color g $GCE_REGION`\n"
   gsutil mb -l $GCE_REGION gs://$BUCKET/ &> $DEVNULL
   warnOnError $? "Bucket failed to create or already exists - go check it\n"

package/src/jsdoc-template/README.md

@@ -0,0 +1,62 @@
+# JSDoc Template
+
+## Install
+
+```bash
+$ npm install --save-dev @leverege/jsdoc-template
+```
+
+## Usage
+
+In your package.json, update doces to look like:
+
+```
+    "docs": "npx jsdoc -c jsdoc.json -R README.md -d docs src && mkdir -p docs/md && npx --package=jsdoc-to-markdown jsdoc2md --files src/*.js --configure ./jsdoc.json > docs/md/API.md",
+
+```
+
+Make a `jsdoc.json` file that looks like this:
+
+```
+{
+  "tags": {
+      "allowUnknownTags": false
+  },
+  "source": {
+      "includePattern": ".js?$",
+      "excludePattern": "(node_modules/|docs)"
+  },
+  "plugins": [],
+  "templates": {
+    "cleverLinks": true,
+    "monospaceLinks": false,
+    "default": {
+        "useLongnameInNav": true,
+        "outputSourceFiles": false
+    }
+  },
+  "opts": {
+    // FOR MONOREPOS: "template": "../../node_modules/@leverege/jsdoc-template",
+    "template": "node_modules/@leverege/jsdoc-template",
+    "encoding": "utf8",
+    "lenient": false
+  },
+  "docdash": {
+    "static": true,
+    "sort": false,
+    "search": true,
+    "collapse": true,
+    "typedefs": true,
+    "removeQuotes": "none",
+    "scripts": [],
+    "menu":{
+        "Bitbucket": {
+            "href":"https://bitbucket.org/leverege/IF_THIS_MAKES_SENSE",
+            "target":"_blank",
+            "class":"menu-item",
+            "id":"repository"
+        }
+    }
+  }
+}
+```

package/src/jsdoc-template/jsdoc.json

@@ -0,0 +1,40 @@
+{
+  "tags": {
+    "allowUnknownTags": false
+  },
+  "source": {
+    "includePattern": "\\.(js|mjs|jsx)$",
+    "excludePattern": "(node_modules/|docs)"
+  },
+  "plugins": [],
+  "templates": {
+    "cleverLinks": true,
+    "monospaceLinks": false,
+    "default": {
+      "useLongnameInNav": true,
+      "outputSourceFiles": false
+    }
+  },
+  "opts": {
+    "template": "node_modules/@leverege/jsdoc-template",
+    "encoding": "utf8",
+    "lenient": false
+  },
+  "docdash": {
+    "static": true,
+    "sort": false,
+    "search": true,
+    "collapse": true,
+    "typedefs": true,
+    "removeQuotes": "none",
+    "scripts": [],
+    "menu":{
+      "Bitbucket": {
+        "href":"https://bitbucket.org/leverege/IF_THIS_MAKES_SENSE",
+        "target":"_blank",
+        "class":"menu-item",
+        "id":"repository"
+      }
+    }
+  }
+}

package/src/jsdoc-template/package.json

@@ -0,0 +1,24 @@
+{
+  "name": "@leverege/jsdoc-template",
+  "version": "1.0.1",
+  "description": "A JSDoc Template based on Docdash with a few mods to template",
+  "main": "publish.js",
+  "scripts": {
+  },
+  "devDependencies": {
+    "jsdoc": "latest"
+  },
+  "license": "Apache-2.0",
+  "keywords": [
+    "jsdoc",
+    "template"
+  ],
+  "files": [
+    "publish.js",
+    "static",
+    "tmpl"
+  ],
+  "dependencies": {
+    "@jsdoc/salty": "^0.2.1"
+  }
+}