Add Set Algolia Env

Closes gh-26

Author: rwinch

README.adoc

@@ -53,6 +53,7 @@ IMPORTANT: Be sure to register this extension under the `antora.extensions` key
 This extension applies the recommended Antora Extensions.
 It applies the following extensions in the proper order:
 
+* <<Set Algolia Env>>
 * <<Partial Build>>
 * https://gitlab.com/antora/antora-atlas-extension[@antora/atlas-extension]
 * <<Latest Version>>
@@ -77,6 +78,14 @@ antora:
       root_component_name: 'security'
 ----
 
+=== Set Algolia Env
+
+*require name:* @springio/antora-extensions/set-algolia-env-extension
+
+IMPORTANT: Be sure to register this extension under the `antora.extensions` key in the playbook, not the `asciidoc.extensions` key!
+
+This extension sets the Algolia environment variables to enable search.
+
 === Collector Cache Config
 *require name:* @springio/antora-extensions/inject-collector-cache-config-extension
 

lib/index.js

@@ -3,6 +3,7 @@
 const { name: packageName } = require('#package')
 
 module.exports.register = function ({ playbook, config }) {
+  this.require(`${packageName}/set-algolia-env-extension`).register.call(this, { playbook, config })
   this.require(`${packageName}/partial-build-extension`).register.call(this, { playbook, config })
   this.require('@antora/atlas-extension').register.call(this, { config })
   this.require(`${packageName}/latest-version-extension`).register.call(this, { config })

lib/set-algolia-env-extension.js

@@ -0,0 +1,7 @@
+'use strict'
+
+module.exports.register = function () {
+  process.env.ALGOLIA_API_KEY = '9d489079e5ec46dbb238909fee5c9c29'
+  process.env.ALGOLIA_APP_ID = 'WB1FQYI187'
+  process.env.ALGOLIA_INDEX_NAME = 'springdocs'
+}

package.json

@@ -38,6 +38,7 @@
     "./tabs-migration-extension": "./lib/tabs-migration-extension.js",
     "./static-page-extension": "./lib/static-page-extension.js",
     "./cache-scandir": "./lib/cache-scandir/index.js",
+    "./set-algolia-env-extension": "./lib/set-algolia-env-extension.js",
     "./static-pages/search": "./lib/static/search.adoc",
     "./static-pages/spring-projects": "./lib/static/spring-projects.adoc",
     "./asciinema-extension": "./lib/asciinema-extension.js"

test/extensions-test.js

@@ -35,6 +35,7 @@ describe('extensions', () => {
     it('should be able to call register function exported by extension', () => {
       ext.register.call(generatorContext, {})
       expect(generatorContext.required).eql([
+        `${packageName}/set-algolia-env-extension`,
         `${packageName}/partial-build-extension`,
         '@antora/atlas-extension',
         `${packageName}/latest-version-extension`,

test/set-algolia-env-extension-test.js

@@ -0,0 +1,23 @@
+/* eslint-env mocha */
+'use strict'
+
+const { expect } = require('./harness')
+const { name: packageName } = require('#package')
+
+describe('extensions', () => {
+  const ext = require(packageName + '/set-algolia-env-extension')
+
+  describe('bootstrap', () => {
+    it('should be able to require extension', () => {
+      expect(ext).to.be.instanceOf(Object)
+      expect(ext.register).to.be.instanceOf(Function)
+    })
+
+    it('should be able to call register function exported by extension', () => {
+      ext.register.call()
+      expect(process.env.ALGOLIA_API_KEY).to.eql('9d489079e5ec46dbb238909fee5c9c29')
+      expect(process.env.ALGOLIA_APP_ID).to.eql('WB1FQYI187')
+      expect(process.env.ALGOLIA_INDEX_NAME).to.eql('springdocs')
+    })
+  })
+})