adapt-authoring-docs 1.4.0 → 1.4.2

package/bin/docgen.js

@@ -77,7 +77,7 @@ async function copyRootFiles () {
 async function docs () {
   const dependencies = await loadDependencies(rootDir)
   const pkg = { ...await readJson(path.join(rootDir, 'package.json')), ...await readJson(path.join(rootDir, 'adapt-authoring.json')) }
-  const config = await loadConfigDefaults(dependencies)
+  const config = await loadConfigDefaults(rootDir, dependencies)
   const schemas = await loadSchemas(dependencies)
   const errors = await loadErrors(dependencies)
   const routerTree = await buildRouterTree(dependencies)
@@ -105,7 +105,7 @@ async function docs () {
 
   try {
     await fs.rm(outputdir, { recursive: true, force: true })
-    await fs.mkdir(outputdir)
+    await fs.mkdir(outputdir, { recursive: true })
     await copyRootFiles()
     await jsdoc3(appData, cachedConfigs, outputdir, defaultPages)
     await docsify(appData, cachedConfigs, outputdir, defaultPages)

package/lib/docsData.js

@@ -1,6 +1,5 @@
 import { loadDependencyFiles, readJson } from 'adapt-authoring-core'
 import { glob } from 'glob'
-import os from 'os'
 import path from 'path'
 import { pathToRegexp } from 'path-to-regexp'
 
@@ -35,11 +34,13 @@ export async function loadDependencies (rootDir) {
 
 /**
  * Reads conf/config.schema.json from each dependency, extracts default values,
- * and returns a { get(key) } object. Resolves $TEMP to os.tmpdir().
+ * and returns a { get(key) } object. Resolves $ROOT, $DATA and $TEMP to match
+ * the real app config (see JsonSchemaModule's isDirectory keyword).
+ * @param {string} rootDir Absolute path to the app root
  * @param {Object} dependencies Dependencies map from loadDependencies
  * @returns {Promise<Object>}
  */
-export async function loadConfigDefaults (dependencies) {
+export async function loadConfigDefaults (rootDir, dependencies) {
   const allConfigs = await loadDependencyFiles('conf/config.schema.json', {
     parse: true,
     dependencies
@@ -53,6 +54,16 @@ export async function loadConfigDefaults (dependencies) {
     }
     if (Object.keys(modDefaults).length) defaults[depName] = modDefaults
   }
+  const coreDefaults = defaults['adapt-authoring-core'] || {}
+  const resolveVar = (value, varName, replacement) => {
+    return value.startsWith(varName) ? path.resolve(replacement, value.slice(varName.length + 1)) : value
+  }
+  const dataDir = typeof coreDefaults.dataDir === 'string'
+    ? resolveVar(coreDefaults.dataDir, '$ROOT', rootDir)
+    : path.join(rootDir, 'APP_DATA', 'data')
+  const tempDir = typeof coreDefaults.tempDir === 'string'
+    ? resolveVar(coreDefaults.tempDir, '$ROOT', rootDir)
+    : path.join(rootDir, 'APP_DATA', 'temp')
   return {
     get: (key) => {
       const dotIdx = key.indexOf('.')
@@ -60,8 +71,9 @@ export async function loadConfigDefaults (dependencies) {
       const modName = key.slice(0, dotIdx)
       const propKey = key.slice(dotIdx + 1)
       const val = defaults[modName]?.[propKey]
-      if (typeof val === 'string') return val.replace('$TEMP', os.tmpdir())
-      return val
+      if (typeof val !== 'string') return val
+      return [['$ROOT', rootDir], ['$DATA', dataDir], ['$TEMP', tempDir]]
+        .reduce((v, [k, r]) => resolveVar(v, k, r), val)
     }
   }
 }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "adapt-authoring-docs",
-  "version": "1.4.0",
+  "version": "1.4.2",
   "description": "Tools for auto-generating documentation for the Adapt authoring tool",
   "homepage": "https://github.com/adapt-security/adapt-authoring-docs",
   "license": "GPL-3.0",

package/tests/docsData.spec.js

@@ -1,7 +1,7 @@
 import assert from 'node:assert/strict'
 import { describe, it, before, after } from 'node:test'
 import fs from 'fs/promises'
-import os from 'os'
+import os from 'node:os'
 import path from 'path'
 
 /* eslint-disable no-template-curly-in-string */
@@ -150,6 +150,24 @@ async function createFixture () {
     }
   }))
 
+  // --- fake core module with dataDir/tempDir config ---
+  const coreDir = path.join(root, 'node_modules', 'adapt-authoring-core')
+  await fs.mkdir(path.join(coreDir, 'conf'), { recursive: true })
+  await fs.writeFile(path.join(coreDir, 'package.json'), JSON.stringify({
+    name: 'adapt-authoring-core',
+    version: '1.0.0'
+  }))
+  await fs.writeFile(path.join(coreDir, 'adapt-authoring.json'), JSON.stringify({
+    module: false
+  }))
+  await fs.writeFile(path.join(coreDir, 'conf', 'config.schema.json'), JSON.stringify({
+    type: 'object',
+    properties: {
+      dataDir: { type: 'string', isDirectory: true, default: '$ROOT/APP_DATA/data' },
+      tempDir: { type: 'string', isDirectory: true, default: '$ROOT/APP_DATA/temp' }
+    }
+  }))
+
   // --- fake docs module with config ---
   const docsDir = path.join(root, 'node_modules', 'adapt-authoring-docs')
   await fs.mkdir(path.join(docsDir, 'conf'), { recursive: true })
@@ -259,17 +277,18 @@ describe('docsData', () => {
   })
 
   describe('loadConfigDefaults', () => {
-    it('should resolve $TEMP to os.tmpdir()', async () => {
+    it('should resolve $TEMP to the app temp directory', async () => {
       const { loadConfigDefaults } = await import('../lib/docsData.js')
-      const config = await loadConfigDefaults(dependencies)
+      const config = await loadConfigDefaults(fixtureDir, dependencies)
       const outputDir = config.get('adapt-authoring-docs.outputDir')
-      assert.ok(outputDir.startsWith(os.tmpdir()), `expected ${outputDir} to start with ${os.tmpdir()}`)
+      const expectedTemp = path.join(fixtureDir, 'APP_DATA', 'temp')
+      assert.ok(outputDir.startsWith(expectedTemp), `expected ${outputDir} to start with ${expectedTemp}`)
       assert.ok(outputDir.endsWith('/docs-build'))
     })
 
     it('should return object defaults', async () => {
       const { loadConfigDefaults } = await import('../lib/docsData.js')
-      const config = await loadConfigDefaults(dependencies)
+      const config = await loadConfigDefaults(fixtureDir, dependencies)
       const sections = config.get('adapt-authoring-docs.manualSections')
       assert.ok(sections)
       assert.ok(sections['getting-started'] !== undefined)
@@ -278,15 +297,16 @@ describe('docsData', () => {
 
     it('should return undefined for unknown config keys', async () => {
       const { loadConfigDefaults } = await import('../lib/docsData.js')
-      const config = await loadConfigDefaults(dependencies)
+      const config = await loadConfigDefaults(fixtureDir, dependencies)
       assert.equal(config.get('nonexistent.key'), undefined)
     })
 
     it('should resolve $TEMP in non-docs modules', async () => {
       const { loadConfigDefaults } = await import('../lib/docsData.js')
-      const config = await loadConfigDefaults(dependencies)
+      const config = await loadConfigDefaults(fixtureDir, dependencies)
       const cacheDir = config.get('adapt-authoring-content.cacheDir')
-      assert.ok(cacheDir.startsWith(os.tmpdir()))
+      const expectedTemp = path.join(fixtureDir, 'APP_DATA', 'temp')
+      assert.ok(cacheDir.startsWith(expectedTemp))
       assert.ok(cacheDir.endsWith('/content-cache'))
     })
   })