updated-upgrade-script

Author: svincent240

lib/upgrade.js

@@ -83,6 +83,36 @@ function copyFileWithBackup(src, dest) {
   return { updated: true, backup: null };
 }
 
+export function addMissingRuntimeDependencies(projectPkg, templatePkg) {
+  const requiredDeps = templatePkg.dependencies || {};
+  const existingDeps = projectPkg.dependencies || {};
+  const existingDevDeps = projectPkg.devDependencies || {};
+  const added = [];
+
+  for (const [name, version] of Object.entries(requiredDeps)) {
+    if (existingDeps[name]) {
+      continue;
+    }
+
+    existingDeps[name] = existingDevDeps[name] || version;
+    delete existingDevDeps[name];
+    added.push(name);
+  }
+
+  if (added.length > 0) {
+    projectPkg.dependencies = Object.fromEntries(
+      Object.entries(existingDeps).sort(([a], [b]) => a.localeCompare(b))
+    );
+    if (projectPkg.devDependencies) {
+      projectPkg.devDependencies = Object.fromEntries(
+        Object.entries(existingDevDeps).sort(([a], [b]) => a.localeCompare(b))
+      );
+    }
+  }
+
+  return added;
+}
+
 export async function upgrade(options = {}) {
   const cwd = process.cwd();
   const rcPath = path.join(cwd, '.coursecoderc.json');
@@ -109,6 +139,7 @@ export async function upgrade(options = {}) {
   // Get CLI version (this is the version we'll upgrade to)
   const cliPkg = JSON.parse(fs.readFileSync(path.join(PACKAGE_ROOT, 'package.json'), 'utf-8'));
   const targetVersion = cliPkg.version;
+  const templatePkg = JSON.parse(fs.readFileSync(path.join(PACKAGE_ROOT, 'template', 'package.json'), 'utf-8'));
 
   console.log(`
 📦 CourseCode Upgrade
@@ -138,6 +169,7 @@ export async function upgrade(options = {}) {
    - framework/     (replace entirely)
    - schemas/       (replace entirely)
    - lib/manifest/  (replace entirely)
+   - package.json   (add missing runtime dependencies)
    - .coursecoderc.json  (update version)`;
 
     if (options.configs) {
@@ -150,7 +182,6 @@ export async function upgrade(options = {}) {
    
    Would NOT touch:
    - course/        (your content)${!options.configs ? '\n   - vite.config.js\n   - eslint.config.js' : ''}
-   - package.json
    - .env
 `;
     console.log(dryRunMsg);
@@ -231,13 +262,34 @@ export async function upgrade(options = {}) {
   rcConfig.upgradedFrom = currentVersion;
   fs.writeFileSync(rcPath, JSON.stringify(rcConfig, null, 2));
 
+  // Add any runtime dependencies introduced by the new framework while preserving
+  // the project's existing version ranges.
+  const pkgPath = path.join(cwd, 'package.json');
+  let addedRuntimeDeps = [];
+  if (fs.existsSync(pkgPath)) {
+    const projectPkg = JSON.parse(fs.readFileSync(pkgPath, 'utf-8'));
+    addedRuntimeDeps = addMissingRuntimeDependencies(projectPkg, templatePkg);
+    if (addedRuntimeDeps.length > 0) {
+      fs.writeFileSync(pkgPath, JSON.stringify(projectPkg, null, 2) + '\n');
+    }
+  }
+
   let successMsg = `
 ✅ Upgrade complete!
 
    ${currentVersion} → ${targetVersion}
 
    Your course/ directory was not modified.`;
 
+  if (addedRuntimeDeps.length > 0) {
+    successMsg += `
+
+   Runtime dependencies added to package.json:
+   - ${addedRuntimeDeps.join('\n   - ')}
+
+   Run npm install to update node_modules and your lockfile.`;
+  }
+
   if (configUpdates.length > 0) {
     successMsg += `
 

package.json

@@ -1,6 +1,6 @@
 {
   "name": "coursecode",
-  "version": "0.1.43",
+  "version": "0.1.44",
   "description": "Multi-format course authoring framework with CLI tools (SCORM 2004, SCORM 1.2, cmi5, LTI 1.3)",
   "type": "module",
   "bin": {

template/vite.config.js

@@ -190,6 +190,7 @@ function scanDistFiles() {
 function scormPostBuild(isDev) {
   return {
     name: 'scorm-post-build',
+    enforce: 'post',
     buildStart() {
       if (isDev) console.log('🔨 Building...');
     },
@@ -251,7 +252,7 @@ function scormPostBuild(isDev) {
             console.log('\n📦 Creating external hosting package archives...');
             await createExternalPackagesForClients({ rootDir: ROOT_DIR, config });
           }
-          console.log('\n✅ Package built successfully');
+          console.log('\n✓ Package archive created');
         } else {
           console.log('✅ Build complete\n');
         }

tests/lib/upgrade.test.js

@@ -0,0 +1,51 @@
+import { describe, it, expect } from 'vitest';
+import { addMissingRuntimeDependencies } from '../../lib/upgrade.js';
+
+describe('upgrade package dependency migration', () => {
+    it('adds missing runtime dependencies from the current template', () => {
+        const projectPkg = {
+            dependencies: {
+                'marked': '^16.0.0'
+            },
+            devDependencies: {
+                'vite': '~7.2.2'
+            }
+        };
+        const templatePkg = {
+            dependencies: {
+                '@xapi/cmi5': '^1.4.0',
+                'jose': '^6.2.2',
+                'marked': '^17.0.6'
+            }
+        };
+
+        const added = addMissingRuntimeDependencies(projectPkg, templatePkg);
+
+        expect(added).toEqual(['@xapi/cmi5', 'jose']);
+        expect(projectPkg.dependencies).toEqual({
+            '@xapi/cmi5': '^1.4.0',
+            'jose': '^6.2.2',
+            'marked': '^16.0.0'
+        });
+    });
+
+    it('moves required runtime dependencies out of dev dependencies', () => {
+        const projectPkg = {
+            devDependencies: {
+                'jose': '^6.1.0',
+                'vite': '~7.2.2'
+            }
+        };
+        const templatePkg = {
+            dependencies: {
+                'jose': '^6.2.2'
+            }
+        };
+
+        const added = addMissingRuntimeDependencies(projectPkg, templatePkg);
+
+        expect(added).toEqual(['jose']);
+        expect(projectPkg.dependencies).toEqual({ 'jose': '^6.1.0' });
+        expect(projectPkg.devDependencies).toEqual({ 'vite': '~7.2.2' });
+    });
+});