@gesslar/bedoc 1.6.1 → 1.7.0

package/package.json

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

package/src/cli.js

@@ -3,6 +3,7 @@
 import {program} from "commander"
 import console from "node:console"
 import process from "node:process"
+import {fileURLToPath,URL} from "node:url"
 
 import BeDoc, {Environment} from "./core/Core.js"
 import {ConfigurationParameters} from "./core/ConfigurationParameters.js"
@@ -10,18 +11,21 @@ import {ConfigurationParameters} from "./core/ConfigurationParameters.js"
 import * as ActionUtil from "./core/util/ActionUtil.js"
 import * as FDUtil from "./core/util/FDUtil.js"
 
-const {loadPackageJson} = ActionUtil
-const {resolveDirectory} = FDUtil
+const {loadJson} = ActionUtil
+const {resolveFilename,resolveDirectory} = FDUtil
 
 // Main entry point
 ;(async() => {
   try {
     // Get package info
     const basePath = resolveDirectory(process.cwd())
-    const packageJson = loadPackageJson(basePath)
+    const thisPath = resolveDirectory(fileURLToPath(new URL("..", import.meta.url)))
+    const bedocPackageJson = loadJson(resolveFilename("package.json", thisPath))
 
     // Setup program
-    program.name(packageJson.name).description(packageJson.description)
+    program
+      .name(bedocPackageJson.name)
+      .description(bedocPackageJson.description)
 
     // Build CLI
     for(const [name, parameter] of Object.entries(ConfigurationParameters)) {
@@ -42,7 +46,7 @@ const {resolveDirectory} = FDUtil
 
     // Add version option last
     program.version(
-      packageJson.version,
+      bedocPackageJson.version,
       "-v, --version",
       "Output the version number",
     )
@@ -68,7 +72,6 @@ const {resolveDirectory} = FDUtil
         options: {
           ...optionsWithSources,
           basePath: {value: basePath, source: "cli"},
-          packageJson: {value: packageJson, source: "cli"},
         },
         source: Environment.CLI
       })

package/src/core/Configuration.js

@@ -145,7 +145,7 @@ export default class Configuration {
     }
   }
 
-  #mapEntryOptions({options, source}) {
+  #mapEntryOptions({options = {}, source}) {
     // CLI already has done all the work via commander
     if(source === Environment.CLI)
       return options
@@ -162,15 +162,6 @@ export default class Configuration {
     if(!options.basePath)
       options.basePath = {value: dir, source}
 
-    // Inject packageJson if not available
-    if(!options.packageJson) {
-      const jsonFile = composeFilename(dir, "package.json")
-      if(fileExists(jsonFile)) {
-        const jsonObj = loadJson(jsonFile)
-        options.packageJson = {value: jsonObj, source}
-      }
-    }
-
     // Add defaults which are missing
     for(const [key, param] of Object.entries(ConfigurationParameters)) {
       if(options[key] === undefined && param.default !== undefined)
@@ -226,19 +217,28 @@ export default class Configuration {
       allOptions.push({source: "environment", options: environmentVariables})
 
     const packageJson = entryOptions?.packageJson
-    if(packageJson?.bedoc)
-      allOptions.push({source: "packageJson", options: packageJson.bedoc})
+    if(packageJson) {
+      allOptions.push({source: "packageJson", options: packageJson})
+    } else {
+      const packageJsonFile = composeFilename(process.cwd(), "package.json")
+      if(fileExists(packageJsonFile)) {
+        const packageJson = loadJson(packageJsonFile)
+
+        if(packageJson.bedoc)
+          allOptions.push({source: "packageJson", options: packageJson.bedoc})
+      }
+    }
 
     // Then the config file, if the options specified a config file
     const useConfig =
       entryOptions?.config ||
-      packageJson?.bedoc?.config ||
+      packageJson?.config ||
       environmentVariables?.config
 
     if(useConfig) {
       const configFile =
-        packageJson?.bedoc?.config
-          ? resolveFilename(packageJson?.bedoc?.config)
+        packageJson?.config
+          ? resolveFilename(packageJson?.config)
           : entryOptions.config?.value
             ? resolveFilename(entryOptions.config.value)
             : null
@@ -294,7 +294,8 @@ export default class Configuration {
     )
     const optionsOnly = nonEntryOptions.map(option => option.options)
     const mergedOptions = optionsOnly.reduce((acc, options) => {
-      for(const [key, value] of Object.entries(options)) acc[key] = value
+      for(const [key, value] of Object.entries(options))
+        acc[key] = value
 
       return acc
     }, {})

package/src/core/Conveyor.js

@@ -6,7 +6,7 @@ const {readFile, writeFile, composeFilename} = FDUtil
 
 export default class Conveyor {
   #succeeded = []
-  #warned  = []
+  #warned = []
   #errored = []
 
   constructor(parse, print, logger, output) {
@@ -83,11 +83,11 @@ export default class Conveyor {
     const {parse, print} = this
 
     try {
-      debug("Processing file: `%s`", 2, file.path)
+      debug("Processing file: %o", 2, file.path)
 
       // Step 1: Read file
       const fileContent = readFile(file)
-      debug("Read file content `%s` (%d bytes)", 2, file.path, fileContent.length)
+      debug("Read file content %o (%o bytes)", 2, file.path, fileContent.length)
 
       // Step 2: Parse file
       const parseResult = await parse.runAction({
@@ -98,12 +98,12 @@ export default class Conveyor {
         return parseResult
 
       if(parseResult.status === "warning")
-        debug("Parsed file successfully, but with warnings: `%s`", 2, file.path)
+        debug("Parsed file successfully, but with warnings: %o", 2, file.path)
       else
-        debug("Parsed file successfully: `%s`", 2, file.path)
+        debug("Parsed file successfully: %o", 2, file.path)
 
       if(!parseResult.result) {
-        const mess = format("No content found in `%s`. No file written.", file.path)
+        const mess = format("No content found in %o. No file written.", file.path)
         return {status: "warning", file, warning: mess}
       }
 
@@ -115,7 +115,7 @@ export default class Conveyor {
       if(printResult.status === "error")
         return printResult
 
-      debug("Printed file successfully: `%s`", 2, file.path)
+      debug("Printed file successfully: %o", 2, file.path)
 
       // Step 4: Write output
       const {status: printStatus, destFile, destContent} = printResult
@@ -129,7 +129,7 @@ export default class Conveyor {
           if(isNullish(destFile) || isNullish(destContent))
             return {
               status: "warning",
-              warning: format("No content or destination file for %s", file.path)
+              warning: format("No content or destination file for %o", file.path)
             }
 
           break
@@ -137,14 +137,21 @@ export default class Conveyor {
           throw new Error(`Invalid status received from printing ${file.module}`)
       }
 
-      const writeResult = await this.#writeOutput(destFile, destContent)
+      if(this.output) {
+        const writeResult = await this.#writeOutput(destFile, destContent)
 
-      if(writeResult.status === "success")
-        debug("Wrote output for: `%s` (%d bytes)", 2, file.path, destContent.length)
-      else
-        debug("Error writing output for: `%s`", 2, file.path)
+        if(writeResult.status === "success")
+          debug("Wrote output %o (%o bytes)", 2, writeResult.file.path, destContent.length)
+        else
+          debug("Error writing output for: `%s`", 2, file.path)
+
+        return writeResult
+      }
+
+      debug("Output not specified. Writing skipped.", 2)
+
+      return {status: "success"}
 
-      return writeResult
     } catch(error) {
       return {status: "error", file, error}
     }
@@ -158,8 +165,12 @@ export default class Conveyor {
    * @returns {Promise<object>} - Resolves when the file is written.
    */
   async #writeOutput(destFile, destContent) {
+    const debug = this.logger.newDebug()
+
     const destFileMap = composeFilename(this.output.path, destFile)
 
+    debug("Writing output to %o => %o", 2, destFile, destFileMap.absolutePath)
+
     try {
       writeFile(destFileMap, destContent)
 

package/src/core/Discovery.js

@@ -40,7 +40,7 @@ export default class Discovery {
     const options = this.core.options ?? {}
 
     if(options?.mockPath) {
-      debug("Discovering mock actions in `%s`", 1, options.mockPath)
+      debug("Discovering mock actions in `%s`", 2, options.mockPath)
 
       bucket.push(
         ...(await getFiles([
@@ -49,7 +49,7 @@ export default class Discovery {
         ])),
       )
     } else {
-      debug("Mock path not set, discovering actions in node_modules", 1)
+      debug("Mock path not set, discovering actions in node_modules", 2)
 
       debug("Looking for actions in project's package.json", 2)
       if(this.core.packageJson?.modules) {