@leverege/build-tools 2.58.5 → 2.58.6

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@leverege/build-tools",
-  "version": "2.58.5",
+  "version": "2.58.6",
   "description": "A collection of build / support tools for Leverege developers",
   "main": "index.js",
   "repository": {
@@ -81,7 +81,7 @@
     "readline-sync": "^1.4.10",
     "semver": "^7.6.3",
     "simple-git": "^3.27.0",
-    "zx": "^8.2.4"
+    "zx": "^8.3.0"
   },
   "devDependencies": {
     "@leverege/eslint-config-leverege": "^5.0.1",

package/src/Utils.mjs

@@ -477,7 +477,7 @@ export const analyzeRepository = async ( giveGuidance ) => {
     await shellCmd( 'npm run build' )
   }
 
-  const buildToolsVersion = closestPackageJson.devDependencies['@leverege/build-tools']
+  const buildToolsVersion = closestPackageJson.devDependencies['@leverege/build-tools'] || closestPackageJson.dependencies['@leverege/build-tools']
   if ( !buildToolsVersion ) {
     errorExit( 'Error: missing devDependency for @leverege/build-tools in package.json' )
   }

package/src/circleate.sh

@@ -347,7 +347,7 @@ jobs:
           at: ~/project
       - run:
           name: Generate docs
-          command: npx jsdoc -r src -R README.md -d docs
+          command: npm run docs
       - store_artifacts:
           path: docs
           prefix: docs

package/src/generate-docs-conf.json

@@ -17,7 +17,6 @@
     }
   },
   "opts": {
-    "template": "node_modules/@leverege/jsdoc-template",
     "encoding": "utf8",
     "lenient": false,
     "markdown": true

package/src/generate-docs.mjs

@@ -19,6 +19,12 @@ import {
 
 const jsdocConfig = `${BUILD_TOOLS_ROOT}/generate-docs-conf.json`
 
+// build the location of the template file from the build-tools root
+// in order to avoid hardcoding in the jsdoc config file - this is
+// important in order to support running generate-docs from a user's
+// laptop or deployed to the doc-creator service on k8s
+const jsdocTemplate = `${BUILD_TOOLS_ROOT}/../../jsdoc-template`
+
 if ( !fs.existsSync( jsdocConfig ) ) { // eslint-disable-line security/detect-non-literal-fs-filename
   err( `cannot find the jsdoc config file: ${jsdocConfig}` )
   process.exit( 1 )
@@ -35,7 +41,7 @@ if ( fs.existsSync( 'docs' ) ) {
 fs.mkdirSync( 'docs/md', { recursive : true } )
 
 try {
-  await shellCmd( `npx --yes jsdoc -c ${jsdocConfig} -R README.md -d docs src` )
+  await shellCmd( `npx --yes jsdoc -c ${jsdocConfig} -t ${jsdocTemplate} -R README.md -d docs src` )
   await shellCmd(
     `npx --yes --package=jsdoc-to-markdown jsdoc2md --files src/*.js --configure ${jsdocConfig}`,
     { stdout : { file : 'docs/md/API.md' } }