@antora/assembler 1.0.0-alpha.1 → 1.0.0-alpha.10

package/lib/assemble-content.js

@@ -3,8 +3,9 @@
 const loadConfig = require('./load-config')
 const produceAggregateDocuments = require('./produce-aggregate-documents')
 const PromiseQueue = require('./util/promise-queue')
+const runCommand = require('@antora/run-command-helper')
 
-async function assembleContent (playbook, contentCatalog, converter, { siteCatalog, configSource }) {
+async function assembleContent (playbook, contentCatalog, convertDocument, { siteCatalog, configSource }) {
   // Q: could we get ContentCatalog#getComponentVersionStartPage() in Antora core?
   if (typeof contentCatalog.getComponentVersionStartPage !== 'function') {
     contentCatalog.getComponentVersionStartPage = function (component, version) {
@@ -16,14 +17,14 @@ async function assembleContent (playbook, contentCatalog, converter, { siteCatal
   const generatorFunctions = this ? this.getFunctions() : {}
   const { loadAsciiDoc = require('@antora/asciidoc-loader') } = generatorFunctions
   const aggregateDocuments = produceAggregateDocuments(loadAsciiDoc, contentCatalog, assemblerConfig)
-  if (!converter) return aggregateDocuments
+  if (!convertDocument) return aggregateDocuments
   const { publishSite: publishFiles = require('@antora/site-publisher') } = generatorFunctions
   const buildConfig = assemblerConfig.build
   await prepareWorkspace(publishFiles, aggregateDocuments, contentCatalog, buildConfig)
-  // TODO: pass more information to converter so it doesn't have to compute internal stuff
+  // TODO: pass more information to convertDocument so it doesn't have to compute internal stuff
   // Q: don't we need to pass in the combined/resolved AsciiDoc attributes per file or component version?
   return new PromiseQueue({ concurrency: buildConfig.processLimit })
-    .add(aggregateDocuments.map((doc) => () => converter.call(this, doc, buildConfig)))
+    .add(aggregateDocuments.map((doc) => () => convertDocument.call(this, doc, buildConfig, runCommand)))
     .toPromise()
     .then((files) => {
       if (buildConfig.publish && siteCatalog) siteCatalog.addFiles(files)
@@ -31,7 +32,7 @@ async function assembleContent (playbook, contentCatalog, converter, { siteCatal
     })
 }
 
-// TODO: if no workspace dir is defined; we shouldn't continue
+// TODO: if no workspace dir is defined, we shouldn't continue
 function prepareWorkspace (publishFiles, aggregateDocuments, contentCatalog, buildConfig) {
   const { dir, clean, keepAggregateSource } = buildConfig
   const files = contentCatalog.findBy({ family: 'image' }).filter(({ out }) => out?.assembled)

package/lib/filter-component-versions.js

@@ -21,11 +21,11 @@ function compilePatterns (patterns) {
   if (patterns[0].charAt() === '!') patterns = ['**', ...patterns]
   return patterns.map((pattern) => {
     const negated = pattern.charAt() === '!'
-    if (negated) pattern = pattern.substr(1)
+    if (negated) pattern = pattern.slice(1)
     let version
     const separatorIdx = pattern.search(VERSION_SEPARATOR_RX)
     if (~separatorIdx) {
-      pattern = (version = true) && `${pattern.substr(0, separatorIdx)}%${pattern.substr(separatorIdx + 1) || '*'}`
+      pattern = (version = true) && `${pattern.slice(0, separatorIdx)}%${pattern.slice(separatorIdx + 1) || '*'}`
     }
     return Object.assign(makePicomatchRx(pattern, PICOMATCH_OPTS), {
       globstar: pattern === '**',

package/lib/index.js

@@ -1,6 +1,5 @@
 'use strict'
 
 const assembleContent = require('./assemble-content')
-const runCommand = require('./util/run-command')
 
-module.exports = { assembleContent, runCommand }
+module.exports = { assembleContent }

package/lib/load-config.js

@@ -1,39 +1,37 @@
 'use strict'
 
-const camelCaseKeys = require('camelcase-keys')
 const expandPath = require('@antora/expand-path-helper')
-const { promises: fsp } = require('fs')
-const os = require('os')
+const fsp = require('node:fs/promises')
+const os = require('node:os')
 const yaml = require('js-yaml')
 
-const CAMEL_CASE_KEYS_OPTS = { deep: true, stopPaths: ['asciidoc'] }
-
 function loadConfig (playbook, configSource = './antora-assembler.yml') {
   return (
     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) => camelCaseKeys(yaml.load(data), CAMEL_CASE_KEYS_OPTS))
-            : {}
-        )
+          .access((configSource = expandPath(configSource, { dot: playbook.dir })))
+          .then(
+            () => true,
+            () => false
+          )
+          .then((exists) =>
+            exists ? fsp.readFile(configSource).then((data) => camelCaseKeys(yaml.load(data), ['asciidoc'])) : {}
+          )
   ).then((config) => {
     if (config.enabled === false) return undefined
     let asciidocAttrs
     if (!config.asciidoc) {
-      config.asciidoc = { attributes: (asciidocAttrs = { doctype: 'book' }) }
+      config.asciidoc = { attributes: (asciidocAttrs = {}) }
     } else if (!(asciidocAttrs = config.asciidoc.attributes)) {
-      config.asciidoc.attributes = asciidocAttrs = { doctype: 'book' }
+      config.asciidoc.attributes = asciidocAttrs = {}
     }
-    Object.assign(asciidocAttrs, { revdate: new Date().toISOString().split('T')[0], 'page-partial': null })
+    if (!('doctype' in asciidocAttrs)) asciidocAttrs.doctype = 'book'
+    if (!('revdate' in asciidocAttrs)) asciidocAttrs.revdate = getLocalDate()
+    asciidocAttrs['page-partial'] = null
+    asciidocAttrs['loader-assembler'] = ''
     if (config.componentVersions == null) {
-      config.componentVersions = ['**']
+      config.componentVersions = ['*']
     } else if (typeof config.componentVersions === 'string') {
       config.componentVersions = config.componentVersions.split(', ')
     }
@@ -44,12 +42,10 @@ function loadConfig (playbook, configSource = './antora-assembler.yml') {
     }
     const build = config.build || (config.build = {})
     if (build.dir === '$' + '{playbook.output.dir}') {
-      //build.dir = playbook.output.dir
       throw new Error('Not implemented')
-    } else {
-      build.dir = expandPath(build.dir || './build/assembler', { dot: playbook.dir })
     }
-    build.cwd = playbook.dir // use playbook.dir the purpose of finding and loading require scripts
+    build.dir = expandPath(build.dir || './build/assembler', { dot: playbook.dir })
+    build.cwd = playbook.dir // use playbook.dir for the purpose of finding and loading require scripts
     if (!('clean' in build) && 'output' in playbook) build.clean = playbook.output.clean
     if (!('publish' in build)) build.publish = true
     if (!build.processLimit) {
@@ -59,4 +55,20 @@ function loadConfig (playbook, configSource = './antora-assembler.yml') {
   })
 }
 
+function camelCaseKeys (o, stopPaths = [], p = undefined) {
+  if (Array.isArray(o)) return o.map((it) => camelCaseKeys(it, stopPaths, p))
+  if (o == null || o.constructor !== Object) return o
+  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())
+    accum[camelKey] = ~stopPaths.indexOf(pathPrefix + camelKey) ? v : camelCaseKeys(v, stopPaths, pathPrefix + camelKey)
+  }
+  return accum
+}
+
+function getLocalDate (now = new Date()) {
+  return new Date(now - now.getTimezoneOffset() * 60000).toISOString().split('T')[0]
+}
+
 module.exports = loadConfig