adapt-cli 2.1.11 → 3.0.0

package/lib/integration/getBowerRegistryConfig.js

@@ -0,0 +1,34 @@
+import fs from 'fs-extra'
+import { findUpSync } from 'find-up'
+
+export default function getBowerRegistryConfig ({ cwd = process.cwd() } = {}) {
+  function getConfig () {
+    if (process.env.ADAPT_REGISTRY) {
+      return process.env.ADAPT_REGISTRY
+    }
+    const configPath = findUpSync('.bowerrc', { cwd })
+    if (configPath) {
+      // a manifest exists, load it
+      const config = fs.readJSONSync(configPath)
+      return config.registry
+    }
+    // use the default Adapt registry
+    return 'http://adapt-bower-repository.herokuapp.com/'
+  }
+  // normalize to https://github.com/bower/spec/blob/master/config.md
+  const config = getConfig()
+  let normalized = {}
+  switch (typeof config) {
+    case 'string':
+      normalized = {
+        register: config,
+        search: [config]
+      }
+      break
+    case 'object':
+      Object.assign(normalized, config)
+      break
+  }
+  if (typeof normalized.search === 'string') normalized.search = [normalized.search].filter(Boolean)
+  return normalized
+}

package/lib/logger.js

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

package/lib/util/JSONReadValidate.js

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

package/lib/util/constants.js

@@ -0,0 +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]

package/lib/util/createPromptTask.js

@@ -0,0 +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
+}

package/lib/util/download.js

@@ -0,0 +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!')
+}

package/lib/util/errors.js

@@ -0,0 +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'
+  }
+}

package/lib/util/extract.js

@@ -0,0 +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
+  }
+}

package/lib/util/getDirNameFromImportMeta.js

@@ -0,0 +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
+}

package/lib/util/promises.js

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

package/package.json

@@ -1,49 +1,40 @@
-{
-  "name": "adapt-cli",
-  "version": "2.1.11",
-  "description": "Command line tools for Adapt",
-  "main": "./lib/cli.js",
-  "directories": {
-    "test": "test"
-  },
-  "dependencies": {
-    "async": "^3.1.0",
-    "bower": "^1.8.4",
-    "bower-endpoint-parser": "^0.2.2",
-    "chalk": "^2.4.1",
-    "debug": "^4.1.0",
-    "download": "^7.1.0",
-    "grunt": "^1.0.3",
-    "json-lint": "^0.1.0",
-    "lodash": "^4.17.11",
-    "mkdirp": "^0.5.1",
-    "npm": "^6.4.1",
-    "prompt": "^1.0.0",
-    "q": "^1.5.1",
-    "q-io": "^1.13.6",
-    "request": "^2.88.0",
-    "semver": "^5.6.0",
-    "speakingurl": "^14.0.1",
-    "url-join": "^4.0.0",
-    "uuid": "^3.3.2"
-  },
-  "devDependencies": {
-    "expect.js": "^0.3.1",
-    "grunt-mocha-test": "^0.13.3",
-    "matchdep": "^2.0.0",
-    "mocha": "^5.2.0",
-    "mockery": "^2.1.0",
-    "rimraf": "^2.6.2",
-    "sinon": "^7.1.0"
-  },
-  "scripts": {
-    "test": "grunt test"
-  },
-  "author": "",
-  "repository": "http://github.com/adaptlearning/adapt-cli",
-  "license": "GPL-3.0",
-  "preferGlobal": true,
-  "bin": {
-    "adapt": "./bin/adapt"
-  }
-}
+{
+  "name": "adapt-cli",
+  "version": "3.0.0",
+  "description": "Command line tools for Adapt",
+  "main": "./lib/api.js",
+  "type": "module",
+  "dependencies": {
+    "async": "^3.2.3",
+    "bower": "^1.8.13",
+    "bower-endpoint-parser": "^0.2.2",
+    "chalk": "^2.4.1",
+    "decompress": "^4.2.1",
+    "download": "^7.1.0",
+    "find-up": "^6.2.0",
+    "fs-extra": "^10.0.0",
+    "globs": "^0.1.4",
+    "inquirer": "^7.3.3",
+    "json-lint": "^0.1.0",
+    "lodash-es": "^4.17.21",
+    "parse-github-url": "^1.0.2",
+    "request": "^2.88.0",
+    "semver": "^7.3.5",
+    "speakingurl": "^14.0.1",
+    "url-join": "^4.0.0",
+    "uuid": "^3.3.2"
+  },
+  "repository": "http://github.com/adaptlearning/adapt-cli",
+  "license": "GPL-3.0",
+  "preferGlobal": true,
+  "bin": {
+    "adapt": "./bin/adapt.js"
+  },
+  "devDependencies": {
+    "eslint": "^7.31.0",
+    "eslint-config-standard": "^16.0.3",
+    "eslint-plugin-import": "^2.23.4",
+    "eslint-plugin-node": "^11.1.0",
+    "eslint-plugin-promise": "^5.1.0"
+  }
+}

package/TESTING.md

@@ -1,25 +0,0 @@
-### Instructions for testing the adapt-cli update command
-
-- Use the current LTS version of Node (v8.11.1) as per the [guidance](https://github.com/adaptlearning/adapt_framework/wiki/Setting-up-your-development-environment). Don’t forget to have `grunt` installed globally (`npm install –g grunt-cli`) when you install a new version of Node.
-- Install globally the latest pre-release of adapt-cli (`npm install -g adapt-cli@next`)
-- Select an Adapt project to test against. At this point you may find it useful to add the contents of the Adapt installation to version control if you haven't already. This will allow you test the functionality and be able to see easily any changes made to the file system and also be able to revert changes and test alternative commands.
-- Run `adapt help update` for guidance using the `update` command and for command syntax.
-- Now run `adapt update`. If you installed the latest version of the framework together with all the latest plugins there should not have been any changes to the installed plugins and you will see a summary of your installed plugins.
-- You can add the `--check` option to review installed plugins without making changes. For each plugin the output will give its name, the version installed and indicate whether the plugin can be updated.
-- The update can be limited to specific plugins by providing their names, or to specific groups of plugins by specifying one or more of `components`, `extensions`, `menu`, `theme`.
-- Attempt to install different versions of various plugins; e.g. `adapt update adapt-contrib-media@>=3`. Observe the changes (if any).
-- Explore different scenarios; for example updating multiple plugins or groups of plugins together, try different semver ranges and also try the above with older versions of the Adapt framework.
-
-### Important Notes
-
-The outcome of an `update` command ensures that all updated plugins reflect the requested versions held on the server. As such **any local changes will be overwritten**.
-
-The `update` command does **not** use or modify the Adapt manifest (`adapt.json`).
-
-Occasionally the command may report that one or more plugins cannot be found at the repository. This is a known limitation. The command will attempt to query the repository mulitple times before giving up. The issue is usually resolved by running the command again.
-
-### Issue logging
-
-Log issues to the adapt-cli [issue list](https://github.com/adaptlearning/adapt-cli/issues) on GitHub. Please check the list before submission to see if the issue has already been reported.
-
-As always please report any problems with full steps to reproduce; including what version of Adapt you are using, list of plugins being updated (giving current and target version numbers), the `update` command, the environment (platform, version of Node etc) and of course the error (with stack trace if available).

package/bin/adapt

@@ -1,3 +0,0 @@
-#!/usr/bin/env node
-var cli = require('../lib/cli');
-cli.withOptions().withPackage().execute();

package/gruntfile.js

@@ -1,18 +0,0 @@
-module.exports = function(grunt) {
-    require('matchdep').filterDev('grunt-*').forEach(grunt.loadNpmTasks);
-
-	grunt.initConfig({
-		pkg: grunt.file.readJSON('package.json'),
-		mochaTest: {
-            test: {
-                options: {
-                    reporter: 'spec'
-                },
-                src: ['test/specs/**/*.js']
-            }
-        }
-	});
-	
-    grunt.registerTask('default', ['mochaTest']);
-    grunt.registerTask('test', ['mochaTest']);
-};

package/lib/AdaptConsoleApplication.js

@@ -1,19 +0,0 @@
-var AdaptConsoleApplication = function (commands, renderer) {
-    this.renderer = renderer || require('./ConsoleRenderer');
-    this.commands = commands;
-};
-
-AdaptConsoleApplication.prototype.do = function (command, done) {
-    done =  done || function () {};
-
-    if(!this.commands.hasOwnProperty(command.name)) {
-        var e = new Error('Unknown command "' + command.name + '", please check the documentation.');
-        this.renderer.log(e.message);
-        done(e);
-    }
-
-    var commandArguments = [this.renderer].concat(command.parameters).concat([done]);
-    this.commands[command.name].apply(this.commands, commandArguments);
-};
-
-module.exports = AdaptConsoleApplication;

package/lib/CommandParser.js

@@ -1,19 +0,0 @@
-
-var delimiter = ',',
-    CommandTranslator = require('./CommandTranslator'),
-    CommandParser = function (argv) {
-        argv = argv || ['node', 'path'];
-        this.parameters = CommandTranslator(argv.slice(2));
-        if(this.parameters.length) {
-            this.name = String.prototype.toLowerCase.call(this.parameters.shift());
-        }
-    };
-
-CommandParser.prototype.param = function (index) {
-    if(index >= this.parameters.length)
-        return undefined;
-
-    return this.parameters[index];
-};
-
-module.exports = CommandParser;

package/lib/CommandTranslator.js

@@ -1,15 +0,0 @@
-var _ = require('lodash'),
-    translationTable = [
-        { pattern: /^-v$|^--version$/i, replacement: 'version' }
-    ],
-    CommandTranslator = function (parameters) {
-        parameters = Array.isArray(parameters) ? parameters : [parameters];
-        return parameters.map(function (param) {
-            var translation = _.find(translationTable, function (item) {
-                return item.pattern.test(param);
-            });
-            return translation ? translation.replacement : param;
-        });
-    };
-
-module.exports = CommandTranslator;

package/lib/ConsoleRenderer.js

@@ -1,10 +0,0 @@
-var chalk = require('chalk');
-
-module.exports = {
-	log: function () {
-		console.log.apply(this, arguments);
-	},
-    error: function () {
-        console.error.apply(this, arguments);
-    }
-};

package/lib/Constants.js

@@ -1,69 +0,0 @@
-var bower = require('bower'),
-    fs = require('fs'),
-    path = require('path');
-
-module.exports = {
-    ManifestFilename: 'adapt.json',
-    FrameworkFilename: 'package.json',
-    DefaultProjectManifestPath: './adapt.json',
-    DefaultProjectFrameworkPath: './package.json',
-    DefaultCreateType : 'course',
-    DefaultTypeNames : {
-        'course':'my-adapt-course',
-        'component':'my-adapt-component'
-    },
-    DefaultUserAgent: 'Mozilla/5.0 (Windows NT 6.1; WOW64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/41.0.2272.118 Safari/537.36',
-    DefaultGitHubOrg: 'adaptlearning',
-    FrameworkRepository : process.env.ADAPT_FRAMEWORK || 'https://github.com/adaptlearning/adapt_framework',
-    FrameworkRepositoryName : 'adapt_framework',
-    ComponentRepository : process.env.ADAPT_COMPONENT || 'https://github.com/adaptlearning/adapt-component',
-    ComponentRepositoryName : 'adapt-component',
-    DefaultBranch : process.env.ADAPT_BRANCH || 'master',
-    HomeDirectory : searchForHome(),
-    getRegistry:getRegistry,
-    setCwd: setCwd,
-    cwd: '.'
-};
-
-var registry = null;
-
-function searchForHome() {
-    var locations = [
-            process.env.HOME,
-            (process.env.HOMEDRIVE + process.env.HOMEPATH),
-            process.env.USERPROFILE,
-            '/tmp',
-            '/temp',
-        ];
-    var validLocations =  locations.filter(fs.existsSync);
-    return validLocations[0];
-}
-
-function getRegistry() {
-    if (registry !== null) {
-        return registry;
-    }
-
-    if (process.env.ADAPT_REGISTRY) {
-        registry = process.env.ADAPT_REGISTRY;
-
-    } else if (fs.existsSync(path.join(this.cwd, './.bowerrc'))) {
-        // a manifest exists; let bower determine the registry
-        registry = undefined;
-        
-    } else {
-        // use the default Adapt registry
-        registry = 'http://adapt-bower-repository.herokuapp.com/';
-    }
-
-    return registry;
-}
-
-function setCwd(cwd) {
-    if (!cwd) return;
-
-    this.cwd = cwd;
-
-    this.DefaultProjectManifestPath = path.join(this.cwd, this.ManifestFilename);
-    this.DefaultProjectFrameworkPath = path.join(this.cwd, this.FrameworkFilename);
-}

package/lib/JsonLoader.js

@@ -1,40 +0,0 @@
-var fs = require('fs'),
-    JSONLint = require('json-lint');
-
-module.exports = {
-    existsSync: fs.existsSync,
-
-    exists: fs.exists,
-
-    readJSON: function (filepath, done) {
-        done = done || function () {};
-
-        fs.readFile(filepath, 'utf8', function (err, data) {
-            if(err) return done(err);
-
-            try {
-                validateJSON(data, filepath);
-                done(null, JSON.parse(data));
-            } catch (ex) {
-                done(ex.message);
-            }
-        });
-    },
-
-    readJSONSync: function (filepath) {
-        var data = fs.readFileSync(filepath, 'utf-8');
-        validateJSON(data, filepath);
-        return JSON.parse(data);
-    }
-};
-
-function validateJSON(jsonData, filepath) {
-    var lint = JSONLint(jsonData);
-    if (lint.error) {
-        var errorMessage = 'JSON parsing error: ' + lint.error + ', line: ' + lint.line + ', character: ' + lint.character;
-        if(filepath) {
-            errorMessage += ', file: \'' + filepath + '\'';
-        }
-        throw new Error(errorMessage);
-    }
-}

package/lib/JsonWriter.js

@@ -1,21 +0,0 @@
-var fs = require('fs');
-
-module.exports = {
-    existsSync: fs.existsSync,
-
-    exists: fs.exists,
-
-    writeJSON: function (filepath, values, done) {
-        done = done || function () {};
-
-        fs.writeFile(filepath, JSON.stringify(values, null, 4), { encoding: 'utf8' }, function (err) {
-            if(err) return done(err);
-
-            done();
-        });
-    },
-
-    writeJSONSync: function (filepath, values) {
-        return fs.writeFileSync(filepath, JSON.stringify(values, null, 4), { encoding: 'utf8' });
-    }
-}