@gesslar/bedoc 1.5.1 → 1.6.0

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@gesslar/bedoc",
-  "version": "1.5.1",
+  "version": "1.6.0",
   "description": "Pluggable documentation engine for any language and format",
   "publisher": "gesslar",
   "main": "./src/core/Core.js",
@@ -39,6 +39,7 @@
     "dotenv": "^16.4.7",
     "error-stack-parser": "^2.1.4",
     "globby": "^14.0.2",
+    "json5": "^2.2.3",
     "micromatch": "^4.0.8",
     "node-fetch": "^3.3.2",
     "yaml": "^2.7.0"
@@ -49,8 +50,8 @@
     "@typescript-eslint/parser": "^8.22.0",
     "axios": "^1.7.9",
     "chokidar": "^4.0.3",
-    "eslint-plugin-jsdoc": "^50.6.3",
     "eslint": "^9.18.0",
+    "eslint-plugin-jsdoc": "^50.6.3",
     "form-data": "^4.0.1"
   },
   "keywords": [

package/src/core/ActionManager.js

@@ -71,9 +71,7 @@ export default class ActionManager {
     if(!setup)
       return
 
-    await this.action.setup.call(
-      this.action, {parent: this, log: this.#log}
-    )
+    await this.action.setup.call(this.action, {log: this.#log})
   }
 
   async #cleanupAction() {
@@ -119,7 +117,7 @@ export default class ActionManager {
       throw new Error(`No \`run\` function found for action \`${this.meta.action}\``)
 
     const actionResult = await func.call(
-      this.action, {moduleName: file.module, moduleContent: content}
+      this.action, {file, moduleContent: content}
     )
 
     return actionResult

package/src/core/Configuration.js

@@ -1,5 +1,6 @@
 import process from "node:process"
 import {Environment} from "./Core.js"
+import JSON5 from "json5"
 
 import {
   ConfigurationParameters,
@@ -217,7 +218,7 @@ export default class Configuration {
     if(environmentVariables)
       allOptions.push({source: "environment", options: environmentVariables})
 
-    const packageJson = entryOptions.packageJson
+    const packageJson = entryOptions?.packageJson
     if(packageJson?.bedoc)
       allOptions.push({source: "packageJson", options: packageJson.bedoc})
 
@@ -228,12 +229,16 @@ export default class Configuration {
       environmentVariables?.config
 
     if(useConfig) {
-      const configFilename = packageJson?.bedoc?.config || entryOptions.config
-
-      if(!configFilename)
+      const configFile =
+        packageJson?.bedoc?.config
+          ? resolveFilename(packageJson?.bedoc?.config)
+          : entryOptions.config?.value
+            ? resolveFilename(entryOptions.config.value)
+            : null
+
+      if(!configFile)
         throw new Error("No config file specified")
 
-      const configFile = resolveFilename(configFilename)
       const config = loadJson(configFile)
 
       allOptions.push({source: "config", options: config})
@@ -303,7 +308,7 @@ export default class Configuration {
 
     // Last, but not least, add any defaulted options that are not in the
     // mapped options
-    for(const [key, value] of Object.entries(entryOptions)) {
+    for(const [key, value] of Object.entries(entryOptions ?? {})) {
       if(!mappedOptions[key]) {
         if(value.source)
           mappedOptions[key] = value.value
@@ -329,7 +334,7 @@ export default class Configuration {
           switch(param.type.toString()) {
             case "boolean":
             case "number":
-              options[key] = JSON.parse(options[key])
+              options[key] = JSON5.parse(options[key])
               break
           }
         }

package/src/core/Discovery.js

@@ -50,10 +50,10 @@ export default class Discovery {
       debug("Mock path not set, discovering actions in node_modules", 1)
 
       debug("Looking for actions in project's package.json", 2)
-      if(this.core.packageJson?.bedoc?.modules) {
-        const actions = this.core.packageJson?.bedoc?.modules
+      if(this.core.packageJson?.modules) {
+        const actions = this.core.packageJson?.modules
 
-        debug("Found %d actions in package.json: %d", 3, actions)
+        debug("Found %d actions in package.json", 3, actions)
         debug("Actions found in package.json action in package.json: %o", 3, actions)
 
         if(actions && typeof(actions) === "object")
@@ -158,7 +158,7 @@ export default class Discovery {
 
     const loadedActions = []
     for(const file of toLoad) {
-      debug("Loading module `%s`", 2, file.absolutePath)
+      debug("Loading module `%s`", 2, file.absoluteUri)
 
       const loading = await this.#loadModule(file)
       const loaded = loading.actions.map((action, index) => {
@@ -283,8 +283,10 @@ export default class Discovery {
         debug("No specific `%s` action found", 3, actionType)
       }
 
+
       // Hmm! We didn't find anything specific. Let's check the criterion
       debug("Checking for `%s` actions with criterion `%s`", 3, actionType, criterion)
+      debug("Validated config to check against: %o", 3, validatedConfig)
       const found = actions[actionType].filter(a => {
         debug("Meta criterion value: %o", 4, a.action.meta[criterion])
         debug("Config criterion value: %o", 4, validatedConfig[criterion])
@@ -315,7 +317,7 @@ export default class Discovery {
 
     debug("2 Loading module `%j`", 2, module)
 
-    const {absolutePath: absoluteUri} = module
+    const {absoluteUri} = module
     const moduleExports = await import(absoluteUri)
 
     return {file: module, ...moduleExports}

package/src/core/HookManager.js

@@ -90,6 +90,7 @@ export default class HookManager {
       return null
 
     hooksObj.log = instance.log
+    hooksObj.timeout = this.timeout
     instance.#hooks = hooksObj
 
     debug("Hooks loaded successfully for `%s`", 2, instance.action)
@@ -121,7 +122,7 @@ export default class HookManager {
       assert(isType(hook, "function"), `Hook "${event}" is not a function`, 1)
 
       const hookExecution = await hook.call(this.hooks, args)
-      const hookTimeout = this.parent.timeout
+      const hookTimeout = this.timeout
       const expireAsync = () =>
         timeoutPromise(
           hookTimeout,

package/src/core/util/ActionUtil.js

@@ -1,4 +1,6 @@
 import * as FDUtil from "./FDUtil.js"
+import process from "node:process"
+import JSON5 from "json5"
 
 const {readFile, fileExists, composeFilename} = FDUtil
 
@@ -20,7 +22,7 @@ const actionMetaRequirements = freeze({
 function loadJson(jsonFileObject) {
   // Read the file
   const jsonContent = readFile(jsonFileObject)
-  const json = JSON.parse(jsonContent)
+  const json = JSON5.parse(jsonContent)
   return json
 }
 
@@ -31,11 +33,11 @@ function loadJson(jsonFileObject) {
  * @returns {object?} The parsed package.json content or null if the file does
  *                    not exist
  */
-function loadPackageJson(basePath = null) {
+function loadPackageJson(basePath = process.cwd()) {
   const packageJsonFileObject = composeFilename(basePath, "./package.json")
   if(fileExists(packageJsonFileObject)) {
     const jsonContent = readFile(packageJsonFileObject)
-    const json = JSON.parse(jsonContent)
+    const json = JSON5.parse(jsonContent)
     return json
   } else
     return null

package/src/core/util/FDUtil.js

@@ -256,7 +256,7 @@ async function getFiles(globPattern) {
     !globbyArray.length
   )
     throw new Error(
-      "[getFiles] Invalid glob pattern: Array must contain only strings.",
+      `Invalid glob pattern: Array must contain only strings. Got ${JSON.stringify(globPattern)}`,
     )
 
   // Use Globby to fetch matching files

package/src/core/util/ModuleUtil.js

@@ -1,5 +1,6 @@
 import {createRequire} from "module"
 import FDUtil from "./FDUtil.js"
+import JSON5 from "json5"
 
 export default class ModuleUtil {
   /**
@@ -21,7 +22,7 @@ export default class ModuleUtil {
   static async loadJson(jsonFileObject) {
     // Read the file
     const jsonContent = await FDUtil.readFile(jsonFileObject)
-    const json = JSON.parse(jsonContent)
+    const json = JSON5.parse(jsonContent)
     return json
   }
 
@@ -33,7 +34,7 @@ export default class ModuleUtil {
   static async loadPackageJson() {
     const packageJsonFileObject = FDUtil.resolveFilename("./package.json")
     const jsonContent = await FDUtil.readFile(packageJsonFileObject)
-    const json = JSON.parse(jsonContent)
+    const json = JSON5.parse(jsonContent)
     return json
   }
 }