@antora/assembler 1.0.0-beta.9 → 1.0.0-rc.2

package/lib/load-config.js

@@ -3,43 +3,47 @@
 const expandPath = require('@antora/expand-path-helper')
 const fsp = require('node:fs/promises')
 const os = require('node:os')
+const ospath = require('node:path')
 const yaml = require('js-yaml')
 
-const ASSEMBLY_KEYS = [
-  'rootLevel',
-  'insertStartPage',
-  'sectionMergeStrategy',
-  'linkReferenceStyle',
-  'dropExplicitXrefText',
-]
+const { LEGACY_ASSEMBLY_KEYS } = require('./constants')
+const CAMEL_CASE_STOP_PATHS = ['asciidoc.attributes', 'assembly.attributes']
+const PACKAGE_NAME = require('../package.json').name
 
-function loadConfig (playbook, configSource = './antora-assembler.yml') {
+function loadConfig (playbook, configSource, preferredQualifier = '') {
+  let resolvedConfigSource
   return (
-    configSource.constructor === Object
+    configSource?.constructor === Object
       ? Promise.resolve(configSource)
-      : fsp
-          .access((configSource = expandPath(configSource, { dot: playbook.dir })))
-          .then(
-            () => true,
-            () => false
-          )
-          .then((exists) =>
-            exists
-              ? fsp
-                  .readFile(configSource)
-                  .then((data) => Object.assign(camelCaseKeys(yaml.load(data), ['asciidoc']), { file: configSource }))
-              : {}
-          )
+      : fileExists(
+          (resolvedConfigSource = expandPath(configSource ?? `./antora-assembler${preferredQualifier}.yml`, {
+            dot: playbook.dir,
+          }))
+        )
+          .then((exists) => {
+            if (exists || configSource || !preferredQualifier) return exists
+            return fileExists(
+              (resolvedConfigSource =
+                resolvedConfigSource.substring(0, resolvedConfigSource.length - 4 - preferredQualifier.length) + '.yml')
+            )
+          })
+          .then((exists) => {
+            if (!exists) {
+              let logger
+              if (configSource && (logger = this?.getLogger?.(PACKAGE_NAME))) {
+                const ctx = { file: { path: configSource } }
+                logger.warn(ctx, 'Could not resolve config file; reverting to default settings')
+              }
+              return {}
+            }
+            return fsp
+              .readFile(resolvedConfigSource)
+              .then((data) =>
+                Object.assign(camelCaseKeys(yaml.load(data), CAMEL_CASE_STOP_PATHS), { file: resolvedConfigSource })
+              )
+          })
   ).then((config) => {
-    if (config.enabled === false) return undefined
-    let asciidocAttrs
-    if (!config.asciidoc) {
-      config.asciidoc = { attributes: (asciidocAttrs = {}) }
-    } else if (!(asciidocAttrs = config.asciidoc.attributes)) {
-      config.asciidoc.attributes = asciidocAttrs = {}
-    }
-    if (!('revdate' in asciidocAttrs)) asciidocAttrs.revdate = getLocalDate()
-    asciidocAttrs['page-partial'] = null
+    if (config.enabled === false) return config
     const remapComponentVersionsKey = !('componentVersionFilter' in config)
     const componentVersionFilter = (config.componentVersionFilter ??= {})
     if (remapComponentVersionsKey && 'componentVersions' in config) {
@@ -54,14 +58,30 @@ function loadConfig (playbook, configSource = './antora-assembler.yml') {
     const remapAssemblyKeys = !('assembly' in config)
     const assembly = (config.assembly ??= {})
     if (remapAssemblyKeys) {
-      for (const key of ASSEMBLY_KEYS) {
+      for (const key of LEGACY_ASSEMBLY_KEYS) {
         if (!(key in config)) continue
         assembly[key] = config[key]
         delete config[key]
       }
     }
-    if (!('doctype' in assembly)) assembly.doctype = 'doctype' in asciidocAttrs ? asciidocAttrs.doctype : 'book'
-    delete asciidocAttrs.doctype
+    let assemblyAttrs
+    if ('attributes' in assembly) {
+      assemblyAttrs = assembly.attributes ??= {}
+      if ('asciidoc' in config) delete config.asciidoc
+    } else if ('asciidoc' in config) {
+      assemblyAttrs = assembly.attributes = config.asciidoc?.attributes ?? {}
+      delete config.asciidoc
+    } else {
+      assemblyAttrs = assembly.attributes = {}
+    }
+    assemblyAttrs['page-partial'] = null
+    config.asciidoc = Object.defineProperty({}, 'attributes', {
+      get: function () {
+        return this.assembly.attributes
+      }.bind(config),
+    })
+    if (!('doctype' in assembly)) assembly.doctype = 'doctype' in assemblyAttrs ? assemblyAttrs.doctype : 'book'
+    delete assemblyAttrs.doctype
     if (!('rootLevel' in assembly)) assembly.rootLevel = 0
     if (!('insertStartPage' in assembly)) assembly.insertStartPage = true
     if (['discrete', 'fuse', 'enclose'].indexOf(assembly.sectionMergeStrategy) < 0) {
@@ -73,12 +93,25 @@ function loadConfig (playbook, configSource = './antora-assembler.yml') {
     if (['always', 'if-redundant', 'never'].indexOf(assembly.dropExplicitXrefText) < 0) {
       assembly.dropExplicitXrefText = 'never'
     }
+    assembly.revdate = getLocalDate()
     const build = (config.build ??= {})
-    if (build.dir === '$' + '{playbook.output.dir}') {
-      throw new Error('Not implemented')
-    }
     build.dir &&= expandPath(build.dir, { dot: playbook.dir })
-    build.cwd = playbook.dir // use playbook.dir for finding and loading require scripts
+    // used as cwd of command (and any scripts it requires)
+    build.cwd = build.cwd == null ? playbook.dir : expandPath(build.cwd, { dot: playbook.dir })
+    const command = build.command
+    if (command) {
+      if (command.constructor !== String) {
+        build.command = String(command)
+      } else if (command.includes('$')) {
+        const vars = {
+          $NODE: process.execPath,
+          $NPM: ospath.join(process.execPath, '../npm'),
+          $NPX: ospath.join(process.execPath, '../npx'),
+          $PWD: build.cwd,
+        }
+        build.command = build.command.replace(/^\$(?:NODE|NP[MX])(?= )|\$PWD\b/g, (ref) => vars[ref])
+      }
+    }
     if (!('clean' in build) && 'output' in playbook) build.clean = playbook.output.clean
     if (!('publish' in build)) build.publish = true
     if ('keepAggregateSource' in build) {
@@ -106,12 +139,19 @@ function camelCaseKeys (o, stopPaths = [], p = undefined) {
   const pathPrefix = p ? p + '.' : ''
   const accum = {}
   for (const [k, v] of Object.entries(o)) {
-    const camelKey = k.charAt() + k.slice(1).replace(/_([a-z])/g, (_, l) => l.toUpperCase())
+    const camelKey = k.charAt() + k.substring(1).replace(/_([a-z])/g, (_, l) => l.toUpperCase())
     accum[camelKey] = ~stopPaths.indexOf(pathPrefix + camelKey) ? v : camelCaseKeys(v, stopPaths, pathPrefix + camelKey)
   }
   return accum
 }
 
+function fileExists (path) {
+  return fsp.access(path).then(
+    () => true,
+    () => false
+  )
+}
+
 function getLocalDate (now = new Date()) {
   return new Date(now - now.getTimezoneOffset() * 60000).toISOString().split('T')[0]
 }

package/lib/log-command.js

@@ -0,0 +1,20 @@
+'use strict'
+
+function logCommand (loggerName, command, extraArgsOrAttributeOptionFlag, file, convertAttributes) {
+  const logger = this?.getLogger(loggerName)
+  if (!logger?.isLevelEnabled('debug')) return
+  const { docfile, 'assembler-filetype': filetype } = convertAttributes
+  const args = (
+    Array.isArray(extraArgsOrAttributeOptionFlag)
+      ? extraArgsOrAttributeOptionFlag
+      : extraArgsOrAttributeOptionFlag
+        ? convertAttributes.toArgs(extraArgsOrAttributeOptionFlag)
+        : []
+  ).map((it) => (~it.indexOf(' ') ? `'${it}'` : it))
+  const ctx = { command: [command].concat(args).join(' '), file: { path: docfile } }
+  const msg = `Running external command to export assembly in %s to %s: %s`
+  const componentVersionStr = file.src.version ? `${file.src.version}@${file.src.component}` : file.src.component
+  logger.debug(ctx, msg, componentVersionStr, filetype, file.src.relative)
+}
+
+module.exports = logCommand