adapt-authoring-core 2.1.3 → 2.2.0

package/docs/plugins/coremodules.js

@@ -10,8 +10,11 @@ export default class CoreModules {
   generateMd () {
     return Object.keys(this.app.dependencies).sort().reduce((s, name) => {
       const { version, description, homepage } = this.app.dependencies[name]
-      const badge = homepage ? `[![Tests](${homepage}/actions/workflows/tests.yml/badge.svg)](${homepage}/actions/workflows/tests.yml)` : ''
-      return `${s}\n| ${homepage ? `[${name}](${homepage})` : name} | ${version} | ${description} | ${badge} |`
-    }, '| Name | Version | Description | Tests |\n| - | :-: | - | :-: |')
+      const workflows = ['tests', 'standardjs']
+      const badges = homepage
+        ? workflows.map(w => `[![${w}](${homepage}/actions/workflows/${w}.yml/badge.svg)](${homepage}/actions/workflows/${w}.yml)`).join('<br>')
+        : ''
+      return `${s}\n| ${homepage ? `[${name}](${homepage})` : name} | ${version} | ${description} | ${badges} |`
+    }, '| Name | Version | Description | Status |\n| - | :-: | - | :-: |')
   }
 }

package/index.js

@@ -2,4 +2,4 @@ export { default as AbstractModule } from './lib/AbstractModule.js'
 export { default as App } from './lib/App.js'
 export { default as DependencyLoader } from './lib/DependencyLoader.js'
 export { default as Hook } from './lib/Hook.js'
-export { metadataFileName, packageFileName, isObject, getArgs, spawn, readJson, writeJson, toBoolean, ensureDir, escapeRegExp, stringifyValues } from './lib/Utils.js'
+export { metadataFileName, packageFileName, isObject, getArgs, spawn, readJson, writeJson, toBoolean, ensureDir, escapeRegExp, stringifyValues, loadDependencyFiles } from './lib/Utils.js'

package/lib/Utils.js

@@ -8,3 +8,4 @@ export { toBoolean } from './utils/toBoolean.js'
 export { ensureDir } from './utils/ensureDir.js'
 export { escapeRegExp } from './utils/escapeRegExp.js'
 export { stringifyValues } from './utils/stringifyValues.js'
+export { loadDependencyFiles } from './utils/loadDependencyFiles.js'

package/lib/utils/loadDependencyFiles.js

@@ -0,0 +1,25 @@
+import fs from 'fs/promises'
+import { glob } from 'glob'
+import App from '../App.js'
+
+/**
+ * Scans files matching a glob pattern across all module dependency directories.
+ * @param {string} pattern - Glob pattern to match files (e.g. 'errors/*.json')
+ * @param {Object} [options] - Options
+ * @param {boolean} [options.parse=false] - If true, reads and parses each matched file as JSON
+ * @param {Object} [options.dependencies] - Custom dependencies map (defaults to App.instance.dependencies)
+ * @returns {Promise<Object>} Map of module name to array of file paths (or parsed JSON objects if parse is true)
+ */
+export async function loadDependencyFiles (pattern, options = {}) {
+  const { parse = false, dependencies = App.instance.dependencies } = options
+  const results = {}
+  await Promise.all(Object.values(dependencies).map(async dep => {
+    const files = await glob(pattern, { cwd: dep.rootDir, absolute: true })
+    if (!files.length) return
+    results[dep.name] = await Promise.all(files.map(async f => {
+      if (parse) return JSON.parse(await fs.readFile(f, 'utf8'))
+      return f
+    }))
+  }))
+  return results
+}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "adapt-authoring-core",
-  "version": "2.1.3",
+  "version": "2.2.0",
   "description": "A bundle of reusable 'core' functionality",
   "homepage": "https://github.com/adapt-security/adapt-authoring-core",
   "license": "GPL-3.0",

package/tests/utils-loadDependencyFiles.spec.js

@@ -0,0 +1,91 @@
+import { describe, it } from 'node:test'
+import assert from 'node:assert/strict'
+import fs from 'fs/promises'
+import path from 'path'
+import os from 'os'
+
+import { loadDependencyFiles } from '../lib/utils/loadDependencyFiles.js'
+
+async function makeTempDir (suffix) {
+  return fs.mkdtemp(path.join(os.tmpdir(), `loadDepFiles-${suffix}-`))
+}
+
+describe('loadDependencyFiles()', () => {
+  it('should return file paths grouped by module name', async () => {
+    const dir = await makeTempDir('paths')
+    await fs.writeFile(path.join(dir, 'a.json'), '{"x":1}')
+    const deps = { mymod: { name: 'mymod', rootDir: dir } }
+    try {
+      const result = await loadDependencyFiles('*.json', { dependencies: deps })
+      assert.ok(result.mymod, 'should have entry for mymod')
+      assert.equal(result.mymod.length, 1)
+      assert.ok(result.mymod[0].endsWith('a.json'))
+    } finally {
+      await fs.rm(dir, { recursive: true })
+    }
+  })
+
+  it('should parse JSON when parse option is true', async () => {
+    const dir = await makeTempDir('parse')
+    await fs.writeFile(path.join(dir, 'b.json'), '{"key":"value"}')
+    const deps = { mymod: { name: 'mymod', rootDir: dir } }
+    try {
+      const result = await loadDependencyFiles('*.json', { parse: true, dependencies: deps })
+      assert.ok(result.mymod, 'should have entry for mymod')
+      assert.equal(result.mymod.length, 1)
+      assert.deepEqual(result.mymod[0], { key: 'value' })
+    } finally {
+      await fs.rm(dir, { recursive: true })
+    }
+  })
+
+  it('should return empty object when no files match', async () => {
+    const dir = await makeTempDir('nomatch')
+    const deps = { mymod: { name: 'mymod', rootDir: dir } }
+    try {
+      const result = await loadDependencyFiles('errors/*.json', { dependencies: deps })
+      assert.deepEqual(result, {})
+    } finally {
+      await fs.rm(dir, { recursive: true })
+    }
+  })
+
+  it('should group files by module name across multiple deps', async () => {
+    const dir1 = await makeTempDir('multi1')
+    const dir2 = await makeTempDir('multi2')
+    await fs.writeFile(path.join(dir1, 'x.json'), '"a"')
+    await fs.writeFile(path.join(dir2, 'y.json'), '"b"')
+    const deps = {
+      mod1: { name: 'mod1', rootDir: dir1 },
+      mod2: { name: 'mod2', rootDir: dir2 }
+    }
+    try {
+      const result = await loadDependencyFiles('*.json', { dependencies: deps })
+      assert.ok(result.mod1)
+      assert.ok(result.mod2)
+      assert.equal(result.mod1.length, 1)
+      assert.equal(result.mod2.length, 1)
+    } finally {
+      await fs.rm(dir1, { recursive: true })
+      await fs.rm(dir2, { recursive: true })
+    }
+  })
+
+  it('should not include modules with no matching files', async () => {
+    const dir1 = await makeTempDir('partial1')
+    const dir2 = await makeTempDir('partial2')
+    await fs.writeFile(path.join(dir1, 'match.json'), '{}')
+    const deps = {
+      mod1: { name: 'mod1', rootDir: dir1 },
+      mod2: { name: 'mod2', rootDir: dir2 }
+    }
+    try {
+      const result = await loadDependencyFiles('*.json', { dependencies: deps })
+      assert.ok(result.mod1)
+      assert.equal(result.mod2, undefined)
+    } finally {
+      await fs.rm(dir1, { recursive: true })
+      await fs.rm(dir2, { recursive: true })
+    }
+  })
+})