@gesslar/bedoc 1.7.0 → 1.9.0

package/package.json

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

package/src/core/ActionManager.js

@@ -7,10 +7,12 @@ export default class ActionManager {
   #log
   #debug
   #file
+  #variables
 
-  constructor(actionDefinition, logger) {
+  constructor({actionDefinition, logger, variables}) {
     this.#log = logger
     this.#debug = this.#log.newDebug()
+    this.#variables = variables
 
     this.#initialize(actionDefinition)
   }
@@ -65,6 +67,10 @@ export default class ActionManager {
     return this.#log
   }
 
+  get variables() {
+    return this.#variables
+  }
+
   async #setupAction() {
     const setup = this.action?.setup
 
@@ -90,7 +96,11 @@ export default class ActionManager {
       return
 
     await this.hookManager.setup.call(
-      this.hookManager.hooks, {parent: this.action, log: this.#log}
+      this.hookManager.hooks, {
+        action: this.action,
+        variables: this.#variables,
+        log: this.#log
+      }
     )
   }
 

package/src/core/Configuration.js

@@ -246,9 +246,22 @@ export default class Configuration {
       if(!configFile)
         throw new Error("No config file specified")
 
-      const config = loadJson(configFile)
-
-      allOptions.push({source: "config", options: config})
+      const configObject = loadJson(configFile)
+      const subConfigName =
+        entryOptions?.sub ||
+        packageJson?.sub ||
+        environmentVariables?.sub
+
+      // If we didn't specify a subconfiguration, let's just remove
+      // it so it doesn't pollute anything.
+      if(!subConfigName)
+        delete configObject.sub
+
+      const finalConfig = subConfigName?.value
+        ? this.#resolveSubconfigs(configObject, subConfigName.value)
+        : configObject
+
+      allOptions.push({source: "config", options: finalConfig})
     }
 
     allOptions.push({source: "entry", options: entryOptions})
@@ -256,6 +269,21 @@ export default class Configuration {
     return allOptions
   }
 
+  #resolveSubconfigs(configObject, subConfigName) {
+    const subConfig = configObject.sub?.find(sub => sub.name === subConfigName)
+
+    if(!subConfig)
+      throw new Error(`No such subconfiguration \`${subConfigName}\``)
+
+    // We don't need this anymore
+    delete subConfig.name
+
+    for(const [key,val] of Object.entries(subConfig))
+      configObject[key] = val
+
+    return configObject
+  }
+
   /**
    * Get environment variables
    *

package/src/core/ConfigurationParameters.js

@@ -120,6 +120,14 @@ const ConfigurationParameters = Object.freeze({
       mustExist: true,
     },
   },
+  sub: {
+    short: "s",
+    param: "name",
+    description: "Specify a subconfiguration",
+    type: newTypeSpec("string"),
+    required: false,
+    dependent: "config",
+  },
   debug: {
     short: "d",
     description: "Enable debug mode",

package/src/core/Core.js

@@ -91,14 +91,18 @@ export default class Core {
 
     // Adding to instance
     instance.actions = {}
+    const {variables} = validConfig
     const managers = {print: PrintManager, parse: ParseManager}
-    for(const [, value] of Object.entries(finalActions)) {
-      const {action: actionType} = value.action.meta
+    for(const [, actionDefinition] of Object.entries(finalActions)) {
+      const {action: actionType} = actionDefinition.action.meta
 
       debug("Attaching %o action to instance", 2, actionType)
-      instance.actions[actionType] = new managers[actionType](
-        value, instance.logger
-      )
+      instance.actions[actionType] =
+        new managers[actionType] ({
+          actionDefinition,
+          logger: instance.logger,
+          variables
+        })
 
       if(validConfig.hooks) {
         const hookManager = await HookManager.new({

package/src/core/Discovery.js

@@ -7,7 +7,7 @@ import * as ActionUtil from "./util/ActionUtil.js"
 import * as DataUtil from "./util/DataUtil.js"
 import {composeDirectory,directoryExists} from "./util/FDUtil.js"
 
-const {ls,resolveFilename,getFiles} = FDUtil
+const {ls,fileExists,composeFilename,getFiles} = FDUtil
 const {actionTypes, actionMetaRequirements, loadJson} = ActionUtil
 const {isType} = DataUtil
 
@@ -52,6 +52,7 @@ export default class Discovery {
       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) {
         const actions = this.core.packageJson?.modules
 
@@ -66,30 +67,46 @@ export default class Discovery {
         debug("No actions found in project's package.json", 2)
       }
 
-      debug("Looking for actions in node_modules (global and locally installed", 2)
+      debug("Looking for actions in node_modules (global and locally installed)", 2)
       const directories = [
-        "./node_modules",
+        execSync("npm root").toString().trim(),
         execSync("npm root -g").toString().trim(),
-      ]
+      ].filter(Boolean)
+
+      const nodeModulesDirs = directories
+        .map(composeDirectory)
+        .filter(directoryExists)
 
       debug("Found %o directories to search for actions", 2, directories.length)
       debug("Directories to search for actions: %o", 3, directories)
 
-      const moduleDirectories = directories
-        .map(composeDirectory)
-        .filter(directoryExists)
-      for(const moduleDirectory of moduleDirectories) {
-        const {directories: dirs} = await ls(moduleDirectory.absolutePath)
+      for(const nodeModulesDir of nodeModulesDirs) {
+        const dirsToSearch = []
+        const {directories: moduleDirs} = await ls(nodeModulesDir.absolutePath)
 
-        debug("Found %o directories in `%s`", 2,
-          dirs.length, moduleDirectory.absolutePath
-        )
+        debug("Found %o directories in %o", 2, moduleDirs.length, nodeModulesDir.absolutePath)
+
+        // Handle scoped packages (e.g., @bedoc/something)
+        const scopedDirs = moduleDirs.filter(d => d.name.startsWith("@"))
 
-        const bedocDirs = dirs.filter(d => d.name.startsWith("bedoc-"))
-        debug("Found %o bedoc directories under %s", 2, bedocDirs.length, moduleDirectory.absolutePath)
+        dirsToSearch.push(...moduleDirs)
 
-        const exports = bedocDirs.map(d => this.#getModuleExports(d))
-        debug("Found %o module exports under %s", 2, exports.length, moduleDirectory.absolutePath)
+        // If we find a scope (e.g., "@bedoc"), look inside it for bedoc modules
+        for(const scopedDir of scopedDirs) {
+          const {directories: scopedPackages} = await ls(scopedDir.absolutePath)
+
+          debug("Found %o directories under scoped package %o", 2, directories.length, scopedDir.name)
+
+          dirsToSearch.push(...scopedPackages)
+        }
+
+        debug("Found %o directories to search for actions", 2, dirsToSearch.length)
+
+        const exports = dirsToSearch
+          .filter(d => !d.name.startsWith("."))
+          .map(d => this.#getModuleExports(d))
+
+        debug("Found %o module exports under %o", 2, exports.length, nodeModulesDir.absolutePath)
 
         bucket.push(...exports.flat())
       }
@@ -108,18 +125,27 @@ export default class Discovery {
    */
   #getModuleExports(dirMap) {
     const debug = this.#debug
-    debug("Getting module exports from `%s`", 3, dirMap.absolutePath)
+    debug("Getting module exports from %o", 3, dirMap.absolutePath)
+
+    const packageJsonFile = composeFilename(dirMap, "package.json")
+    if(!fileExists(packageJsonFile))
+      return []
 
-    const packageJsonFile = resolveFilename("package.json", dirMap)
-    debug("Loading package.json from `%s`", 3, packageJsonFile.absolutePath)
+    debug("Loading package.json from %o", 3, packageJsonFile.absolutePath)
 
     const packageJson = loadJson(packageJsonFile)
-    debug("Loaded package.json from `%s`", 3, packageJsonFile.absolutePath)
+    debug("Loaded package.json from %o", 3, packageJsonFile.absolutePath)
 
     const bedocPackageJsonModules = packageJson.bedoc?.modules ?? []
-    const bedocModuleFiles = bedocPackageJsonModules.map(file =>
-      resolveFilename(file, dirMap)
-    )
+
+    debug("Discovered %o published modules", 2, bedocPackageJsonModules.length)
+    debug("Published modules %o", 3, bedocPackageJsonModules)
+
+    const bedocModuleFiles = bedocPackageJsonModules
+      .map(m => composeFilename(dirMap, m))
+      .filter(m => fileExists(m))
+
+    debug("Composed modules %o", 3, bedocModuleFiles)
 
     return bedocModuleFiles
   }
@@ -225,7 +251,7 @@ export default class Discovery {
           JSON.stringify(moduleFile, null, 2) + "\n" +
           JSON.stringify(action, null, 2))
 
-      debug("Checking action `%s`", 2, metaAction)
+      debug("Checking action %o", 2, metaAction)
 
       const isValid = this.#validMeta(metaAction, {action, contract})
 
@@ -246,7 +272,7 @@ export default class Discovery {
 
     for(const actionType of actionTypes) {
       const total = resultActions[actionType].length
-      debug("Found %o `%o` actions", 2, total, actionType)
+      debug("Found %o %o actions", 2, total, actionType)
     }
 
     const total = Object.keys(resultActions).reduce((acc, curr) => {
@@ -280,7 +306,7 @@ export default class Discovery {
 
       // First let's check if we wanted something specific
       if(validatedConfig[config]) {
-        debug("Checking for specific `%s` action", 3, actionType)
+        debug("Checking for specific %o action", 3, actionType)
         const found = actions[actionType].find(
           a => a.file.specificType.includes(actionType)
         )
@@ -294,7 +320,7 @@ export default class Discovery {
       }
 
       // Hmm! We didn't find anything specific. Let's check the criterion
-      debug("Checking for `%s` actions with criterion `%s`", 3, actionType, criterion)
+      debug("Checking for %o actions with criterion %o", 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])
@@ -341,7 +367,7 @@ export default class Discovery {
    */
   #validMeta(actionType, toValidate) {
     const debug = this.#debug
-    debug("Checking meta requirements for `%s`", 3, actionType)
+    debug("Checking meta requirements for %o", 3, actionType)
 
     const requirements = actionMetaRequirements[actionType]
     if(!requirements)