adapt-cli 3.0.0 → 3.0.7

package/lib/logger.js

@@ -1,28 +1,28 @@
-import readline from 'readline'
-import chalk from 'chalk'
-
-export default {
-  isLoggingProgress: false,
-  logProgress (...args) {
-    this.isLoggingProgress = true
-    readline.cursorTo(process.stdout, 0)
-    this.write(args.join(' '))
-  },
-  warn (...args) {
-    chalk.yellow(...args)
-  },
-  error (...args) {
-    chalk.red(...args)
-  },
-  log (...args) {
-    if (this.isLoggingProgress) {
-      this.isLoggingProgress = false
-      readline.cursorTo(process.stdout, 0)
-      this.write(args.join(' '))
-      this.write('\n')
-      return
-    }
-    console.log.apply(console, args)
-  },
-  write: process.stdout.write.bind(process.stdout)
-}
+import readline from 'readline'
+import chalk from 'chalk'
+
+export default {
+  isLoggingProgress: false,
+  logProgress (...args) {
+    this.isLoggingProgress = true
+    readline.cursorTo(process.stdout, 0)
+    this.write(args.join(' '))
+  },
+  warn (...args) {
+    chalk.yellow(...args)
+  },
+  error (...args) {
+    chalk.red(...args)
+  },
+  log (...args) {
+    if (this.isLoggingProgress) {
+      this.isLoggingProgress = false
+      readline.cursorTo(process.stdout, 0)
+      this.write(args.join(' '))
+      this.write('\n')
+      return
+    }
+    console.log.apply(console, args)
+  },
+  write: process.stdout.write.bind(process.stdout)
+}

package/lib/util/JSONReadValidate.js

@@ -1,34 +1,34 @@
-import fs from 'fs-extra'
-import JSONLint from 'json-lint'
-
-/**
- * @param {string} filepath
- * @param {function} [done]
- * @returns {Promise}
- */
-export async function readValidateJSON (filepath, done) {
-  try {
-    const data = await fs.readFile(filepath, 'utf8')
-    validateJSON(data, filepath)
-    done?.(null, JSON.parse(data))
-    return JSON.parse(data)
-  } catch (err) {
-    done?.(err.message)
-  }
-}
-
-export function readValidateJSONSync (filepath) {
-  const data = fs.readFileSync(filepath, 'utf-8')
-  validateJSON(data, filepath)
-  return JSON.parse(data)
-}
-
-function validateJSON (jsonData, filepath) {
-  const lint = JSONLint(jsonData)
-  if (!lint.error) return
-  let errorMessage = 'JSON parsing error: ' + lint.error + ', line: ' + lint.line + ', character: ' + lint.character
-  if (filepath) {
-    errorMessage += ', file: \'' + filepath + '\''
-  }
-  throw new Error(errorMessage)
-}
+import fs from 'fs-extra'
+import JSONLint from 'json-lint'
+
+/**
+ * @param {string} filepath
+ * @param {function} [done]
+ * @returns {Promise}
+ */
+export async function readValidateJSON (filepath, done) {
+  try {
+    const data = await fs.readFile(filepath, 'utf8')
+    validateJSON(data, filepath)
+    done?.(null, JSON.parse(data))
+    return JSON.parse(data)
+  } catch (err) {
+    done?.(err.message)
+  }
+}
+
+export function readValidateJSONSync (filepath) {
+  const data = fs.readFileSync(filepath, 'utf-8')
+  validateJSON(data, filepath)
+  return JSON.parse(data)
+}
+
+function validateJSON (jsonData, filepath) {
+  const lint = JSONLint(jsonData)
+  if (!lint.error) return
+  let errorMessage = 'JSON parsing error: ' + lint.error + ', line: ' + lint.line + ', character: ' + lint.character
+  if (filepath) {
+    errorMessage += ', file: \'' + filepath + '\''
+  }
+  throw new Error(errorMessage)
+}

package/lib/util/constants.js

@@ -1,38 +1,38 @@
-import fs from 'fs-extra'
-
-export const ADAPT_ALLOW_PRERELEASE = process.env.ADAPT_ALLOW_PRERELEASE !== 'false'
-
-export const ADAPT_FRAMEWORK = process.env.ADAPT_FRAMEWORK || 'https://github.com/adaptlearning/adapt_framework'
-
-export const ADAPT_COMPONENT = process.env.ADAPT_COMPONENT || 'https://github.com/adaptlearning/adapt-component'
-
-export const ADAPT_QUESTION = process.env.ADAPT_QUESTION || 'https://github.com/adaptlearning/adapt-questionComponent'
-
-export const ADAPT_DEFAULT_USER_AGENT = process.env.ADAPT_DEFAULT_USER_AGENT || 'Mozilla/5.0 (Windows NT 6.1; WOW64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/41.0.2272.118 Safari/537.36'
-
-export const HOME_DIRECTORY = [
-  process.env.HOME,
-  (process.env.HOMEDRIVE + process.env.HOMEPATH),
-  process.env.USERPROFILE,
-  '/tmp',
-  '/temp'
-].filter(fs.existsSync)[0]
-
-/** @type {string} */
-export const PLUGIN_TYPES = [
-  'component',
-  'extension',
-  'menu',
-  'theme'
-]
-
-/** @type {Object} */
-export const PLUGIN_TYPE_FOLDERS = {
-  component: 'components',
-  extension: 'extensions',
-  menu: 'menu',
-  theme: 'theme'
-}
-
-/** @type {string} */
-export const PLUGIN_DEFAULT_TYPE = PLUGIN_TYPES[0]
+import fs from 'fs-extra'
+
+export const ADAPT_ALLOW_PRERELEASE = process.env.ADAPT_ALLOW_PRERELEASE !== 'false'
+
+export const ADAPT_FRAMEWORK = process.env.ADAPT_FRAMEWORK || 'https://github.com/adaptlearning/adapt_framework'
+
+export const ADAPT_COMPONENT = process.env.ADAPT_COMPONENT || 'https://github.com/adaptlearning/adapt-component'
+
+export const ADAPT_QUESTION = process.env.ADAPT_QUESTION || 'https://github.com/adaptlearning/adapt-questionComponent'
+
+export const ADAPT_DEFAULT_USER_AGENT = process.env.ADAPT_DEFAULT_USER_AGENT || 'Mozilla/5.0 (Windows NT 6.1; WOW64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/41.0.2272.118 Safari/537.36'
+
+export const HOME_DIRECTORY = [
+  process.env.HOME,
+  (process.env.HOMEDRIVE + process.env.HOMEPATH),
+  process.env.USERPROFILE,
+  '/tmp',
+  '/temp'
+].filter(fs.existsSync)[0]
+
+/** @type {string} */
+export const PLUGIN_TYPES = [
+  'component',
+  'extension',
+  'menu',
+  'theme'
+]
+
+/** @type {Object} */
+export const PLUGIN_TYPE_FOLDERS = {
+  component: 'components',
+  extension: 'extensions',
+  menu: 'menu',
+  theme: 'theme'
+}
+
+/** @type {string} */
+export const PLUGIN_DEFAULT_TYPE = PLUGIN_TYPES[0]

package/lib/util/createPromptTask.js

@@ -1,7 +1,7 @@
-import inquirer from 'inquirer'
-
-export async function createPromptTask (question) {
-  question = Object.assign({}, { name: 'question' }, question)
-  const confirmation = await inquirer.prompt([question])
-  return confirmation.question
-}
+import inquirer from 'inquirer'
+
+export async function createPromptTask (question) {
+  question = Object.assign({}, { name: 'question' }, question)
+  const confirmation = await inquirer.prompt([question])
+  return confirmation.question
+}

package/lib/util/download.js

@@ -1,45 +1,45 @@
-import chalk from 'chalk'
-import uuid from 'uuid'
-import fs from 'fs-extra'
-import path from 'path'
-import urljoin from 'url-join'
-import fetch from 'download'
-import { HOME_DIRECTORY } from './constants.js'
-import gh from 'parse-github-url'
-
-export default async function download ({
-  repository,
-  branch,
-  tmp,
-  cwd,
-  logger
-} = {}) {
-  if (!branch && !repository) throw new Error('Repository details are required.')
-  const repositoryName = gh(repository).name
-  logger?.write(chalk.cyan(`downloading ${repositoryName} to ${cwd}\t`))
-  tmp = (tmp || path.join(HOME_DIRECTORY, '.adapt', 'tmp', uuid.v1()))
-  const downloadFileName = await new Promise((resolve, reject) => {
-    let downloadFileName = ''
-    const url = urljoin(repository, 'archive', branch + '.zip')
-    fetch(url, tmp, {
-      extract: true
-    })
-      .on('response', response => {
-        const disposition = response.headers['content-disposition']
-        if (disposition?.indexOf('attachment') === -1) return
-        const regex = /filename[^;=\n]*=((['"]).*?\2|[^;\n]*)/
-        const matches = regex.exec(disposition)
-        if (!matches?.[1]) return
-        downloadFileName = matches[1].replace(/['"]/g, '')
-      })
-      .on('error', reject)
-      .then(() => resolve(downloadFileName))
-  })
-  const sourceFileName = downloadFileName
-    ? path.parse(downloadFileName).name
-    : `${repositoryName}-${branch}`
-  const sourcePath = path.join(tmp, sourceFileName)
-  await fs.copy(sourcePath, cwd)
-  await fs.rm(tmp, { recursive: true })
-  logger?.log(' ', 'done!')
-}
+import chalk from 'chalk'
+import { v4 as uuid } from 'uuid'
+import fs from 'fs-extra'
+import path from 'path'
+import urljoin from 'url-join'
+import fetch from 'download'
+import { HOME_DIRECTORY } from './constants.js'
+import gh from 'parse-github-url'
+
+export default async function download ({
+  repository,
+  branch,
+  tmp,
+  cwd,
+  logger
+} = {}) {
+  if (!branch && !repository) throw new Error('Repository details are required.')
+  const repositoryName = gh(repository).name
+  logger?.write(chalk.cyan(`downloading ${repositoryName} to ${cwd}\t`))
+  tmp = (tmp || path.join(HOME_DIRECTORY, '.adapt', 'tmp', uuid()))
+  const downloadFileName = await new Promise((resolve, reject) => {
+    let downloadFileName = ''
+    const url = urljoin(repository, 'archive', branch + '.zip')
+    fetch(url, tmp, {
+      extract: true
+    })
+      .on('response', response => {
+        const disposition = response.headers['content-disposition']
+        if (disposition?.indexOf('attachment') === -1) return
+        const regex = /filename[^;=\n]*=((['"]).*?\2|[^;\n]*)/
+        const matches = regex.exec(disposition)
+        if (!matches?.[1]) return
+        downloadFileName = matches[1].replace(/['"]/g, '')
+      })
+      .on('error', reject)
+      .then(() => resolve(downloadFileName))
+  })
+  const sourceFileName = downloadFileName
+    ? path.parse(downloadFileName).name
+    : `${repositoryName}-${branch}`
+  const sourcePath = path.join(tmp, sourceFileName)
+  await fs.copy(sourcePath, cwd)
+  await fs.rm(tmp, { recursive: true })
+  logger?.log(' ', 'done!')
+}

package/lib/util/errors.js

@@ -1,58 +1,58 @@
-export default {
-  ERROR_COURSE_DIR: {
-    code: 0,
-    message: 'Commands must be run in an Adapt project directory'
-  },
-  ERROR_INCOMPATIBLE_VALID_REQUEST: {
-    code: 1,
-    message: 'No compatible version exists (requested version is valid)'
-  },
-  ERROR_INCOMPATIBLE_BAD_REQUEST: {
-    code: 2,
-    message: 'No compatible version exists (requested version is invalid)'
-  },
-  ERROR_INCOMPATIBLE: {
-    code: 3,
-    message: 'No compatible version exists'
-  },
-  ERROR_COMPATIBLE_INC_REQUEST: {
-    code: 4,
-    message: 'Incompatible version requested (compatible version exists)'
-  },
-  ERROR_COMPATIBLE_BAD_REQUEST: {
-    code: 5,
-    message: 'Requested version is invalid'
-  },
-  ERROR_UNINSTALL: {
-    code: 6,
-    message: 'The plugin could not be uninstalled'
-  },
-  ERROR_NOT_FOUND: {
-    code: 7,
-    message: 'The plugin could not be found'
-  },
-  ERROR_NOTHING_TO_UPDATE: {
-    code: 8,
-    message: 'Could not resolve any plugins to update'
-  },
-  ERROR_UPDATE_INCOMPATIBLE: {
-    code: 9,
-    message: 'Incompatible update requested'
-  },
-  ERROR_INSTALL_ERROR: {
-    code: 10,
-    message: 'Unknown installation error'
-  },
-  ERROR_UPDATE_ERROR: {
-    code: 11,
-    message: 'Unknown update error'
-  },
-  ERROR_NO_RELEASES: {
-    code: 12,
-    message: 'No published releases'
-  },
-  ERROR_NO_UPDATE: {
-    code: 13,
-    message: 'No update available'
-  }
-}
+export default {
+  ERROR_COURSE_DIR: {
+    code: 0,
+    message: 'Commands must be run in an Adapt project directory'
+  },
+  ERROR_INCOMPATIBLE_VALID_REQUEST: {
+    code: 1,
+    message: 'No compatible version exists (requested version is valid)'
+  },
+  ERROR_INCOMPATIBLE_BAD_REQUEST: {
+    code: 2,
+    message: 'No compatible version exists (requested version is invalid)'
+  },
+  ERROR_INCOMPATIBLE: {
+    code: 3,
+    message: 'No compatible version exists'
+  },
+  ERROR_COMPATIBLE_INC_REQUEST: {
+    code: 4,
+    message: 'Incompatible version requested (compatible version exists)'
+  },
+  ERROR_COMPATIBLE_BAD_REQUEST: {
+    code: 5,
+    message: 'Requested version is invalid'
+  },
+  ERROR_UNINSTALL: {
+    code: 6,
+    message: 'The plugin could not be uninstalled'
+  },
+  ERROR_NOT_FOUND: {
+    code: 7,
+    message: 'The plugin could not be found'
+  },
+  ERROR_NOTHING_TO_UPDATE: {
+    code: 8,
+    message: 'Could not resolve any plugins to update'
+  },
+  ERROR_UPDATE_INCOMPATIBLE: {
+    code: 9,
+    message: 'Incompatible update requested'
+  },
+  ERROR_INSTALL_ERROR: {
+    code: 10,
+    message: 'Unknown installation error'
+  },
+  ERROR_UPDATE_ERROR: {
+    code: 11,
+    message: 'Unknown update error'
+  },
+  ERROR_NO_RELEASES: {
+    code: 12,
+    message: 'No published releases'
+  },
+  ERROR_NO_UPDATE: {
+    code: 13,
+    message: 'No update available'
+  }
+}

package/lib/util/extract.js

@@ -1,24 +1,24 @@
-import uuid from 'uuid'
-import path from 'path'
-import decompress from 'decompress'
-import { HOME_DIRECTORY } from './constants.js'
-
-export default async function extract ({
-  sourcePath,
-  cwd
-} = {}) {
-  const rootPath = path.join(HOME_DIRECTORY, '.adapt', 'tmp', uuid.v1()).replace(/\\/g, '/')
-  const files = await decompress(path.join(cwd, sourcePath), rootPath, {
-    filter: file => !file.path.endsWith('/')
-  })
-  const rootDirectories = Object.keys(files.reduce((memo, file) => { memo[file.path.split(/\\|\//g)[0]] = true; return memo }, {}))
-  let copyPath = rootPath
-  if (rootDirectories.length === 1) {
-    const rootDirectory = files[0].path.split(/\\|\//g)[0]
-    copyPath = path.join(rootPath, rootDirectory)
-  }
-  return {
-    rootPath,
-    copyPath
-  }
-}
+import { v4 as uuid } from 'uuid'
+import path from 'path'
+import decompress from 'decompress'
+import { HOME_DIRECTORY } from './constants.js'
+
+export default async function extract ({
+  sourcePath,
+  cwd
+} = {}) {
+  const rootPath = path.join(HOME_DIRECTORY, '.adapt', 'tmp', uuid()).replace(/\\/g, '/')
+  const files = await decompress(path.join(cwd, sourcePath), rootPath, {
+    filter: file => !file.path.endsWith('/')
+  })
+  const rootDirectories = Object.keys(files.reduce((memo, file) => { memo[file.path.split(/\\|\//g)[0]] = true; return memo }, {}))
+  let copyPath = rootPath
+  if (rootDirectories.length === 1) {
+    const rootDirectory = files[0].path.split(/\\|\//g)[0]
+    copyPath = path.join(rootPath, rootDirectory)
+  }
+  return {
+    rootPath,
+    copyPath
+  }
+}

package/lib/util/getDirNameFromImportMeta.js

@@ -1,6 +1,6 @@
-export default function getDirNameFromImportMeta (importMeta) {
-  const __dirname = (process.platform === 'win32')
-    ? new URL('.', importMeta.url).pathname.slice(1)
-    : new URL('.', import.meta.url).pathname
-  return __dirname
-}
+export default function getDirNameFromImportMeta (importMeta) {
+  const __dirname = (process.platform === 'win32')
+    ? new URL('.', importMeta.url).pathname.slice(1)
+    : new URL('.', import.meta.url).pathname
+  return __dirname
+}

package/lib/util/promises.js

@@ -1,36 +1,36 @@
-import { eachOfLimit, eachOfSeries } from 'async'
-/**
- * Execute all promises in parallel, call progress at each promise to allow
- * progress reporting
- * @param {Array} array
- * @param {function} iterator
- * @param {function} progress
- * @returns
- */
-export async function eachOfLimitProgress (array, iterator, progress) {
-  let currentIndex = 0
-  progress(0)
-  await eachOfLimit(array, 8, async item => {
-    currentIndex++
-    progress(parseInt((currentIndex * 100) / array.length))
-    return iterator(item)
-  })
-}
-
-/**
- * Execute iterator against each item in the array waiting for the iterator returned
- * to finish before continuing, calling progress as each stage
- * @param {Array} array
- * @param {function} iterator
- * @param {function} progress
- * @returns
- */
-export async function eachOfSeriesProgress (array, iterator, progress) {
-  let currentIndex = 0
-  progress(0)
-  await eachOfSeries(array, async item => {
-    currentIndex++
-    progress(parseInt((currentIndex * 100) / array.length))
-    return iterator(item)
-  })
-}
+import { eachOfLimit, eachOfSeries } from 'async'
+/**
+ * Execute all promises in parallel, call progress at each promise to allow
+ * progress reporting
+ * @param {Array} array
+ * @param {function} iterator
+ * @param {function} progress
+ * @returns
+ */
+export async function eachOfLimitProgress (array, iterator, progress) {
+  let currentIndex = 0
+  progress(0)
+  await eachOfLimit(array, 8, async item => {
+    currentIndex++
+    progress(parseInt((currentIndex * 100) / array.length))
+    return iterator(item)
+  })
+}
+
+/**
+ * Execute iterator against each item in the array waiting for the iterator returned
+ * to finish before continuing, calling progress as each stage
+ * @param {Array} array
+ * @param {function} iterator
+ * @param {function} progress
+ * @returns
+ */
+export async function eachOfSeriesProgress (array, iterator, progress) {
+  let currentIndex = 0
+  progress(0)
+  await eachOfSeries(array, async item => {
+    currentIndex++
+    progress(parseInt((currentIndex * 100) / array.length))
+    return iterator(item)
+  })
+}