@gesslar/bedoc 1.10.0 → 1.11.0

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@gesslar/bedoc",
-  "version": "1.10.0",
+  "version": "1.11.0",
   "description": "Pluggable documentation engine for any language and format",
   "publisher": "gesslar",
   "author": "gesslar",

package/src/cli.js

@@ -11,7 +11,7 @@ import {ConfigurationParameters} from "./core/ConfigurationParameters.js"
 import * as ActionUtil from "./core/util/ActionUtil.js"
 import * as FDUtil from "./core/util/FDUtil.js"
 
-const {loadJson} = ActionUtil
+const {loadDataFile} = ActionUtil
 const {resolveFilename,resolveDirectory} = FDUtil
 
 // Main entry point
@@ -20,7 +20,7 @@ const {resolveFilename,resolveDirectory} = FDUtil
     // Get package info
     const basePath = resolveDirectory(process.cwd())
     const thisPath = resolveDirectory(fileURLToPath(new URL("..", import.meta.url)))
-    const bedocPackageJson = loadJson(resolveFilename("package.json", thisPath))
+    const bedocPackageJson = loadDataFile(resolveFilename("package.json", thisPath))
 
     // Setup program
     program

package/src/core/Configuration.js

@@ -11,7 +11,7 @@ import * as ActionUtil from "./util/ActionUtil.js"
 import * as DataUtil from "./util/DataUtil.js"
 import * as FDUtil from "./util/FDUtil.js"
 
-const {loadJson} = ActionUtil
+const {loadDataFile} = ActionUtil
 const {isNothing, isType, mapObject} = DataUtil
 const {getFiles, composeFilename, fileExists} = FDUtil
 const {resolveDirectory, resolveFilename} = FDUtil
@@ -222,7 +222,7 @@ export default class Configuration {
     } else {
       const packageJsonFile = composeFilename(process.cwd(), "package.json")
       if(fileExists(packageJsonFile)) {
-        const packageJson = loadJson(packageJsonFile)
+        const packageJson = loadDataFile(packageJsonFile)
 
         if(packageJson.bedoc)
           allOptions.push({source: "packageJson", options: packageJson.bedoc})
@@ -246,7 +246,7 @@ export default class Configuration {
       if(!configFile)
         throw new Error("No config file specified")
 
-      const configObject = loadJson(configFile)
+      const configObject = loadDataFile(configFile)
       const subConfigName =
         entryOptions?.sub ||
         packageJson?.sub ||

package/src/core/Discovery.js

@@ -9,7 +9,7 @@ import * as DataUtil from "./util/DataUtil.js"
 const {composeDirectory,directoryExists,resolveDirectory} = FDUtil
 const {newContract,parse} = ContractManager
 const {ls,fileExists,composeFilename,getFiles} = FDUtil
-const {actionTypes, actionMetaRequirements, loadJson} = ActionUtil
+const {actionTypes, actionMetaRequirements,loadDataFile} = ActionUtil
 const {isType} = DataUtil
 
 export default class Discovery {
@@ -112,7 +112,7 @@ export default class Discovery {
           if(!fileExists(packageJsonFile))
             continue
 
-          const packageJson = loadJson(packageJsonFile)
+          const packageJson = loadDataFile(packageJsonFile)
           if(!packageJson.bedoc)
             continue
 

package/src/core/util/ActionUtil.js

@@ -1,6 +1,7 @@
 import * as FDUtil from "./FDUtil.js"
 import process from "node:process"
 import JSON5 from "json5"
+import YAML from "yaml"
 
 const {readFile, fileExists, composeFilename} = FDUtil
 
@@ -14,16 +15,24 @@ const actionMetaRequirements = freeze({
 })
 
 /**
- * Loads a JSON file asynchronously
+ * Loads an object from JSON or YAML provided a fileMap
  *
- * @param {object} jsonFileObject - The JSON file to load
- * @returns {object} The parsed JSON content
+ * @param {object} fileMap - The FileObj file to load containing
+ *  JSON or YAML text.
+ * @returns {object} The parsed data object.
  */
-function loadJson(jsonFileObject) {
-  // Read the file
-  const jsonContent = readFile(jsonFileObject)
-  const json = JSON5.parse(jsonContent)
-  return json
+function loadDataFile(fileMap) {
+  const content = readFile(fileMap)
+
+  try {
+    return JSON5.parse(content)
+  } catch{
+    try {
+      return YAML.parse(content)
+    } catch{
+      throw new Error("Content is neither valid JSON nor valid YAML")
+    }
+  }
 }
 
 /**
@@ -48,6 +57,6 @@ export {
   actionMetaRequirements,
   actionTypes,
   // Functions
-  loadJson,
+  loadDataFile,
   loadPackageJson,
 }

package/src/core/util/ModuleUtil.js

@@ -1,40 +0,0 @@
-import {createRequire} from "module"
-import FDUtil from "./FDUtil.js"
-import JSON5 from "json5"
-
-export default class ModuleUtil {
-  /**
-   * Requires a module synchronously
-   *
-   * @param {object} fileObject - The file to require
-   * @returns {object} The required module
-   */
-  static require(fileObject) {
-    return createRequire(import.meta.url)(fileObject.absolutePath)
-  }
-
-  /**
-   * Loads a JSON file asynchronously
-   *
-   * @param {object} jsonFileObject - The JSON file to load
-   * @returns {Promise<object>} The parsed JSON content
-   */
-  static async loadJson(jsonFileObject) {
-    // Read the file
-    const jsonContent = await FDUtil.readFile(jsonFileObject)
-    const json = JSON5.parse(jsonContent)
-    return json
-  }
-
-  /**
-   * Loads the package.json file asynchronously
-   *
-   * @returns {Promise<object>} The parsed package.json content
-   */
-  static async loadPackageJson() {
-    const packageJsonFileObject = FDUtil.resolveFilename("./package.json")
-    const jsonContent = await FDUtil.readFile(packageJsonFileObject)
-    const json = JSON5.parse(jsonContent)
-    return json
-  }
-}