@antora/assembler 1.0.0-alpha.9 → 1.0.0-beta.10

package/lib/produce-aggregate-documents.js

@@ -1,145 +0,0 @@
-'use strict'
-
-const File = require('vinyl')
-const filterComponentVersions = require('./filter-component-versions')
-const produceAggregateDocument = require('./produce-aggregate-document')
-const selectMutableAttributes = require('./select-mutable-attributes')
-
-const IMAGE_MACRO_RX = /^image::?(.+?)\[(.*?)\]$/
-
-function produceAggregateDocuments (loadAsciiDoc, contentCatalog, assemblerConfig) {
-  const { insertStartPage, rootLevel, sectionMergeStrategy, asciidoc: assemblerAsciiDocConfig } = assemblerConfig
-  const assemblerAsciiDocAttributes = Object.assign({}, assemblerAsciiDocConfig.attributes)
-  const { doctype, revdate, 'source-highlighter': sourceHighlighter } = assemblerAsciiDocAttributes
-  delete assemblerAsciiDocAttributes.doctype
-  delete assemblerAsciiDocAttributes.revdate
-  delete assemblerAsciiDocAttributes['source-highlighter']
-  return filterComponentVersions(contentCatalog.getComponents(), assemblerConfig.componentVersions).reduce(
-    (accum, componentVersion) => {
-      const { name: componentName, version, title, navigation } = componentVersion
-      if (!navigation) return accum
-      const componentVersionAsciiDocConfig = getAsciiDocConfigWithAsciidoctorReducerExtension(componentVersion)
-      const mergedAsciiDocConfig = Object.assign({}, componentVersionAsciiDocConfig, {
-        attributes: Object.assign({ revdate }, componentVersionAsciiDocConfig.attributes, assemblerAsciiDocAttributes),
-      })
-      const mergedAsciiDocAttributes = mergedAsciiDocConfig.attributes
-      Object.entries(mergedAsciiDocAttributes).forEach(([name, val]) => {
-        const match = name.endsWith('-image') && val.startsWith('image:') && IMAGE_MACRO_RX.exec(val)
-        if (!(match && isResourceRef(match[1]))) return
-        // Q should we allow image to be resolved relative to component version?
-        const image = contentCatalog.resolveResource(match[1], undefined, 'image', ['image'])
-        if (!image?.out) return
-        mergedAsciiDocAttributes[name] = `image:${image.out.path}[${match[2]}]`
-        image.out.assembled = true
-      })
-      const rootEntry = { content: title }
-      let startPage = contentCatalog.getComponentVersionStartPage(componentName, version)
-      if (startPage && startPage.src.component === componentName && startPage.src.version === version) {
-        if (insertStartPage && !includedInNav(navigation, startPage.pub.url)) {
-          Object.assign(rootEntry, { url: startPage.pub.url, urlType: 'internal' })
-        }
-      } else {
-        // Q: should we always use a reference page as startPage for computing mutableAttributes?
-        startPage = createFile({
-          component: componentVersion.name,
-          version: componentVersion.version,
-          relative: '.reference-page.adoc',
-          origin: (componentVersion.origins || [])[0],
-        })
-      }
-      const mutableAttributes = selectMutableAttributes(loadAsciiDoc, contentCatalog, startPage, mergedAsciiDocConfig)
-      delete mutableAttributes.doctype
-      accum = accum.concat(
-        prepareOutlines(navigation, rootEntry, rootLevel).map((outline) =>
-          produceAggregateDocument(
-            loadAsciiDoc,
-            contentCatalog,
-            componentVersion,
-            outline,
-            doctype,
-            contentCatalog.getPages((page) => page.out),
-            mergedAsciiDocConfig,
-            mutableAttributes,
-            sectionMergeStrategy
-          )
-        )
-      )
-      mergedAsciiDocAttributes.doctype = doctype
-      sourceHighlighter
-        ? (mergedAsciiDocAttributes['source-highlighter'] = sourceHighlighter)
-        : delete mergedAsciiDocAttributes['source-highlighter']
-      return accum
-    },
-    []
-  )
-}
-
-function createFile (src) {
-  const familySegment = (src.family ??= 'page') + 's'
-  const path = `modules/${(src.module ??= 'ROOT')}/${familySegment}/${src.relative}`
-  const moduleRootPath = Array(src.relative.split('/').length - 1)
-    .fill('..')
-    .join('/')
-  const outPath = [
-    src.component === 'ROOT' ? '' : src.component,
-    src.version,
-    src.module === 'ROOT' ? '' : src.module,
-    src.family === 'page' ? '' : '_' + familySegment,
-    src.family === 'page' ? src.relative.replace(/\.adoc$/, '.html') : src.relative,
-  ]
-    .filter((it) => it)
-    .join('/')
-  return new File({
-    path,
-    contents: src.contents ?? Buffer.alloc(0),
-    src,
-    out: { path: outPath },
-    pub: { url: '/' + outPath, moduleRootPath },
-  })
-}
-
-function getAsciiDocConfigWithAsciidoctorReducerExtension (componentVersion) {
-  const asciidoctorReducerExtension = require('./asciidoctor/reducer-extension') // NOTE: must be required lazily
-  const asciidocConfig = componentVersion.asciidoc
-  const extensions = asciidocConfig.extensions || []
-  if (extensions.length) {
-    return Object.assign({}, asciidocConfig, {
-      extensions: extensions.reduce(
-        (accum, candidate) => {
-          if (candidate !== asciidoctorReducerExtension) accum.push(candidate)
-          return accum
-        },
-        [asciidoctorReducerExtension]
-      ),
-      sourcemap: true,
-    })
-  }
-  return Object.assign({}, asciidocConfig, { extensions: [asciidoctorReducerExtension], sourcemap: true })
-}
-
-function includedInNav (items, url) {
-  return items.find((it) => it.url === url || includedInNav(it.items || [], url))
-}
-
-function isResourceRef (target) {
-  return ~target.indexOf(':') && !(~target.indexOf('://') || (target.startsWith('data:') && ~target.indexOf(',')))
-}
-
-// when root level is 0, merge the navigation into the rootEntry
-// when root level is 1, create navigation per navigation menu
-// in this case, if there's only a single navigation menu with no title, promote each top-level item to a menu
-function prepareOutlines (navigation, rootEntry, rootLevel) {
-  if (rootLevel === 0 || navigation.length === 1) {
-    let navBranch
-    if (navigation.length === 1) {
-      navBranch = navigation[0]
-    } else {
-      const items = navigation.reduce((accum, it) => accum.concat(it.content ? it : it.items), [])
-      navBranch = items.length ? { items } : {}
-    }
-    return rootLevel === 0 || navBranch.content ? [Object.assign(rootEntry, navBranch)] : navBranch.items
-  }
-  return navigation.reduce((navTree, it) => navTree.concat(it.content ? it : it.items), [rootEntry])
-}
-
-module.exports = produceAggregateDocuments

package/lib/util/run-command.js

@@ -1,60 +0,0 @@
-'use strict'
-
-const fs = require('node:fs')
-const LazyReadable = require('./lazy-readable')
-const { spawn } = require('node:child_process')
-
-const IS_WIN = process.platform === 'win32'
-const DBL_QUOTE_RX = /"/g
-
-const shellEscape = IS_WIN
-  ? (val) => {
-      if (val.charAt() === '-') {
-        return val
-      } else if (~val.indexOf('"')) {
-        return ~val.indexOf(' ') ? `"${val.replace(DBL_QUOTE_RX, '"""')}"` : val.replace(DBL_QUOTE_RX, '""')
-      } else if (~val.indexOf(' ')) {
-        return `"${val}"`
-      }
-      return val
-    }
-  : (val) => val
-
-async function runCommand (cmd, argv = [], opts = {}) {
-  if (!cmd) throw new TypeError('Command not specified')
-  const cmdv = cmd.split(' ').map(shellEscape)
-  const { input, output, implicitStdin, ...spawnOpts } = opts
-  if (input) input instanceof Buffer ? implicitStdin || argv.push('-') : argv.push(input)
-  if (IS_WIN) Object.assign(spawnOpts, { shell: true, windowsHide: true })
-  return new Promise((resolve, reject) => {
-    const stdout = []
-    const stderr = []
-    const ps = spawn(cmdv[0], [...cmdv.slice(1), ...argv.map(shellEscape)], spawnOpts)
-    ps.on('close', (code) => {
-      if (code === 0) {
-        if (stderr.length) process.stderr.write(stderr.join(''))
-        resolve(output ? new LazyReadable(() => fs.createReadStream(output)) : Buffer.from(stdout.join('')))
-      } else {
-        let msg = `Command failed: ${ps.spawnargs.join(' ')}`
-        if (stderr.length) msg += '\n' + stderr.join('')
-        reject(new Error(msg))
-      }
-    })
-    ps.on('error', (err) => reject(err.code === 'ENOENT' ? new Error(`Command not found: ${cmdv.join(' ')}`) : err))
-    ps.stdout.on('data', (data) => (output ? process.stdout.write(data) : stdout.push(data)))
-    ps.stderr.on('data', (data) => stderr.push(data))
-    if (input instanceof Buffer) {
-      try {
-        ps.stdin.on('error', () => undefined)
-        ps.stdin.end(input)
-      } catch (err) {
-        if (!ps.stdin.writableEnded) ps.stdin.end()
-        reject(err)
-      }
-    } else {
-      ps.stdin.end()
-    }
-  })
-}
-
-module.exports = runCommand