@antora/site-generator-default 3.0.0-alpha.9 → 3.0.0-beta.4

package/README.md

@@ -1,10 +1,12 @@
 # Antora Default Site Generator
 
-This is the default site generator pipeline for Antora.
-This pipeline is invoked by the `generate` command of Antora's CLI to produce and publish static documentation sites.
+This is the site generator for Antora.
+This generator is invoked by the `generate` command of Antora's CLI to produce and publish static documentation sites.
+
+*This package is an alias for the `@antora/site-generator` package.*
 
 [Antora](https://antora.org) is a modular static site generator designed for creating documentation sites from AsciiDoc documents.
-Its site generator pipeline aggregates documents from versioned content repositories and processes them using [Asciidoctor](https://asciidoctor.org).
+Its site generator aggregates documents from versioned content repositories and processes them using [Asciidoctor](https://asciidoctor.org).
 
 ## Copyright and License
 

package/lib/index.js

@@ -1,13 +1,8 @@
 'use strict'
 
 /**
- * Default Site Generator component for Antora
- *
- * Runs an Antora pipeline using the default set of components with a focus on
- * producing and publishing a documentation site. This component represents
- * just one way the Antora components can be organized into a site generation
- * pipeline.
+ * An alias for the @antora/site-generator package.
  *
  * @namespace site-generator-default
  */
-module.exports = require('./generate-site')
+module.exports = require('@antora/site-generator')

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@antora/site-generator-default",
-  "version": "3.0.0-alpha.9",
-  "description": "The default site generator pipeline for producing and publishing static documentation sites with Antora.",
+  "version": "3.0.0-beta.4",
+  "description": "An alias for the @antora/site-generator package.",
   "license": "MPL-2.0",
   "author": "OpenDevise Inc. (https://opendevise.com)",
   "contributors": [
@@ -15,21 +15,10 @@
   },
   "main": "lib/index.js",
   "dependencies": {
-    "@antora/asciidoc-loader": "3.0.0-alpha.9",
-    "@antora/content-aggregator": "3.0.0-alpha.9",
-    "@antora/content-classifier": "3.0.0-alpha.9",
-    "@antora/document-converter": "3.0.0-alpha.9",
-    "@antora/navigation-builder": "3.0.0-alpha.9",
-    "@antora/page-composer": "3.0.0-alpha.9",
-    "@antora/playbook-builder": "3.0.0-alpha.9",
-    "@antora/redirect-producer": "3.0.0-alpha.9",
-    "@antora/site-mapper": "3.0.0-alpha.9",
-    "@antora/site-publisher": "3.0.0-alpha.9",
-    "@antora/ui-loader": "3.0.0-alpha.9",
-    "@antora/user-require-helper": "~2.0"
+    "@antora/site-generator": "3.0.0-beta.4"
   },
   "engines": {
-    "node": ">=10.17.0"
+    "node": ">=12.21.0"
   },
   "files": [
     "lib/"
@@ -43,5 +32,6 @@
     "static site",
     "web publishing"
   ],
-  "gitHead": "a504d6889819b548e8a5416a7194cbb6f9a93e93"
+  "gitHead": "8a142499e9f1a9e0631777796e06dd6c010d3a90",
+  "readmeFilename": "README.md"
 }

package/lib/generate-site.js

@@ -1,85 +0,0 @@
-'use strict'
-
-const Pipeline = require('./pipeline')
-const SiteCatalog = require('./site-catalog')
-
-const aggregateContent = require('@antora/content-aggregator')
-const buildNavigation = require('@antora/navigation-builder')
-const buildPlaybook = require('@antora/playbook-builder')
-const classifyContent = require('@antora/content-classifier')
-const convertDocuments = require('@antora/document-converter')
-const createPageComposer = require('@antora/page-composer')
-const loadUi = require('@antora/ui-loader')
-const mapSite = require('@antora/site-mapper')
-const produceRedirects = require('@antora/redirect-producer')
-const publishSite = require('@antora/site-publisher')
-const { resolveAsciiDocConfig } = require('@antora/asciidoc-loader')
-
-async function generateSite (args, env) {
-  let playbook = buildPlaybook(args, env)
-  try {
-    const pipeline = new Pipeline(playbook, module)
-    const vars = pipeline.vars
-    await pipeline.notify('playbookBuilt')
-    playbook = vars.lock('playbook')
-    vars.asciidocConfig = resolveAsciiDocConfig(playbook)
-    vars.siteCatalog = new SiteCatalog()
-    await pipeline.notify('beforeProcess')
-    const asciidocConfig = vars.lock('asciidocConfig')
-    await Promise.all([
-      aggregateContent(playbook).then((contentAggregate) =>
-        pipeline.notify('contentAggregated', Object.assign(vars, { contentAggregate })).then(() => {
-          vars.contentCatalog = classifyContent(playbook, vars.remove('contentAggregate'), asciidocConfig)
-        })
-      ),
-      loadUi(playbook).then((uiCatalog) => pipeline.notify('uiLoaded', Object.assign(vars, { uiCatalog }))),
-    ])
-    await pipeline.notify('contentClassified')
-    const contentCatalog = vars.lock('contentCatalog')
-    const uiCatalog = vars.lock('uiCatalog')
-    convertDocuments(contentCatalog, asciidocConfig)
-    await pipeline.notify('documentsConverted')
-    vars.navigationCatalog = buildNavigation(contentCatalog, asciidocConfig)
-    await pipeline.notify('navigationBuilt')
-    ;(() => {
-      const navigationCatalog = vars.remove('navigationCatalog')
-      const composePage = createPageComposer(playbook, contentCatalog, uiCatalog, playbook.env)
-      contentCatalog.getPages((page) => page.out && composePage(page, contentCatalog, navigationCatalog))
-      if (playbook.site.url) vars.siteCatalog.addFile(composePage(create404Page()))
-    })()
-    await pipeline.notify('pagesComposed')
-    vars.siteCatalog.addFiles(produceRedirects(playbook, contentCatalog))
-    await pipeline.notify('redirectsProduced')
-    if (playbook.site.url) {
-      const publishablePages = contentCatalog.getPages((page) => page.out)
-      vars.siteCatalog.addFiles(mapSite(playbook, publishablePages))
-      await pipeline.notify('siteMapped')
-    }
-    await pipeline.notify('beforePublish')
-    return publishSite(playbook, [contentCatalog, uiCatalog, vars.lock('siteCatalog')]).then((publications) => {
-      if (!playbook.runtime.quiet && process.stdout.isTTY) {
-        process.stdout.write('Site generation complete!\n')
-        publications.forEach(
-          ({ fileUri }) => fileUri && process.stdout.write(`View the site by visiting ${fileUri} in a browser.\n`)
-        )
-      }
-      return pipeline
-        .notify('sitePublished', Object.assign(vars, { publications }))
-        .then(() => vars.remove('publications'))
-    })
-  } catch (err) {
-    if (!Pipeline.isHaltSignal(err)) throw err
-  }
-}
-
-function create404Page () {
-  return {
-    title: 'Page Not Found',
-    mediaType: 'text/html',
-    src: { stem: '404' },
-    out: { path: '404.html' },
-    pub: { url: '/404.html', rootPath: '' },
-  }
-}
-
-module.exports = generateSite

package/lib/pipeline.js

@@ -1,90 +0,0 @@
-'use strict'
-
-const EventEmitter = require('events')
-const userRequire = require('@antora/user-require-helper')
-
-class HaltPipelineSignal extends Error {}
-
-class Pipeline extends EventEmitter {
-  constructor (playbook, module_) {
-    super()
-    if (!('path' in (this.module = module_))) module_.path = require('path').dirname(module_.filename)
-    _registerExtensions.bind(this)(playbook, module_, _initVars.bind(this)(playbook))
-  }
-
-  halt () {
-    throw new HaltPipelineSignal()
-  }
-
-  async notify (vars, eventName) {
-    if (this.listenerCount(eventName)) {
-      for (const listener of this.rawListeners(eventName)) {
-        const outcome = listener.call(this, Object.assign({}, vars))
-        if (outcome instanceof Promise) await outcome
-      }
-    }
-  }
-
-  require (request) {
-    return this.module.require(request)
-  }
-
-  updateVars (vars, updates) {
-    try {
-      Object.assign(vars, updates)
-    } catch (err) {
-      if (err instanceof TypeError) {
-        err.message = err.message.replace(/ assign to read.only property '(.+)' .*/, " update read-only var '$1'")
-      }
-      throw err
-    }
-  }
-
-  static isHaltSignal (err) {
-    return err instanceof HaltPipelineSignal
-  }
-}
-
-function _initVars (playbook) {
-  const vars = Object.setPrototypeOf(
-    { playbook },
-    {
-      lock (name) {
-        return Object.defineProperty(this, name, { configurable: false, writable: false })[name]
-      },
-      remove (name) {
-        const currentValue = this[name]
-        delete this[name]
-        return currentValue
-      },
-    }
-  )
-  Object.defineProperty(this, 'vars', {
-    configurable: true,
-    get: () => {
-      delete this.vars
-      return vars
-    },
-  })
-  this.updateVars = this.updateVars.bind(this, vars)
-  return vars
-}
-
-function _registerExtensions (playbook, module_, vars) {
-  const extensions = (playbook.pipeline || {}).extensions
-  if (extensions.length) {
-    const requireContext = { dot: playbook.dir, paths: [playbook.dir || '', module_.path] }
-    extensions.forEach((ext) => {
-      const { enabled = true, id, require: request, ...config } = ext.constructor === String ? { require: ext } : ext
-      if (enabled) {
-        const { register } = userRequire(request, requireContext)
-        if (typeof register === 'function') {
-          register.length === 1 ? register(this) : register(this, Object.assign({ config }, vars))
-        }
-      }
-    })
-  }
-  this.notify = this.eventNames().length ? this.notify.bind(this, vars) : async () => undefined
-}
-
-module.exports = Pipeline

package/lib/site-catalog.js

@@ -1,28 +0,0 @@
-'use strict'
-
-const $files = Symbol('files')
-
-class SiteCatalog {
-  constructor () {
-    this[$files] = []
-  }
-
-  addFile (file) {
-    this[$files].push(file)
-  }
-
-  addFiles (files) {
-    this[$files].push(...files)
-  }
-
-  getFiles () {
-    return this[$files].slice()
-  }
-}
-
-/**
- * @deprecated superceded by getFiles(); scheduled to be removed in Antora 4
- */
-SiteCatalog.prototype.getAll = SiteCatalog.prototype.getFiles
-
-module.exports = SiteCatalog