@leverege/build-tools 2.58.1 → 2.58.2

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@leverege/build-tools",
-  "version": "2.58.1",
+  "version": "2.58.2",
   "description": "A collection of build / support tools for Leverege developers",
   "main": "index.js",
   "repository": {
@@ -65,10 +65,10 @@
     "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",
     "ms": "^2.1.3",
     "npm-registry-fetch": "^18.0.2",

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/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,61 @@
+#!/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,
+  log,
+  shellCmd,
+} from './Utils.mjs'
+
+const jsdocConfig = `{
+  "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"
+      }
+    }
+  }
+}`
+
+const repoDescr = await getRepositoryDescr()
+
+condir( { jsdocConfig, repoDescr }, '<==The Repo' )