@antora/site-generator-default 3.0.0-beta.1 → 3.0.0-beta.2

package/lib/generate-site.js

@@ -4,9 +4,9 @@ const GeneratorContext = require('./generator-context')
 const SiteCatalog = require('./site-catalog')
 
 async function generateSite (playbook) {
+  const context = new GeneratorContext(module)
   try {
-    const context = new GeneratorContext(playbook, module)
-    const { fxns, vars } = context
+    const { fxns, vars } = await GeneratorContext.start(context, playbook)
     await context.notify('playbookBuilt')
     playbook = vars.lock('playbook')
     vars.asciidocConfig = fxns.resolveAsciiDocConfig(playbook)
@@ -55,7 +55,10 @@ async function generateSite (playbook) {
         .then(() => vars.remove('publications'))
     })
   } catch (err) {
-    if (!GeneratorContext.isHaltSignal(err)) throw err
+    if (!GeneratorContext.isStopSignal(err)) throw err
+    await err.notify()
+  } finally {
+    await GeneratorContext.close(context)
   }
 }
 

package/lib/generator-context.js

@@ -20,18 +20,20 @@ const FUNCTION_PROVIDERS = {
   resolveAsciiDocConfig: 'asciidoc-loader',
 }
 
-class HaltSignal extends Error {}
+const FUNCTION_WITH_POSITIONAL_PARAMETER_RX = /^(?:function *)?(?:\w+ *)?\( *\w|^\w+(?: *, *\w+)* *=>/
+const NEWLINES_RX = /\r?\n/g
+
+class StopSignal extends Error {}
 
 class GeneratorContext extends EventEmitter {
   #fxns
   #vars
 
-  constructor (playbook, module_) {
+  constructor (module_) {
     super()
+    // deprecated method aliases - remove for Antora 3.0.0
+    Object.defineProperties(this, { halt: { value: this.stop }, updateVars: { value: this.updateVariables } })
     if (!('path' in (this.module = module_))) module_.path = require('path').dirname(module_.filename)
-    this._registerFunctions(module_)
-    this._registerExtensions(playbook, this._initVariables(playbook), module_)
-    Object.defineProperties(this, { _initVariables: {}, _registerExtensions: {}, _registerFunctions: {} })
   }
 
   getFunctions () {
@@ -46,10 +48,6 @@ class GeneratorContext extends EventEmitter {
     return Object.assign({}, this.#vars)
   }
 
-  halt () {
-    throw new HaltSignal()
-  }
-
   async notify (eventName) {
     if (!this.listenerCount(eventName)) return
     for (const listener of this.rawListeners(eventName)) {
@@ -60,7 +58,7 @@ class GeneratorContext extends EventEmitter {
 
   replaceFunctions (updates) {
     const fxns = this.#fxns
-    Object.entries(updates).map(([name, fxn]) => {
+    Object.entries(updates).forEach(([name, fxn]) => {
       if (name in fxns) fxns[name] = fxn.bind(this)
     })
   }
@@ -69,6 +67,11 @@ class GeneratorContext extends EventEmitter {
     return this.module.require(request)
   }
 
+  stop (code) {
+    if (code != null) process.exitCode = code
+    throw Object.assign(new StopSignal(), { notify: this.notify.bind(this, 'contextStopped') })
+  }
+
   updateVariables (updates) {
     try {
       Object.assign(this.#vars, updates)
@@ -80,46 +83,54 @@ class GeneratorContext extends EventEmitter {
     }
   }
 
-  // TODO remove updateVars before Antora 3.0.0
-  updateVars (updates) {
-    return this.updateVariables(updates)
+  static async close (instance) {
+    await instance.notify('contextClosed').catch(() => undefined)
+  }
+
+  static isStopSignal (err) {
+    return err instanceof StopSignal
+  }
+
+  static async start (instance, playbook) {
+    const returnValue = instance._init(playbook)
+    await instance.notify('contextStarted')
+    return returnValue
   }
 
-  static isHaltSignal (err) {
-    return err instanceof HaltSignal
+  _init (playbook) {
+    this._registerFunctions()
+    this._registerExtensions(playbook, this._initVariables(playbook))
+    Object.defineProperties(this, { _init: {}, _initVariables: {}, _registerExtensions: {}, _registerFunctions: {} })
+    return { fxns: this.#fxns, vars: this.#vars }
   }
 
   _initVariables (playbook) {
-    Object.defineProperty(this, 'vars', {
-      configurable: true,
-      get: () => {
-        delete this.vars
-        return Object.setPrototypeOf(this.#vars, {
-          lock (name) {
-            return Object.defineProperty(this, name, { configurable: false, writable: false })[name]
-          },
-          remove (name) {
-            const currentValue = this[name]
-            delete this[name]
-            return currentValue
-          },
-        })
-      },
-    })
-    return (this.#vars = { playbook })
+    return (this.#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
+        },
+      }
+    ))
   }
 
-  _registerExtensions (playbook, vars, module_) {
+  _registerExtensions (playbook, vars) {
     const extensions = (playbook.antora || {}).extensions || []
     if (extensions.length) {
-      const requireContext = { dot: playbook.dir, paths: [playbook.dir || '', module_.path] }
+      const requireContext = { dot: playbook.dir, paths: [playbook.dir || '', this.module.path] }
       extensions.forEach((ext) => {
         const { enabled = true, id, require: request, ...config } = ext.constructor === String ? { require: ext } : ext
         if (!enabled) return
         const { register } = userRequire(request, requireContext)
         if (typeof register !== 'function') return
         if (register.length) {
-          if (/^(?:function *)?(?:\w+ *)?\( *\w|^\w+(?: *, *\w+)* *=>/.test(register.toString().replace(/\r?\n/g, ' '))) {
+          if (FUNCTION_WITH_POSITIONAL_PARAMETER_RX.test(register.toString().replace(NEWLINES_RX, ' '))) {
             register.length === 1 ? register(this) : register(this, Object.assign({ config }, vars))
           } else {
             register.call(this, Object.assign({ config }, vars))
@@ -129,17 +140,19 @@ class GeneratorContext extends EventEmitter {
         }
       })
     }
-    this.notify = this.eventNames().length ? this.notify.bind(this) : async () => undefined
+    if (this.eventNames().length) return
+    const notify = async () => undefined
+    Object.defineProperty(this, 'notify', { value: notify })
   }
 
-  _registerFunctions (module_) {
+  _registerFunctions () {
     this.#fxns = Object.entries(
       Object.entries(FUNCTION_PROVIDERS).reduce((accum, [fxnName, moduleKey]) => {
         accum[moduleKey] = (accum[moduleKey] || []).concat(fxnName)
         return accum
       }, {})
     ).reduce((accum, [moduleKey, fxnNames]) => {
-      const defaultExport = module_.require('@antora/' + moduleKey)
+      const defaultExport = this.require('@antora/' + moduleKey)
       const defaultExportName = defaultExport.name
       fxnNames.forEach((fxnName) => {
         const fxn = fxnName === defaultExportName ? defaultExport : defaultExport[fxnName]
@@ -147,13 +160,6 @@ class GeneratorContext extends EventEmitter {
       })
       return accum
     }, {})
-    Object.defineProperty(this, 'fxns', {
-      configurable: true,
-      get: () => {
-        delete this.fxns
-        return this.#fxns
-      },
-    })
   }
 }
 

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@antora/site-generator-default",
-  "version": "3.0.0-beta.1",
+  "version": "3.0.0-beta.2",
   "description": "The default site generator for producing and publishing static documentation sites with Antora.",
   "license": "MPL-2.0",
   "author": "OpenDevise Inc. (https://opendevise.com)",
@@ -15,21 +15,21 @@
   },
   "main": "lib/index.js",
   "dependencies": {
-    "@antora/asciidoc-loader": "3.0.0-beta.1",
-    "@antora/content-aggregator": "3.0.0-beta.1",
-    "@antora/content-classifier": "3.0.0-beta.1",
-    "@antora/document-converter": "3.0.0-beta.1",
-    "@antora/logger": "3.0.0-beta.1",
-    "@antora/navigation-builder": "3.0.0-beta.1",
-    "@antora/page-composer": "3.0.0-beta.1",
-    "@antora/redirect-producer": "3.0.0-beta.1",
-    "@antora/site-mapper": "3.0.0-beta.1",
-    "@antora/site-publisher": "3.0.0-beta.1",
-    "@antora/ui-loader": "3.0.0-beta.1",
+    "@antora/asciidoc-loader": "3.0.0-beta.2",
+    "@antora/content-aggregator": "3.0.0-beta.2",
+    "@antora/content-classifier": "3.0.0-beta.2",
+    "@antora/document-converter": "3.0.0-beta.2",
+    "@antora/logger": "3.0.0-beta.2",
+    "@antora/navigation-builder": "3.0.0-beta.2",
+    "@antora/page-composer": "3.0.0-beta.2",
+    "@antora/redirect-producer": "3.0.0-beta.2",
+    "@antora/site-mapper": "3.0.0-beta.2",
+    "@antora/site-publisher": "3.0.0-beta.2",
+    "@antora/ui-loader": "3.0.0-beta.2",
     "@antora/user-require-helper": "~2.0"
   },
   "devDependencies": {
-    "@antora/playbook-builder": "3.0.0-beta.1"
+    "@antora/playbook-builder": "3.0.0-beta.2"
   },
   "engines": {
     "node": ">=12.21.0"
@@ -46,5 +46,5 @@
     "static site",
     "web publishing"
   ],
-  "gitHead": "7c5ef1ea93dd489af533c80a936c736013c41769"
+  "gitHead": "5cd3f9cc70622e465cb44daf1aa2035ed5a35f54"
 }