adapt-authoring-core 2.3.1 → 2.4.1

package/docs/plugins/coremodules.js

@@ -11,7 +11,7 @@ export default class CoreModules {
 
   async getWorkflowBadges (homepage) {
     if (!homepage) return []
-    const workflows = ['tests', 'standardjs']
+    const workflows = ['tests', 'standardjs', 'releases']
     const results = await Promise.all(workflows.map(async w => {
       const url = `${homepage}/actions/workflows/${w}.yml`
       const badgeUrl = `${url}/badge.svg`

package/lib/DependencyLoader.js

@@ -4,7 +4,7 @@ import fs from 'fs-extra'
 import { glob } from 'glob'
 import path from 'path'
 import Hook from './Hook.js'
-import { metadataFileName, packageFileName } from './Utils.js'
+import { metadataFileName, packageFileName, stripScope } from './Utils.js'
 /**
  * Handles the loading of Adapt authoring tool module dependencies.
  * @memberof core
@@ -126,9 +126,12 @@ class DependencyLoader {
    * @return {Promise<Object>} Resolves with configuration object
    */
   async loadModuleConfig (modDir) {
+    const pkg = await fs.readJson(path.join(modDir, packageFileName))
     return {
-      ...await fs.readJson(path.join(modDir, packageFileName)),
+      ...pkg,
       ...await fs.readJson(path.join(modDir, metadataFileName)),
+      name: stripScope(pkg.name),
+      packageName: pkg.name,
       rootDir: modDir
     }
   }
@@ -148,7 +151,7 @@ class DependencyLoader {
     if (config.module === false) {
       return
     }
-    const { default: ModClass } = await import(modName)
+    const { default: ModClass } = await import(config.packageName)
 
     if (!_.isFunction(ModClass)) {
       throw new Error('Expected class to be exported')

package/lib/Utils.js

@@ -8,4 +8,5 @@ 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 { stripScope } from './utils/stripScope.js'
 export { loadDependencyFiles } from './utils/loadDependencyFiles.js'

package/lib/utils/stripScope.js

@@ -0,0 +1,11 @@
+/**
+ * Strips the npm scope prefix from a package name (e.g. '@cgkineo/adapt-authoring-foo' becomes 'adapt-authoring-foo')
+ * @param {string} name - The package name
+ * @returns {string} The name without scope prefix
+ */
+export function stripScope (name) {
+  if (typeof name === 'string' && name.startsWith('@')) {
+    return name.replace(/^@[^/]+\//, '')
+  }
+  return name
+}

package/package.json

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

package/tests/DependencyLoader.spec.js

@@ -292,7 +292,7 @@ describe('DependencyLoader', () => {
       const loader = new DependencyLoader(mockApp)
       const config = await loader.loadModuleConfig(overrideDir)
 
-      assert.equal(config.name, 'adapt-name')
+      assert.equal(config.name, 'pkg-name')
       assert.equal(config.description, 'from adapt')
 
       await fs.remove(overrideDir)
@@ -306,6 +306,36 @@ describe('DependencyLoader', () => {
 
       assert.equal(config.rootDir, testModuleDir)
     })
+
+    it('should store original package name as packageName', async () => {
+      const mockApp = { rootDir: '/test' }
+      const loader = new DependencyLoader(mockApp)
+
+      const config = await loader.loadModuleConfig(testModuleDir)
+
+      assert.equal(config.packageName, 'test-module')
+    })
+
+    it('should preserve scoped package name in packageName while stripping scope from name', async () => {
+      const scopedDir = path.join(__dirname, 'data', 'scoped-module')
+      await fs.ensureDir(scopedDir)
+      await fs.writeJson(path.join(scopedDir, 'package.json'), {
+        name: '@cgkineo/adapt-authoring-test',
+        version: '1.0.0'
+      })
+      await fs.writeJson(path.join(scopedDir, 'adapt-authoring.json'), {
+        module: true
+      })
+
+      const mockApp = { rootDir: '/test' }
+      const loader = new DependencyLoader(mockApp)
+      const config = await loader.loadModuleConfig(scopedDir)
+
+      assert.equal(config.name, 'adapt-authoring-test')
+      assert.equal(config.packageName, '@cgkineo/adapt-authoring-test')
+
+      await fs.remove(scopedDir)
+    })
   })
 
   describe('#loadModules()', () => {

package/tests/utils-stripScope.spec.js

@@ -0,0 +1,54 @@
+import { describe, it } from 'node:test'
+import assert from 'node:assert/strict'
+
+import { stripScope } from '../lib/utils/stripScope.js'
+
+describe('stripScope()', () => {
+  it('should strip a single-word scope', () => {
+    assert.equal(stripScope('@myorg/my-package'), 'my-package')
+  })
+
+  it('should strip a hyphenated scope', () => {
+    assert.equal(stripScope('@my-org/my-package'), 'my-package')
+  })
+
+  it('should strip a scope containing a dot', () => {
+    assert.equal(stripScope('@my.org/my-package'), 'my-package')
+  })
+
+  it('should strip a scope containing an underscore', () => {
+    assert.equal(stripScope('@my_org/my-package'), 'my-package')
+  })
+
+  it('should strip a scope containing numbers', () => {
+    assert.equal(stripScope('@org123/my-package'), 'my-package')
+  })
+
+  it('should return an unscoped name unchanged', () => {
+    assert.equal(stripScope('my-package'), 'my-package')
+  })
+
+  it('should return a short name unchanged', () => {
+    assert.equal(stripScope('lodash'), 'lodash')
+  })
+
+  it('should return an empty string unchanged', () => {
+    assert.equal(stripScope(''), '')
+  })
+
+  it('should return undefined unchanged', () => {
+    assert.equal(stripScope(undefined), undefined)
+  })
+
+  it('should return null unchanged', () => {
+    assert.equal(stripScope(null), null)
+  })
+
+  it('should handle scope with nested slashes in package name', () => {
+    assert.equal(stripScope('@scope/name/extra'), 'name/extra')
+  })
+
+  it('should handle @ in the middle of a name', () => {
+    assert.equal(stripScope('name@2.0.0'), 'name@2.0.0')
+  })
+})