New: Add deps-check and deps-gen commands (fixes #75)

bin/deps-check.js

@@ -0,0 +1,131 @@
+import { readFileSync } from 'node:fs'
+import { join } from 'node:path'
+import SimpleCliCommand from '../lib/SimpleCliCommand.js'
+import Utils from '../lib/Utils.js'
+import { PREFIX, deriveExpectedPeerDeps, deriveExpectedDeps } from '../lib/peerDeps.js'
+
+const CORE_PKG = 'adapt-authoring-core'
+
+export default class DepsCheck extends SimpleCliCommand {
+  get config () {
+    return {
+      ...super.config,
+      description: 'Checks dependencies and peerDependencies against source code analysis',
+      params: {},
+      options: [['--recursive', 'Check all AAT modules in child directories']],
+      getReleaseData: false
+    }
+  }
+
+  async runTask () {
+    const cwd = process.cwd()
+    let moduleDirs
+
+    if (this.options.recursive) {
+      moduleDirs = Utils.getModuleDirs(cwd)
+      if (moduleDirs.length === 0) {
+        console.log('No modules found in child directories.')
+        process.exitCode = 1
+        return
+      }
+    } else {
+      if (!Utils.isModule(cwd)) {
+        console.error(`Not a valid module directory (no adapt-authoring.json found in ${cwd})`)
+        process.exitCode = 1
+        return
+      }
+      moduleDirs = [cwd]
+    }
+
+    const pkgIndex = Utils.buildPackageIndex(join(cwd, this.options.recursive ? '.' : '..'))
+    let totalErrors = 0
+
+    for (const moduleDir of moduleDirs) {
+      const errors = this.checkModule(moduleDir, pkgIndex)
+      totalErrors += errors
+    }
+
+    if (totalErrors > 0) {
+      process.exitCode = 1
+    }
+  }
+
+  checkModule (moduleDir, pkgIndex) {
+    const pkgPath = join(moduleDir, 'package.json')
+    const pkg = JSON.parse(readFileSync(pkgPath, 'utf8'))
+    const moduleName = pkg.name
+    const declaredPeerDeps = new Set(Object.keys(pkg.peerDependencies || {}))
+    const declaredDeps = new Set(Object.keys(pkg.dependencies || {}).filter(n => n.startsWith(PREFIX)))
+
+    console.log(`Checking ${moduleName}...`)
+
+    let peerResult = deriveExpectedPeerDeps(moduleDir, pkgIndex)
+
+    const directDeps = pkg.dependencies || {}
+    const isCorePkg = moduleName === CORE_PKG
+    const hasCoreAsDirect = Object.hasOwn(directDeps, CORE_PKG)
+
+    if (!isCorePkg && !hasCoreAsDirect) {
+      if (!peerResult) {
+        peerResult = { peerDeps: {} }
+      }
+      if (!peerResult.peerDeps[CORE_PKG]) {
+        const coreInfo = pkgIndex.get(CORE_PKG)
+        peerResult.peerDeps[CORE_PKG] = coreInfo ? `^${coreInfo.version}` : '*'
+      }
+    }
+
+    const expectedPeerNames = peerResult ? new Set(Object.keys(peerResult.peerDeps)) : new Set()
+    const missingPeer = [...expectedPeerNames].filter(n => !declaredPeerDeps.has(n)).sort()
+    const extraPeer = [...declaredPeerDeps].filter(n => !expectedPeerNames.has(n)).sort()
+
+    const depsResult = deriveExpectedDeps(moduleDir, pkgIndex)
+    const expectedDepNames = depsResult ? new Set(Object.keys(depsResult.expectedDeps)) : new Set()
+    const missingDeps = [...expectedDepNames].filter(n => !declaredDeps.has(n)).sort()
+    const extraDeps = [...declaredDeps].filter(n => !expectedDepNames.has(n)).sort()
+
+    const errors = missingPeer.length + extraPeer.length + missingDeps.length + extraDeps.length
+
+    if (errors === 0) {
+      console.log(`Checking ${moduleName}... ✓`)
+      return 0
+    }
+
+    console.log()
+
+    if (missingDeps.length > 0) {
+      console.log('✗ Missing dependencies (imported in code but not in dependencies):')
+      for (const name of missingDeps) {
+        console.log(`  - ${name}`)
+      }
+      console.log()
+    }
+
+    if (extraDeps.length > 0) {
+      console.log('✗ Extra dependencies (in dependencies but not imported in code):')
+      for (const name of extraDeps) {
+        console.log(`  - ${name}`)
+      }
+      console.log()
+    }
+
+    if (missingPeer.length > 0) {
+      console.log('✗ Missing peerDependencies:')
+      for (const name of missingPeer) {
+        console.log(`  - ${name}`)
+      }
+      console.log()
+    }
+
+    if (extraPeer.length > 0) {
+      console.log('✗ Extra peerDependencies (not used in code):')
+      for (const name of extraPeer) {
+        console.log(`  - ${name}`)
+      }
+      console.log()
+    }
+
+    console.log(`Found ${errors} error(s).`)
+    return errors
+  }
+}

bin/deps-gen.js

@@ -0,0 +1,201 @@
+import { readFileSync, writeFileSync, existsSync } from 'node:fs'
+import { join } from 'node:path'
+import SimpleCliCommand from '../lib/SimpleCliCommand.js'
+import Utils from '../lib/Utils.js'
+import { PREFIX, deriveExpectedPeerDeps, deriveExpectedDeps } from '../lib/peerDeps.js'
+
+const CORE_PKG = 'adapt-authoring-core'
+
+export default class DepsGen extends SimpleCliCommand {
+  get config () {
+    return {
+      ...super.config,
+      description: 'Generates correct dependencies and peerDependencies from source code analysis',
+      params: {},
+      options: [
+        ['--recursive', 'Process all AAT modules in child directories'],
+        ['--write', 'Write changes to package.json files']
+      ],
+      getReleaseData: false
+    }
+  }
+
+  async runTask () {
+    const cwd = process.cwd()
+    let moduleDirs
+
+    if (this.options.recursive) {
+      moduleDirs = Utils.getModuleDirs(cwd)
+      if (moduleDirs.length === 0) {
+        console.log('No modules found in child directories.')
+        process.exitCode = 1
+        return
+      }
+    } else {
+      if (!Utils.isModule(cwd)) {
+        console.error(`Not a valid module directory (no adapt-authoring.json found in ${cwd})`)
+        process.exitCode = 1
+        return
+      }
+      moduleDirs = [cwd]
+    }
+
+    const pkgIndex = Utils.buildPackageIndex(join(cwd, this.options.recursive ? '.' : '..'))
+    const updatedDirs = []
+    let count = 0
+
+    for (const moduleDir of moduleDirs) {
+      const result = this.processModule(moduleDir, pkgIndex)
+      if (result) {
+        count++
+        if (this.options.write) {
+          updatedDirs.push(moduleDir)
+        }
+      }
+    }
+
+    if (count === 0) {
+      console.log('No modules with adapt-authoring dependencies found.')
+    } else if (!this.options.write) {
+      console.log(`\n${count} module(s) found. Run with --write to update package.json files.`)
+    }
+
+    if (updatedDirs.length > 0) {
+      for (const dir of updatedDirs) {
+        console.log(`  Running npm update in ${dir}...`)
+        try {
+          await Utils.exec('npm update', dir)
+          console.log('  ✓ npm update complete')
+        } catch (e) {
+          console.error(`  ✗ npm update failed: ${e.message}`)
+        }
+      }
+    }
+  }
+
+  processModule (moduleDir, pkgIndex) {
+    let peerResult = deriveExpectedPeerDeps(moduleDir, pkgIndex)
+    const depsResult = deriveExpectedDeps(moduleDir, pkgIndex)
+
+    // Ensure adapt-authoring-core is a peerDependency for all modules
+    // that don't have it as a direct dependency
+    if (!peerResult) {
+      const modPkgPath = join(moduleDir, 'package.json')
+      if (existsSync(modPkgPath)) {
+        const modPkg = JSON.parse(readFileSync(modPkgPath, 'utf8'))
+        const directDeps = modPkg.dependencies || {}
+        if (modPkg.name !== CORE_PKG && !Object.hasOwn(directDeps, CORE_PKG)) {
+          peerResult = { moduleName: modPkg.name, pkgPath: modPkgPath, pkg: modPkg, peerDeps: {}, warnings: [] }
+        }
+      }
+    }
+    if (peerResult && peerResult.moduleName !== CORE_PKG) {
+      const directDeps = peerResult.pkg.dependencies || {}
+      if (!Object.hasOwn(directDeps, CORE_PKG) && !peerResult.peerDeps[CORE_PKG]) {
+        const coreInfo = pkgIndex.get(CORE_PKG)
+        peerResult.peerDeps[CORE_PKG] = coreInfo ? `^${coreInfo.version}` : '*'
+        const sorted = {}
+        for (const key of Object.keys(peerResult.peerDeps).sort()) {
+          sorted[key] = peerResult.peerDeps[key]
+        }
+        peerResult.peerDeps = sorted
+      }
+    }
+
+    if (!peerResult && !depsResult) {
+      if (!this.options.recursive) console.log(`No adapt-authoring dependencies found in ${moduleDir}`)
+      return false
+    }
+
+    const pkg = peerResult?.pkg || depsResult.pkg
+    const pkgPath = peerResult?.pkgPath || depsResult.pkgPath
+    const moduleName = peerResult?.moduleName || depsResult.moduleName
+    const peerDeps = peerResult?.peerDeps || {}
+    const expectedDeps = depsResult?.expectedDeps || {}
+    const warnings = [...(peerResult?.warnings || []), ...(depsResult?.warnings || [])]
+
+    console.log(`\n${moduleName}:`)
+
+    if (Object.keys(expectedDeps).length > 0) {
+      console.log('  dependencies:')
+      for (const [dep, ver] of Object.entries(expectedDeps)) {
+        console.log(`    ${dep}: ${ver}`)
+      }
+    }
+
+    if (Object.keys(peerDeps).length > 0) {
+      console.log('  peerDependencies:')
+      for (const [dep, ver] of Object.entries(peerDeps)) {
+        console.log(`    ${dep}: ${ver}`)
+      }
+    }
+
+    for (const w of warnings) {
+      console.log(`  ⚠ ${w}`)
+    }
+
+    if (this.options.write) {
+      this.writePackageJson(pkg, pkgPath, expectedDeps, peerDeps)
+    }
+
+    return true
+  }
+
+  writePackageJson (pkg, pkgPath, expectedDeps, peerDeps) {
+    // Update adapt-authoring-* dependencies: preserve non-adapt deps, add expected ones
+    const currentDeps = pkg.dependencies || {}
+    const updatedDeps = {}
+    for (const [dep, ver] of Object.entries(currentDeps)) {
+      if (!dep.startsWith(PREFIX)) {
+        updatedDeps[dep] = ver
+      }
+    }
+    for (const [dep, ver] of Object.entries(expectedDeps)) {
+      updatedDeps[dep] = ver
+    }
+    const sortedDeps = {}
+    for (const key of Object.keys(updatedDeps).sort()) {
+      sortedDeps[key] = updatedDeps[key]
+    }
+    pkg.dependencies = sortedDeps
+
+    pkg.peerDependencies = peerDeps
+
+    const peerDepsMeta = {}
+    for (const dep of Object.keys(peerDeps)) {
+      peerDepsMeta[dep] = { optional: true }
+    }
+    pkg.peerDependenciesMeta = peerDepsMeta
+
+    // Rebuild the package object with correct key ordering:
+    // peerDependencies and peerDependenciesMeta directly after dependencies
+    const ordered = {}
+    for (const key of Object.keys(pkg)) {
+      if (key === 'peerDependencies' || key === 'peerDependenciesMeta') continue
+      ordered[key] = pkg[key]
+      if (key === 'dependencies') {
+        ordered.peerDependencies = pkg.peerDependencies
+        ordered.peerDependenciesMeta = pkg.peerDependenciesMeta
+      }
+    }
+    // If there was no dependencies key, ensure they're added before devDependencies
+    if (!ordered.peerDependencies) {
+      const final = {}
+      for (const key of Object.keys(ordered)) {
+        if (key === 'devDependencies') {
+          final.peerDependencies = pkg.peerDependencies
+          final.peerDependenciesMeta = pkg.peerDependenciesMeta
+        }
+        final[key] = ordered[key]
+      }
+      if (!final.peerDependencies) {
+        final.peerDependencies = pkg.peerDependencies
+        final.peerDependenciesMeta = pkg.peerDependenciesMeta
+      }
+      writeFileSync(pkgPath, JSON.stringify(final, null, 2) + '\n')
+    } else {
+      writeFileSync(pkgPath, JSON.stringify(ordered, null, 2) + '\n')
+    }
+    console.log(`  ✓ written to ${pkgPath}`)
+  }
+}

lib/SimpleCliCommand.js

@@ -0,0 +1,11 @@
+import CliCommand from './CliCommand.js'
+
+export default class SimpleCliCommand extends CliCommand {
+  async run (...args) {
+    const paramKeys = Object.keys(this.config.params)
+    const params = paramKeys.reduce((m, k, i) => Object.assign(m, { [k]: args[i] }), {})
+    const [opts, command] = args.slice(paramKeys.length)
+    this.options = { ...opts, ...params, action: command.name() }
+    await this.runTask()
+  }
+}

lib/Utils.js

@@ -1,14 +1,18 @@
+import buildPackageIndex from './utils/buildPackageIndex.js'
 import checkPrerequisites from './utils/checkPrerequisites.js'
 import cloneRepo from './utils/cloneRepo.js'
+import collectJsFiles from './utils/collectJsFiles.js'
 import exec from './utils/exec.js'
 import getAppDependencies from './utils/getAppDependencies.js'
 import getCliRoot from './utils/getCliRoot.js'
 import getReleases from './utils/getReleases.js'
+import getModuleDirs from './utils/getModuleDirs.js'
 import getSchemas from './utils/getSchemas.js'
 import getStartCommands from './utils/getStartCommands.js'
 import githubRequest from './utils/githubRequest.js'
 import importCore from './utils/importCore.js'
 import installLocalModules from './utils/installLocalModules.js'
+import isModule from './utils/isModule.js'
 import loadJson from './utils/loadJson.js'
 import loadPackage from './utils/loadPackage.js'
 import startApp from './utils/startApp.js'
@@ -19,17 +23,21 @@ import saveConfig from './utils/saveConfig.js'
 import updateRepo from './utils/updateRepo.js'
 
 export default {
+  buildPackageIndex,
   checkPrerequisites,
   cloneRepo,
+  collectJsFiles,
   exec,
   getAppDependencies,
   getCliRoot,
+  getModuleDirs,
   getReleases,
   getSchemas,
   getStartCommands,
   githubRequest,
   importCore,
   installLocalModules,
+  isModule,
   loadJson,
   loadPackage,
   parseBody,