adapt-cli 3.0.2 → 3.0.6

package/lib/commands/authenticate.js

@@ -1,18 +1,18 @@
-import chalk from 'chalk'
-import { authenticate as pluginAuthenticate } from '../integration/PluginManagement.js'
-
-export default async function authenticate (logger, ...args) {
-  // strip flags
-  args = args.filter(arg => !String(arg).startsWith('--'))
-  try {
-    const confirmation = await pluginAuthenticate({
-      logger,
-      cwd: process.cwd(),
-      pluginName: args[0]
-    })
-    const { username, type, pluginName } = confirmation
-    logger?.log(chalk.green(`${username} authenticated as ${type} for ${pluginName}`))
-  } catch (err) {
-    logger?.error('Authentication failed')
-  }
-}
+import chalk from 'chalk'
+import { authenticate as pluginAuthenticate } from '../integration/PluginManagement.js'
+
+export default async function authenticate (logger, ...args) {
+  // strip flags
+  args = args.filter(arg => !String(arg).startsWith('--'))
+  try {
+    const confirmation = await pluginAuthenticate({
+      logger,
+      cwd: process.cwd(),
+      pluginName: args[0]
+    })
+    const { username, type, pluginName } = confirmation
+    logger?.log(chalk.green(`${username} authenticated as ${type} for ${pluginName}`))
+  } catch (err) {
+    logger?.error('Authentication failed')
+  }
+}

package/lib/commands/create/component.js

@@ -1,64 +1,64 @@
-import fs from 'fs-extra'
-import globs from 'globs'
-import path from 'path'
-import chalk from 'chalk'
-import slug from 'speakingurl'
-import Project from '../../integration/Project.js'
-import downloader from '../../util/download.js'
-import { ADAPT_COMPONENT } from '../../util/constants.js'
-
-export default async function component ({
-  name,
-  repository = ADAPT_COMPONENT,
-  cwd,
-  branch,
-  logger
-}) {
-  name = slug(name, { maintainCase: true })
-
-  const project = new Project({ cwd, logger })
-  let pluginDir
-  if (project.containsManifestFile) {
-    const componentsDirectory = 'src/components'
-    pluginDir = path.join(cwd, componentsDirectory, 'adapt-' + name)
-    if (!fs.existsSync(componentsDirectory)) fs.mkdirSync(componentsDirectory)
-  } else {
-    pluginDir = path.join(cwd, name)
-  }
-
-  await downloader({
-    branch,
-    repository,
-    cwd: pluginDir,
-    logger
-  })
-
-  const files = await new Promise((resolve, reject) => {
-    globs('**', { cwd: pluginDir }, (err, matches) => {
-      if (err) return reject(err)
-      resolve(matches.map(match => path.join(pluginDir, match)))
-    })
-  })
-
-  const filesRenamed = files.map(from => {
-    const to = from.replace(/((contrib-)?componentName)/g, name)
-    fs.renameSync(from, to)
-    return to
-  })
-
-  await Promise.all(filesRenamed.map(async function (file) {
-    if (fs.statSync(file).isDirectory()) return
-    const lowerCaseName = name.toLowerCase()
-    const content = (await fs.readFile(file)).toString()
-    const modifiedContent = content
-      .replace(/((contrib-)?componentName)/g, name)
-      .replace(/((contrib-)?componentname)/g, lowerCaseName)
-    return fs.writeFile(file, modifiedContent)
-  }))
-
-  logger?.log('\n' + chalk.green(pluginDir), 'has been created.\n')
-
-  if (fs.existsSync('./adapt.json')) {
-    logger?.log(chalk.grey('To use this component in your course, use the registered name:') + chalk.yellow(name))
-  }
-}
+import fs from 'fs-extra'
+import globs from 'globs'
+import path from 'path'
+import chalk from 'chalk'
+import slug from 'speakingurl'
+import Project from '../../integration/Project.js'
+import downloader from '../../util/download.js'
+import { ADAPT_COMPONENT } from '../../util/constants.js'
+
+export default async function component ({
+  name,
+  repository = ADAPT_COMPONENT,
+  cwd,
+  branch,
+  logger
+}) {
+  name = slug(name, { maintainCase: true })
+
+  const project = new Project({ cwd, logger })
+  let pluginDir
+  if (project.containsManifestFile) {
+    const componentsDirectory = 'src/components'
+    pluginDir = path.join(cwd, componentsDirectory, 'adapt-' + name)
+    if (!fs.existsSync(componentsDirectory)) fs.mkdirSync(componentsDirectory)
+  } else {
+    pluginDir = path.join(cwd, name)
+  }
+
+  await downloader({
+    branch,
+    repository,
+    cwd: pluginDir,
+    logger
+  })
+
+  const files = await new Promise((resolve, reject) => {
+    globs('**', { cwd: pluginDir }, (err, matches) => {
+      if (err) return reject(err)
+      resolve(matches.map(match => path.join(pluginDir, match)))
+    })
+  })
+
+  const filesRenamed = files.map(from => {
+    const to = from.replace(/((contrib-)?componentName)/g, name)
+    fs.renameSync(from, to)
+    return to
+  })
+
+  await Promise.all(filesRenamed.map(async function (file) {
+    if (fs.statSync(file).isDirectory()) return
+    const lowerCaseName = name.toLowerCase()
+    const content = (await fs.readFile(file)).toString()
+    const modifiedContent = content
+      .replace(/((contrib-)?componentName)/g, name)
+      .replace(/((contrib-)?componentname)/g, lowerCaseName)
+    return fs.writeFile(file, modifiedContent)
+  }))
+
+  logger?.log('\n' + chalk.green(pluginDir), 'has been created.\n')
+
+  if (fs.existsSync('./adapt.json')) {
+    logger?.log(chalk.grey('To use this component in your course, use the registered name:') + chalk.yellow(name))
+  }
+}

package/lib/commands/create/course.js

@@ -1,26 +1,26 @@
-import chalk from 'chalk'
-import {
-  erase,
-  download,
-  npmInstall
-} from '../../integration/AdaptFramework.js'
-import path from 'path'
-import { install as pluginsInstall } from '../../integration/PluginManagement.js'
-
-export default async function course ({ name, branch, cwd, logger }) {
-  cwd = path.join(cwd, name)
-  await erase({ logger, cwd })
-  await download({ logger, cwd, branch })
-  await npmInstall({ logger, cwd })
-  await pluginsInstall({ logger, cwd })
-  logger?.log(`
-${chalk.green(name)} has been created.
-
-${chalk.grey('To build the course, run:')}
-  cd ${name}
-  grunt build
-
-${chalk.grey('Then to view the course, run:')}
-  grunt server
-`)
-}
+import chalk from 'chalk'
+import {
+  erase,
+  download,
+  npmInstall
+} from '../../integration/AdaptFramework.js'
+import path from 'path'
+import { install as pluginsInstall } from '../../integration/PluginManagement.js'
+
+export default async function course ({ name, branch, cwd, logger }) {
+  cwd = path.join(cwd, name)
+  await erase({ logger, cwd })
+  await download({ logger, cwd, branch })
+  await npmInstall({ logger, cwd })
+  await pluginsInstall({ logger, cwd })
+  logger?.log(`
+${chalk.green(name)} has been created.
+
+${chalk.grey('To build the course, run:')}
+  cd ${name}
+  grunt build
+
+${chalk.grey('Then to view the course, run:')}
+  grunt server
+`)
+}

package/lib/commands/create/question.js

@@ -1,18 +1,18 @@
-import component from './component.js'
-import { ADAPT_QUESTION } from '../../util/constants.js'
-
-export default async function question ({
-  name,
-  repository = ADAPT_QUESTION,
-  cwd,
-  branch,
-  logger
-}) {
-  return component({
-    name,
-    repository,
-    cwd,
-    branch,
-    logger
-  })
-}
+import component from './component.js'
+import { ADAPT_QUESTION } from '../../util/constants.js'
+
+export default async function question ({
+  name,
+  repository = ADAPT_QUESTION,
+  cwd,
+  branch,
+  logger
+}) {
+  return component({
+    name,
+    repository,
+    cwd,
+    branch,
+    logger
+  })
+}

package/lib/commands/create.js

@@ -1,85 +1,94 @@
-import inquirer from 'inquirer'
-import component from './create/component.js'
-import question from './create/question.js'
-import course from './create/course.js'
-import { ADAPT_FRAMEWORK } from '../util/constants.js'
-import { getLatestVersion as getAdaptLatestVersion } from '../integration/AdaptFramework.js'
-
-const subTasks = {
-  component,
-  question,
-  course
-}
-
-/**
- * TODO: Change component name to camel case
- */
-export const DEFAULT_TYPE_NAME = {
-  course: 'my-adapt-course',
-  component: 'myAdaptComponent',
-  question: 'myAdaptQuestion'
-}
-
-export default async function create (logger, type = 'course', name, branch) {
-  const options = await confirmOptions({
-    type,
-    name,
-    branch,
-    logger
-  })
-  const action = subTasks[options.type]
-  if (!action) throw new Error('' + options.type + ' is not a supported type')
-  try {
-    await action({
-      name: options.name,
-      branch: options.branch,
-      cwd: process.cwd(),
-      logger
-    })
-  } catch (err) {
-    logger?.error("Oh dear, something went wrong. I'm terribly sorry.", err.message)
-    throw err
-  }
-}
-
-async function confirmOptions ({ logger, type, name, branch }) {
-  const typeSchema = [
-    {
-      name: 'type',
-      choices: ['course', 'component', 'question'],
-      type: 'list',
-      default: type
-    }
-  ]
-  const typeSchemaResults = await inquirer.prompt(typeSchema)
-  branch = branch || (typeSchemaResults.type === 'course')
-    ? await getAdaptLatestVersion({ repository: ADAPT_FRAMEWORK })
-    : 'master'
-  const propertySchema = [
-    {
-      name: 'name',
-      message: 'name',
-      type: 'input',
-      default: name || DEFAULT_TYPE_NAME[typeSchemaResults.type]
-    },
-    {
-      name: 'branch',
-      message: 'branch/tag',
-      type: 'input',
-      default: branch || 'not specified'
-    },
-    {
-      name: 'ready',
-      message: 'create now?',
-      type: 'confirm',
-      default: true
-    }
-  ]
-  const propertySchemaResults = await inquirer.prompt(propertySchema)
-  if (!propertySchemaResults.ready) throw new Error('Aborted. Nothing has been created.')
-  const finalProperties = {
-    ...typeSchemaResults,
-    ...propertySchemaResults
-  }
-  return finalProperties
-}
+import inquirer from 'inquirer'
+import component from './create/component.js'
+import question from './create/question.js'
+import course from './create/course.js'
+import { ADAPT_FRAMEWORK } from '../util/constants.js'
+import { getLatestVersion as getAdaptLatestVersion } from '../integration/AdaptFramework.js'
+
+const subTasks = {
+  component,
+  question,
+  course
+}
+
+/**
+ * TODO: Change component name to camel case
+ */
+export const DEFAULT_TYPE_NAME = {
+  course: 'my-adapt-course',
+  component: 'myAdaptComponent',
+  question: 'myAdaptQuestion'
+}
+
+export default async function create (logger, type = 'course', name, branch, bypassPrompts) {
+  let options = {
+    type,
+    name,
+    branch
+  }
+
+  if (!bypassPrompts) {
+    options = await confirmOptions({
+      type,
+      name,
+      branch,
+      logger
+    })
+  }
+
+  const action = subTasks[options.type]
+  if (!action) throw new Error('' + options.type + ' is not a supported type')
+  try {
+    await action({
+      name: options.name,
+      branch: options.branch,
+      cwd: process.cwd(),
+      logger
+    })
+  } catch (err) {
+    logger?.error("Oh dear, something went wrong. I'm terribly sorry.", err.message)
+    throw err
+  }
+}
+
+async function confirmOptions ({ logger, type, name, branch }) {
+  const typeSchema = [
+    {
+      name: 'type',
+      choices: ['course', 'component', 'question'],
+      type: 'list',
+      default: type
+    }
+  ]
+  const typeSchemaResults = await inquirer.prompt(typeSchema)
+  branch = branch || (typeSchemaResults.type === 'course')
+    ? await getAdaptLatestVersion({ repository: ADAPT_FRAMEWORK })
+    : 'master'
+  const propertySchema = [
+    {
+      name: 'name',
+      message: 'name',
+      type: 'input',
+      default: name || DEFAULT_TYPE_NAME[typeSchemaResults.type]
+    },
+    {
+      name: 'branch',
+      message: 'branch/tag',
+      type: 'input',
+      default: branch || 'not specified'
+    },
+    {
+      name: 'ready',
+      message: 'create now?',
+      type: 'confirm',
+      default: true
+    }
+  ]
+  const propertySchemaResults = await inquirer.prompt(propertySchema)
+  if (!propertySchemaResults.ready) throw new Error('Aborted. Nothing has been created.')
+  const finalProperties = {
+    ...typeSchemaResults,
+    ...propertySchemaResults
+  }
+  return finalProperties
+}

package/lib/commands/devinstall.js

@@ -1,35 +1,35 @@
-import { clone as adaptClone } from '../integration/AdaptFramework.js'
-import { install as pluginsInstall } from '../integration/PluginManagement.js'
-import { ADAPT_FRAMEWORK } from '../util/constants.js'
-import path from 'path'
-import Project from '../integration/Project.js'
-import gh from 'parse-github-url'
-
-export default async function devinstall (logger, ...args) {
-  const NAME = gh(ADAPT_FRAMEWORK).repo
-  const isInAdapt = new Project().isAdaptDirectory
-  // In adapt folder or download adapt into adapt_framework folder
-  const cwd = isInAdapt
-    ? process.cwd()
-    : path.resolve(NAME)
-  // strip flags
-  const isClean = args.includes('--clean')
-  const isDryRun = args.includes('--dry-run') || args.includes('--check')
-  const isCompatibleEnabled = args.includes('--compatible')
-  args = args.filter(arg => !String(arg).startsWith('--'))
-  // always perform a clone on the adapt directory
-  if (!isInAdapt || args.includes(NAME)) {
-    await adaptClone({ logger, cwd })
-    args = args.filter(arg => arg !== NAME)
-  }
-  const plugins = args
-  return await pluginsInstall({
-    logger,
-    cwd,
-    isClean,
-    isDryRun,
-    isCompatibleEnabled,
-    dev: true,
-    plugins
-  })
-}
+import { clone as adaptClone } from '../integration/AdaptFramework.js'
+import { install as pluginsInstall } from '../integration/PluginManagement.js'
+import { ADAPT_FRAMEWORK } from '../util/constants.js'
+import path from 'path'
+import Project from '../integration/Project.js'
+import gh from 'parse-github-url'
+
+export default async function devinstall (logger, ...args) {
+  const NAME = gh(ADAPT_FRAMEWORK).repo
+  const isInAdapt = new Project().isAdaptDirectory
+  // In adapt folder or download adapt into adapt_framework folder
+  const cwd = isInAdapt
+    ? process.cwd()
+    : path.resolve(NAME)
+  // strip flags
+  const isClean = args.includes('--clean')
+  const isDryRun = args.includes('--dry-run') || args.includes('--check')
+  const isCompatibleEnabled = args.includes('--compatible')
+  args = args.filter(arg => !String(arg).startsWith('--'))
+  // always perform a clone on the adapt directory
+  if (!isInAdapt || args.includes(NAME)) {
+    await adaptClone({ logger, cwd })
+    args = args.filter(arg => arg !== NAME)
+  }
+  const plugins = args
+  return await pluginsInstall({
+    logger,
+    cwd,
+    isClean,
+    isDryRun,
+    isCompatibleEnabled,
+    dev: true,
+    plugins
+  })
+}

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,9 @@
-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 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}`))
+}

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
+  })
+}