adapt-cli 3.0.2 → 3.0.6

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/integration/AdaptFramework/build.js

@@ -1,42 +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 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()
-    })
-  })
-}
+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 })
+  }
+}

package/lib/integration/AdaptFramework/getLatestVersion.js

@@ -1,79 +1,79 @@
-import request from 'request'
-import semver from 'semver'
-import gh from 'parse-github-url'
-import { ADAPT_DEFAULT_USER_AGENT, ADAPT_FRAMEWORK, ADAPT_ALLOW_PRERELEASE } from '../../util/constants.js'
-const semverOptions = { includePrerelease: ADAPT_ALLOW_PRERELEASE }
-
-export default async function getLatestVersion ({ versionLimit, repository = ADAPT_FRAMEWORK }) {
-  repository = repository.replace(/\.git/g, '')
-  const OWNER = gh(repository).owner
-  const NAME = gh(repository).name
-  // used in pagination
-  let nextPage = `https://api.github.com/repos/${OWNER}/${NAME}/releases`
-  // taken from https://gist.github.com/niallo/3109252
-  const parseLinkHeader = header => {
-    if (!header || header.length === 0) {
-      return []
-    }
-    const links = {}
-    // Parse each part into a named link
-    header.split(',').forEach(p => {
-      const section = p.split(';')
-      if (section.length !== 2) {
-        throw new Error("section could not be split on ';'")
-      }
-      const url = section[0].replace(/<(.*)>/, '$1').trim()
-      const name = section[1].replace(/rel="(.*)"/, '$1').trim()
-      links[name] = url
-    })
-    return links
-  }
-  const processPage = async () => {
-    const [response, body] = await new Promise((resolve, reject) => {
-      request({
-        headers: {
-          'User-Agent': ADAPT_DEFAULT_USER_AGENT
-        },
-        uri: nextPage,
-        method: 'GET'
-      }, (error, response, body) => {
-        if (error) return reject(error)
-        resolve([response, body])
-      })
-    })
-    if (response?.statusCode === 403 && response?.headers['x-ratelimit-remaining'] === '0') {
-      // we've exceeded the API limit
-      const reqsReset = new Date(response.headers['x-ratelimit-reset'] * 1000)
-      throw new Error(`Couldn't check latest version of ${NAME}. You have exceeded GitHub's request limit of ${response.headers['x-ratelimit-limit']} requests per hour. Please wait until at least ${reqsReset.toTimeString()} before trying again.`)
-    }
-    if (response?.statusCode !== 200) {
-      throw new Error(`Couldn't check latest version of ${NAME}. GitubAPI did not respond with a 200 status code.`)
-    }
-    nextPage = parseLinkHeader(response.headers.link).next
-    let releases
-    try {
-      // parse and sort releases (newest first)
-      releases = JSON.parse(body).sort((a, b) => {
-        if (semver.lt(a.tag_name, b.tag_name, semverOptions)) return 1
-        if (semver.gt(a.tag_name, b.tag_name, semverOptions)) return -1
-        return 0
-      })
-    } catch (e) {
-      throw new Error(`Failed to parse GitHub release data\n${e}`)
-    }
-    const compatibleRelease = releases.find(release => {
-      const isFullRelease = !release.draft && !release.prerelease
-      const satisfiesVersion = !versionLimit || semver.satisfies(release.tag_name, versionLimit, semverOptions)
-      if (!isFullRelease || !satisfiesVersion) return false
-      return true
-    })
-    if (!compatibleRelease && nextPage) {
-      return await processPage()
-    }
-    if (!compatibleRelease) {
-      throw new Error(`Couldn't find any releases compatible with specified framework version (${versionLimit}), please check that it is a valid version.`)
-    }
-    return compatibleRelease.tag_name
-  }
-  return await processPage()
-}
+import request from 'request'
+import semver from 'semver'
+import gh from 'parse-github-url'
+import { ADAPT_DEFAULT_USER_AGENT, ADAPT_FRAMEWORK, ADAPT_ALLOW_PRERELEASE } from '../../util/constants.js'
+const semverOptions = { includePrerelease: ADAPT_ALLOW_PRERELEASE }
+
+export default async function getLatestVersion ({ versionLimit, repository = ADAPT_FRAMEWORK }) {
+  repository = repository.replace(/\.git/g, '')
+  const OWNER = gh(repository).owner
+  const NAME = gh(repository).name
+  // used in pagination
+  let nextPage = `https://api.github.com/repos/${OWNER}/${NAME}/releases`
+  // taken from https://gist.github.com/niallo/3109252
+  const parseLinkHeader = header => {
+    if (!header || header.length === 0) {
+      return []
+    }
+    const links = {}
+    // Parse each part into a named link
+    header.split(',').forEach(p => {
+      const section = p.split(';')
+      if (section.length !== 2) {
+        throw new Error("section could not be split on ';'")
+      }
+      const url = section[0].replace(/<(.*)>/, '$1').trim()
+      const name = section[1].replace(/rel="(.*)"/, '$1').trim()
+      links[name] = url
+    })
+    return links
+  }
+  const processPage = async () => {
+    const [response, body] = await new Promise((resolve, reject) => {
+      request({
+        headers: {
+          'User-Agent': ADAPT_DEFAULT_USER_AGENT
+        },
+        uri: nextPage,
+        method: 'GET'
+      }, (error, response, body) => {
+        if (error) return reject(error)
+        resolve([response, body])
+      })
+    })
+    if (response?.statusCode === 403 && response?.headers['x-ratelimit-remaining'] === '0') {
+      // we've exceeded the API limit
+      const reqsReset = new Date(response.headers['x-ratelimit-reset'] * 1000)
+      throw new Error(`Couldn't check latest version of ${NAME}. You have exceeded GitHub's request limit of ${response.headers['x-ratelimit-limit']} requests per hour. Please wait until at least ${reqsReset.toTimeString()} before trying again.`)
+    }
+    if (response?.statusCode !== 200) {
+      throw new Error(`Couldn't check latest version of ${NAME}. GitubAPI did not respond with a 200 status code.`)
+    }
+    nextPage = parseLinkHeader(response.headers.link).next
+    let releases
+    try {
+      // parse and sort releases (newest first)
+      releases = JSON.parse(body).sort((a, b) => {
+        if (semver.lt(a.tag_name, b.tag_name, semverOptions)) return 1
+        if (semver.gt(a.tag_name, b.tag_name, semverOptions)) return -1
+        return 0
+      })
+    } catch (e) {
+      throw new Error(`Failed to parse GitHub release data\n${e}`)
+    }
+    const compatibleRelease = releases.find(release => {
+      const isFullRelease = !release.draft && !release.prerelease
+      const satisfiesVersion = !versionLimit || semver.satisfies(release.tag_name, versionLimit, semverOptions)
+      if (!isFullRelease || !satisfiesVersion) return false
+      return true
+    })
+    if (!compatibleRelease && nextPage) {
+      return await processPage()
+    }
+    if (!compatibleRelease) {
+      throw new Error(`Couldn't find any releases compatible with specified framework version (${versionLimit}), please check that it is a valid version.`)
+    }
+    return compatibleRelease.tag_name
+  }
+  return await processPage()
+}

package/lib/integration/AdaptFramework/npmInstall.js

@@ -1,21 +1,21 @@
-import chalk from 'chalk'
-import { spawn } from 'child_process'
-import path from 'path'
-
-export default async function npmInstall ({
-  logger,
-  cwd
-} = {}) {
-  cwd = path.resolve(process.cwd(), cwd)
-  await new Promise((resolve, reject) => {
-    logger?.log(chalk.cyan('installing node dependencies'))
-    const npm = spawn((process.platform === 'win32' ? 'npm.cmd' : 'npm'), ['--unsafe-perm', 'install'], {
-      stdio: 'inherit',
-      cwd
-    })
-    npm.on('close', code => {
-      if (code) return reject(new Error('npm install failed'))
-      resolve()
-    })
-  })
-}
+import chalk from 'chalk'
+import { spawn } from 'child_process'
+import path from 'path'
+
+export default async function npmInstall ({
+  logger,
+  cwd
+} = {}) {
+  cwd = path.resolve(process.cwd(), cwd)
+  await new Promise((resolve, reject) => {
+    logger?.log(chalk.cyan('installing node dependencies'))
+    const npm = spawn((process.platform === 'win32' ? 'npm.cmd' : 'npm'), ['--unsafe-perm', 'install'], {
+      stdio: 'inherit',
+      cwd
+    })
+    npm.on('close', code => {
+      if (code) return reject(new Error('npm install failed'))
+      resolve()
+    })
+  })
+}