adapt-cli 3.0.0 → 3.0.7

package/lib/commands/help.js

@@ -1,31 +1,31 @@
-import fs from 'fs-extra'
-import path from 'path'
-import chalk from 'chalk'
-import getDirNameFromImportMeta from '../util/getDirNameFromImportMeta.js'
-const __dirname = getDirNameFromImportMeta(import.meta)
-
-export default function help (logger, ...args) {
-  const name = args.join(' ')
-  const json = name
-    ? path.resolve(__dirname, `../../json/help-${name.replace(/\s+/g, '/')}.json`)
-    : path.resolve(__dirname, '../../json/help.json')
-  if (!fs.existsSync(json)) {
-    logger?.log(`adapt ${chalk.red(name)}   Unknown command: ${name}`)
-    return
-  }
-  const jsonData = fs.readJSONSync(json)
-  logger?.log('\nUsage: \n')
-  jsonData.usage.forEach(usage => logger?.log(`    ${chalk.cyan('adapt')} ${usage}`))
-  if (jsonData.commands && Object.entries(jsonData.commands).length) {
-    logger?.log('\n\nwhere <command> is one of:\n')
-    Object.entries(jsonData.commands).forEach(([command, description]) => {
-      logger?.log(`    ${command}${new Array(23 - command.length).join(' ')}${description}`)
-    })
-  }
-  if (jsonData.description) {
-    logger?.log(`\nDescription:\n\n    ${jsonData.description}`)
-  }
-  if (!name) {
-    logger?.log('\nSee \'adapt help <command>\' for more information on a specific command.\n')
-  }
-}
+import fs from 'fs-extra'
+import path from 'path'
+import chalk from 'chalk'
+import getDirNameFromImportMeta from '../util/getDirNameFromImportMeta.js'
+const __dirname = getDirNameFromImportMeta(import.meta)
+
+export default function help (logger, ...args) {
+  const name = args.join(' ')
+  const json = name
+    ? path.resolve(__dirname, `../../json/help-${name.replace(/\s+/g, '/')}.json`)
+    : path.resolve(__dirname, '../../json/help.json')
+  if (!fs.existsSync(json)) {
+    logger?.log(`adapt ${chalk.red(name)}   Unknown command: ${name}`)
+    return
+  }
+  const jsonData = fs.readJSONSync(json)
+  logger?.log('\nUsage: \n')
+  jsonData.usage.forEach(usage => logger?.log(`    ${chalk.cyan('adapt')} ${usage}`))
+  if (jsonData.commands && Object.entries(jsonData.commands).length) {
+    logger?.log('\n\nwhere <command> is one of:\n')
+    Object.entries(jsonData.commands).forEach(([command, description]) => {
+      logger?.log(`    ${command}${new Array(23 - command.length).join(' ')}${description}`)
+    })
+  }
+  if (jsonData.description) {
+    logger?.log(`\nDescription:\n\n    ${jsonData.description}`)
+  }
+  if (!name) {
+    logger?.log('\nSee \'adapt help <command>\' for more information on a specific command.\n')
+  }
+}

package/lib/commands/install.js

@@ -1,16 +1,16 @@
-import { install as pluginsInstall } from '../integration/PluginManagement.js'
-
-export default async function install (logger, ...args) {
-  /** strip flags */
-  const isClean = args.includes('--clean')
-  const isDryRun = args.includes('--dry-run') || args.includes('--check')
-  const isCompatibleEnabled = args.includes('--compatible')
-  const plugins = args.filter(arg => !String(arg).startsWith('--'))
-  await pluginsInstall({
-    logger,
-    isClean,
-    isDryRun,
-    isCompatibleEnabled,
-    plugins
-  })
-}
+import { install as pluginsInstall } from '../integration/PluginManagement.js'
+
+export default async function install (logger, ...args) {
+  /** strip flags */
+  const isClean = args.includes('--clean')
+  const isDryRun = args.includes('--dry-run') || args.includes('--check')
+  const isCompatibleEnabled = args.includes('--compatible')
+  const plugins = args.filter(arg => !String(arg).startsWith('--'))
+  await pluginsInstall({
+    logger,
+    isClean,
+    isDryRun,
+    isCompatibleEnabled,
+    plugins
+  })
+}

package/lib/commands/ls.js

@@ -1,9 +1,35 @@
-import chalk from 'chalk'
-import Project from '../integration/Project.js'
-
-export default async function ls (logger) {
-  const project = new Project({ logger })
-  project.tryThrowInvalidPath()
-  const installTargets = await project.getInstallTargets()
-  installTargets.forEach(p => logger?.log(`${chalk.cyan(p.name || p.sourcePath)} ${p.sourcePath || p.requestedVersion}`))
-}
+import chalk from 'chalk'
+import _ from 'lodash'
+import Project from '../integration/Project.js'
+import { eachOfLimitProgress } from '../util/promises.js'
+
+export default async function ls (logger) {
+  const project = new Project({ logger })
+  const frameworkVersion = project.version
+  project.tryThrowInvalidPath()
+  const installTargets = (await project.getInstallTargets())
+  const installTargetsIndex = installTargets.reduce((hash, p) => {
+    const name = (p.name || p.sourcePath)
+    hash[name] = p
+    return hash
+  }, {})
+  const installedPlugins = await project.getInstalledPlugins();
+  const notInstalled = _.difference(installTargets.map(p => (p.name || p.sourcePath)), installedPlugins.map(p => (p.name || p.sourcePath)))
+  const plugins = installedPlugins.concat(notInstalled.map(name => installTargetsIndex[name]))
+  await eachOfLimitProgress(
+    plugins,
+    async (target) => {
+      await target.fetchProjectInfo()
+      await target.fetchSourceInfo()
+      await target.findCompatibleVersion(frameworkVersion)
+    },
+    percentage => logger?.logProgress?.(`${chalk.bold.cyan('<info>')} Getting plugin info ${percentage}% complete`)
+  )
+  logger?.log(`${chalk.bold.cyan('<info>')} Getting plugin info 100% complete`)
+  plugins
+    .sort((a, b) => a.name.localeCompare(b.name))
+    .forEach(p => {
+      const name = (p.name || p.sourcePath)
+      logger?.log(`${chalk.cyan(p.name || p.sourcePath)} ${chalk.green('adapt.json')}: ${installTargetsIndex[name]?.requestedVersion || 'n/a'} ${chalk.green('installed')}: ${p.sourcePath || p.projectVersion || 'n/a'} ${chalk.green('latest')}: ${p.sourcePath || p.latestCompatibleSourceVersion || 'n/a'}`)
+    })
+}

package/lib/commands/register.js

@@ -1,11 +1,11 @@
-import { register as pluginRegister } from '../integration/PluginManagement.js'
-
-export default async function register (logger, ...args) {
-  // strip flags
-  args = args.filter(arg => !String(arg).startsWith('--'))
-  return await pluginRegister({
-    logger,
-    cwd: process.cwd(),
-    args
-  })
-}
+import { register as pluginRegister } from '../integration/PluginManagement.js'
+
+export default async function register (logger, ...args) {
+  // strip flags
+  args = args.filter(arg => !String(arg).startsWith('--'))
+  return await pluginRegister({
+    logger,
+    cwd: process.cwd(),
+    args
+  })
+}

package/lib/commands/rename.js

@@ -1,14 +1,14 @@
-import { rename as pluginRename } from '../integration/PluginManagement.js'
-
-export default async function rename (logger, ...args) {
-  /** strip flags */
-  args = args.filter(arg => !String(arg).startsWith('--'))
-  const oldName = args[0]
-  const newName = args[1]
-  await pluginRename({
-    logger,
-    cwd: process.cwd(),
-    oldName,
-    newName
-  })
-}
+import { rename as pluginRename } from '../integration/PluginManagement.js'
+
+export default async function rename (logger, ...args) {
+  /** strip flags */
+  args = args.filter(arg => !String(arg).startsWith('--'))
+  const oldName = args[0]
+  const newName = args[1]
+  await pluginRename({
+    logger,
+    cwd: process.cwd(),
+    oldName,
+    newName
+  })
+}

package/lib/commands/search.js

@@ -1,11 +1,11 @@
-import { search as pluginsSearch } from '../integration/PluginManagement.js'
-
-export default async function search (logger, ...args) {
-  /** strip flags */
-  args = args.filter(arg => !String(arg).startsWith('--'))
-  const searchTerm = (args[0] || '')
-  await pluginsSearch({
-    logger,
-    searchTerm
-  })
-}
+import { search as pluginsSearch } from '../integration/PluginManagement.js'
+
+export default async function search (logger, ...args) {
+  /** strip flags */
+  args = args.filter(arg => !String(arg).startsWith('--'))
+  const searchTerm = (args[0] || '')
+  await pluginsSearch({
+    logger,
+    searchTerm
+  })
+}

package/lib/commands/uninstall.js

@@ -1,9 +1,9 @@
-import { uninstall as pluginsUninstall } from '../integration/PluginManagement.js'
-
-export default async function uninstall (logger, ...args) {
-  const plugins = args.filter(arg => !String(arg).startsWith('--'))
-  await pluginsUninstall({
-    logger,
-    plugins
-  })
-}
+import { uninstall as pluginsUninstall } from '../integration/PluginManagement.js'
+
+export default async function uninstall (logger, ...args) {
+  const plugins = args.filter(arg => !String(arg).startsWith('--'))
+  await pluginsUninstall({
+    logger,
+    plugins
+  })
+}

package/lib/commands/unregister.js

@@ -1,12 +1,12 @@
-import { unregister as pluginUnregister } from '../integration/PluginManagement.js'
-
-export default async function register (logger, ...args) {
-  // strip flags
-  args = args.filter(arg => !String(arg).startsWith('--'))
-  const pluginName = args[0]
-  return await pluginUnregister({
-    logger,
-    cwd: process.cwd(),
-    pluginName
-  })
-}
+import { unregister as pluginUnregister } from '../integration/PluginManagement.js'
+
+export default async function register (logger, ...args) {
+  // strip flags
+  args = args.filter(arg => !String(arg).startsWith('--'))
+  const pluginName = args[0]
+  return await pluginUnregister({
+    logger,
+    cwd: process.cwd(),
+    pluginName
+  })
+}

package/lib/commands/update.js

@@ -1,12 +1,12 @@
-import { update as pluginsUpdate } from '../integration/PluginManagement.js'
-
-export default async function update (logger, ...args) {
-  /** strip flags */
-  const isDryRun = args.includes('--dry-run') || args.includes('--check')
-  const plugins = args.filter(arg => !String(arg).startsWith('--'))
-  await pluginsUpdate({
-    logger,
-    plugins,
-    isDryRun
-  })
-}
+import { update as pluginsUpdate } from '../integration/PluginManagement.js'
+
+export default async function update (logger, ...args) {
+  /** strip flags */
+  const isDryRun = args.includes('--dry-run') || args.includes('--check')
+  const plugins = args.filter(arg => !String(arg).startsWith('--'))
+  await pluginsUpdate({
+    logger,
+    plugins,
+    isDryRun
+  })
+}

package/lib/commands/version.js

@@ -1,13 +1,13 @@
-import Project from '../integration/Project.js'
-import path from 'path'
-import { readValidateJSONSync } from '../util/JSONReadValidate.js'
-import getDirNameFromImportMeta from '../util/getDirNameFromImportMeta.js'
-const __dirname = getDirNameFromImportMeta(import.meta)
-
-export default function version (logger) {
-  const cliVersionPath = path.join(__dirname, '../../package.json')
-  const cliVersion = readValidateJSONSync(cliVersionPath).version
-  const project = new Project()
-  logger?.log('CLI: ' + cliVersion)
-  logger?.log('Framework: ' + project.version)
-}
+import Project from '../integration/Project.js'
+import path from 'path'
+import { readValidateJSONSync } from '../util/JSONReadValidate.js'
+import getDirNameFromImportMeta from '../util/getDirNameFromImportMeta.js'
+const __dirname = getDirNameFromImportMeta(import.meta)
+
+export default function version (logger) {
+  const cliVersionPath = path.join(__dirname, '../../package.json')
+  const cliVersion = readValidateJSONSync(cliVersionPath).version
+  const project = new Project()
+  logger?.log('CLI: ' + cliVersion)
+  logger?.log('Framework: ' + project.version)
+}

package/lib/econnreset.js

@@ -0,0 +1,8 @@
+// guard against ECONNRESET issues https://github.com/adaptlearning/adapt-cli/issues/169
+process.on('uncaughtException', (error, origin) => {
+  if (error?.code === 'ECONNRESET') return
+  console.error('UNCAUGHT EXCEPTION')
+  console.error(error)
+  console.error(origin)
+  process.exit(1)
+})

package/lib/integration/AdaptFramework/build.js

@@ -1,39 +1,42 @@
-import chalk from 'chalk'
-import { exec } from 'child_process'
-import Project from '../Project.js'
-import path from 'path'
-
-export default async function adaptBuild ({
-  sourceMaps = false,
-  checkJSON = false,
-  cache = true,
-  outputDir = null,
-  cachePath = null,
-  cwd = process.cwd(),
-  logger
-} = {}) {
-  cwd = path.resolve(process.cwd(), cwd)
-  const project = new Project({ cwd, logger })
-  project.tryThrowInvalidPath()
-  logger?.log(chalk.cyan('running build'))
-  await new Promise((resolve, reject) => {
-    const cmd = [
-      'npx grunt',
-      !checkJSON
-        ? `server-build:${sourceMaps ? 'dev' : 'prod'}` // AAT
-        : `${sourceMaps ? 'diff' : 'build'}`, // Handbuilt
-      !cache && '--disable-cache',
-      outputDir && `--outputdir=${outputDir}`,
-      cachePath && `--cachepath=${cachePath}`
-    ].filter(Boolean).join(' ');
-    exec(cmd, { cwd }, (error, stdout, stderr) => {
-      if(error || stderr) {
-        const e = new Error('grunt tasks failed')
-        e.cmd = cmd;
-        e.raw = stdout.match(/>> Error:\s(.+)\s/)[1]
-        return reject(e)
-      }
-      resolve()
-    })
-  })
-}
+import chalk from 'chalk'
+import { exec } from 'child_process'
+import Project from '../Project.js'
+import path from 'path'
+
+export default async function adaptBuild ({
+  sourceMaps = false,
+  checkJSON = false,
+  cache = true,
+  outputDir = null,
+  cachePath = null,
+  cwd = process.cwd(),
+  logger
+} = {}) {
+  cwd = path.resolve(process.cwd(), cwd)
+  const project = new Project({ cwd, logger })
+  project.tryThrowInvalidPath()
+  logger?.log(chalk.cyan('running build'))
+  await new Promise((resolve, reject) => {
+    const cmd = [
+      'npx grunt',
+      !checkJSON
+        ? `server-build:${sourceMaps ? 'dev' : 'prod'}` // AAT
+        : `${sourceMaps ? 'diff' : 'build'}`, // Handbuilt
+      !cache && '--disable-cache',
+      outputDir && `--outputdir=${outputDir}`,
+      cachePath && `--cachepath=${cachePath}`
+    ].filter(Boolean).join(' ');
+    exec(cmd, { cwd }, (error, stdout, stderr) => {
+      if(error || stderr) {
+        const matches = stdout.match(/>> Error:\s(.+)\s/);
+        const e = new Error('grunt tasks failed')
+        e.cmd = cmd;
+        e.raw = matches?.[1] ?? stdout;
+        e.source = error;
+        e.stderr = stderr;
+        return reject(e)
+      }
+      resolve()
+    })
+  })
+}

package/lib/integration/AdaptFramework/clone.js

@@ -1,27 +1,27 @@
-import chalk from 'chalk'
-import { exec } from 'child_process'
-import { ADAPT_FRAMEWORK } from '../../util/constants.js'
-import path from 'path'
-
-export default async function clone ({
-  repository = ADAPT_FRAMEWORK,
-  branch = 'master',
-  cwd = process.cwd(),
-  logger
-} = {}) {
-  repository = repository.replace(/\.git/g, '')
-  cwd = path.resolve(process.cwd(), cwd)
-  if (!branch && !repository) throw new Error('Repository details are required.')
-  logger?.write(chalk.cyan('cloning framework to', cwd, '\t'))
-  await new Promise(function (resolve, reject) {
-    const child = exec(`git clone ${repository} "${cwd}"`)
-    child.addListener('error', reject)
-    child.addListener('exit', resolve)
-  })
-  await new Promise(function (resolve, reject) {
-    const child = exec(`git checkout ${branch}`)
-    child.addListener('error', reject)
-    child.addListener('exit', resolve)
-  })
-  logger?.log(' ', 'done!')
-}
+import chalk from 'chalk'
+import { exec } from 'child_process'
+import { ADAPT_FRAMEWORK } from '../../util/constants.js'
+import path from 'path'
+
+export default async function clone ({
+  repository = ADAPT_FRAMEWORK,
+  branch = 'master',
+  cwd = process.cwd(),
+  logger
+} = {}) {
+  repository = repository.replace(/\.git/g, '')
+  cwd = path.resolve(process.cwd(), cwd)
+  if (!branch && !repository) throw new Error('Repository details are required.')
+  logger?.write(chalk.cyan('cloning framework to', cwd, '\t'))
+  await new Promise(function (resolve, reject) {
+    const child = exec(`git clone ${repository} "${cwd}"`)
+    child.addListener('error', reject)
+    child.addListener('exit', resolve)
+  })
+  await new Promise(function (resolve, reject) {
+    const child = exec(`git checkout ${branch}`)
+    child.addListener('error', reject)
+    child.addListener('exit', resolve)
+  })
+  logger?.log(' ', 'done!')
+}

package/lib/integration/AdaptFramework/deleteSrcCore.js

@@ -1,9 +1,9 @@
-import fs from 'fs-extra'
-import path from 'path'
-
-export default function deleteSrcCore ({
-  cwd = process.cwd()
-} = {}) {
-  cwd = path.resolve(process.cwd(), cwd)
-  return fs.rm(path.resolve(cwd, 'src/core'), { recursive: true, force: true })
-}
+import fs from 'fs-extra'
+import path from 'path'
+
+export default function deleteSrcCore ({
+  cwd = process.cwd()
+} = {}) {
+  cwd = path.resolve(process.cwd(), cwd)
+  return fs.rm(path.resolve(cwd, 'src/core'), { recursive: true, force: true })
+}

package/lib/integration/AdaptFramework/deleteSrcCourse.js

@@ -1,9 +1,9 @@
-import fs from 'fs-extra'
-import path from 'path'
-
-export default function deleteSrcCourse ({
-  cwd = process.cwd()
-} = {}) {
-  cwd = path.resolve(process.cwd(), cwd)
-  return fs.rm(path.resolve(cwd, 'src/course'), { recursive: true, force: true })
-}
+import fs from 'fs-extra'
+import path from 'path'
+
+export default function deleteSrcCourse ({
+  cwd = process.cwd()
+} = {}) {
+  cwd = path.resolve(process.cwd(), cwd)
+  return fs.rm(path.resolve(cwd, 'src/course'), { recursive: true, force: true })
+}

package/lib/integration/AdaptFramework/download.js

@@ -1,21 +1,21 @@
-import downloader from '../../util/download.js'
-import { ADAPT_FRAMEWORK } from '../../util/constants.js'
-import path from 'path'
-
-export default async function download ({
-  repository = ADAPT_FRAMEWORK,
-  branch,
-  tmp,
-  cwd,
-  logger
-} = {}) {
-  repository = repository.replace(/\.git/g, '')
-  cwd = path.resolve(process.cwd(), cwd)
-  return downloader({
-    repository,
-    branch,
-    tmp,
-    cwd,
-    logger
-  })
-}
+import downloader from '../../util/download.js'
+import { ADAPT_FRAMEWORK } from '../../util/constants.js'
+import path from 'path'
+
+export default async function download ({
+  repository = ADAPT_FRAMEWORK,
+  branch,
+  tmp,
+  cwd,
+  logger
+} = {}) {
+  repository = repository.replace(/\.git/g, '')
+  cwd = path.resolve(process.cwd(), cwd)
+  return downloader({
+    repository,
+    branch,
+    tmp,
+    cwd,
+    logger
+  })
+}

package/lib/integration/AdaptFramework/erase.js

@@ -1,34 +1,34 @@
-import chalk from 'chalk'
-import fs from 'fs-extra'
-import inquirer from 'inquirer'
-import globs from 'globs'
-import path from 'path'
-
-export default async function erase ({
-  isInteractive = true,
-  cwd,
-  logger
-} = {}) {
-  cwd = path.resolve(process.cwd(), cwd)
-  if (!fs.existsSync(cwd)) return
-  if (isInteractive) {
-    const results = await inquirer.prompt([{
-      name: 'overwrite existing course?',
-      type: 'confirm',
-      default: false
-    }])
-    if (!results['overwrite existing course?']) {
-      throw new Error('Course already exists and cannot overwrite.')
-    }
-  }
-  logger?.log(chalk.cyan('deleting existing course'))
-  const files = await new Promise((resolve, reject) => {
-    globs('**', { cwd }, (err, files) => {
-      if (err) return reject(err)
-      resolve(files)
-    })
-  })
-  for (const file of files) {
-    await fs.rm(file, { recursive: true })
-  }
-}
+import chalk from 'chalk'
+import fs from 'fs-extra'
+import inquirer from 'inquirer'
+import globs from 'globs'
+import path from 'path'
+
+export default async function erase ({
+  isInteractive = true,
+  cwd,
+  logger
+} = {}) {
+  cwd = path.resolve(process.cwd(), cwd)
+  if (!fs.existsSync(cwd)) return
+  if (isInteractive) {
+    const results = await inquirer.prompt([{
+      name: 'overwrite existing course?',
+      type: 'confirm',
+      default: false
+    }])
+    if (!results['overwrite existing course?']) {
+      throw new Error('Course already exists and cannot overwrite.')
+    }
+  }
+  logger?.log(chalk.cyan('deleting existing course'))
+  const files = await new Promise((resolve, reject) => {
+    globs('**', { cwd }, (err, files) => {
+      if (err) return reject(err)
+      resolve(files)
+    })
+  })
+  for (const file of files) {
+    await fs.rm(file, { recursive: true })
+  }
+}