adapt-cli 2.1.13 → 3.0.6

package/lib/commands/ls.js

@@ -1,24 +1,9 @@
-module.exports = function (dependencies) {
-
-    var chalk = dependencies.chalk || require('chalk'),
-        Project = dependencies.Project || require('../Project'),
-        Constants = dependencies.Constants || require('../Constants'),
-        RendererHelpers = dependencies.RendererHelpers || require('../RendererHelpers');
-
-    return {
-        ls: function(renderer) {
-            var project = new Project(Constants.DefaultProjectManifestPath),
-                done = arguments[arguments.length -1];
-
-            if(project.isProjectContainsManifestFile()) {
-                project.plugins.forEach(function (p) {
-                    renderer.log(chalk.cyan(p.name), p.version);
-                });
-                done();
-            } else {
-                RendererHelpers.reportInvalidFrameworkDirectory(renderer, done)(true);
-            }
-        }
-    };
-
-};
+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,196 +1,11 @@
-var bower = require('bower'),
-    chalk = require('chalk'),
-    inquirer = require('inquirer'),
-    path = require('path'),
-    _ = require('lodash'),
-    Q = require('q'),
-    Constants = require('../Constants'),
-    JsonLoader = require('../JsonLoader'),
-    JsonWriter = require('../JsonWriter'),
-    Project = require('../Project'),
-    Plugin = require('../Plugin'),
-    semver = require('semver');
-
-module.exports = {
-    register: function (renderer) {
-        var done = arguments[arguments.length-1] || function () {};
-
-        //renderer.log(chalk.yellow('This will publish this plugin to', Constants.Registry));
-
-        loadPluginProperties('./bower.json', {
-            name: undefined,
-            repository: undefined,
-            framework: undefined
-        })
-        .then(confirm)
-        .then(function (properties) {
-            savePluginProperties('./bower.json', properties);
-            return properties;
-        })
-        .then(function (properties) {
-            // given a package name, create two Plugin representations
-            // if supplied name is adapt-contrib-myPackageName do a check against this name only
-            // if suppled name is adapt-myPackageName check against this name and adapt-contrib-myPackageName
-            // becase we don't want to allow adapt-myPackageName if adapt-contrib-myPackageName exists
-            var plugin = new Plugin(properties.name),
-                contribPlugin = new Plugin(properties.name, true),
-                searches = [exists(contribPlugin)];
-
-            if(!plugin.isContrib) {
-                searches.push(exists(plugin));
-            }
-
-            return Q.all(searches)
-                    .spread(function (contribExists, pluginExists) {
-                        if(contribExists) {
-                            return reportExistence(contribPlugin, renderer);
-                        }
-                        if(pluginExists) {
-                            return reportExistence(plugin, renderer);
-                        }
-                        return register(plugin, properties.repository);
-                    });
-        })
-        .then(function (registered) {
-            if(!registered.result) throw new Error('The plugin was unable to register.');
-            renderer.log(chalk.green(registered.plugin.packageName), 'has been registered successfully.');
-            done();
-        })
-        .fail(function (err) {
-            renderer.log(chalk.red(err));
-            done(err);
-        })
-        .done();
-    }
-};
-
-function loadPluginProperties(path, defaults) {
-    var deferred = Q.defer();
-
-    path = path || './bower.json';
-
-    if(!JsonLoader.existsSync(path)) {
-        deferred.reject(new Error('bower.json is not in the current working directory. Plugins must be a valid bower package.'));
-    }
-    JsonLoader.readJSON(path, function (error, data) {
-        if(error) {
-            deferred.reject(new Error(error));
-        } else {
-            deferred.resolve(_.extend({}, defaults, data));
-        }
-    });
-
-    return deferred.promise;
-}
-
-function savePluginProperties(path, values) {
-    var deferred = Q.defer();
-
-    path = path || './bower.json';
-
-    if(!JsonWriter.existsSync(path)) {
-        deferred.reject(new Error('bower.json is not in the current working directory. Plugins must be a valid bower package.'));
-    }
-    JsonWriter.writeJSON(path, values, function () {
-        deferred.resolve(true);
-    });
-
-    return deferred.promise;
-}
-
-function confirm(properties) {
-    var deferred = Q.defer();
-    var plugin = new Plugin(properties.name),
-        schema = [
-            {
-                name: 'name',
-                message: chalk.cyan('name'),
-                validate: v => {
-                    return /^adapt-[\w|-]+?$/.test(v) ||
-                        `Name must prefixed with 'adapt' and each word separated with a hyphen(-)`;
-                },
-                type: 'input',
-                default: plugin.toString() || 'not specified'
-            },
-            {
-                name: 'repositoryUrl',
-                message: chalk.cyan('repository URL'),
-                validate: v => {
-                    return /git:\/\/([\w\.@\:/\-~]+)(\.git)(\/)?/.test(v) ||
-                        'Please provide a repository URL of the form git://<domain><path>.git';
-                },
-                type: 'input',
-                default: properties.repository ? properties.repository.url : undefined
-            },
-            {
-                name: 'framework',
-                message: chalk.cyan('framework'),
-                validate: v => {
-                    return semver.validRange(v) !== null ||
-                        'Please provide a valid semver (see https://semver.org/)';
-                },
-                type: 'input',
-                default: properties.framework || '~2.0.0'
-            },
-            {
-                name: 'ready',
-                message: chalk.cyan('Register now?'),
-                type: 'confirm',
-                default: true
-            }
-        ];
-    inquirer.prompt(schema).then(confirmation => {
-        if(!confirmation.ready) deferred.reject(new Error('Aborted. Nothing has been registered.'));
-
-        properties.name = confirmation.name;
-        properties.repository = {type:'git', url:confirmation.repositoryUrl};
-        properties.framework = confirmation.framework;
-
-        deferred.resolve(properties);
-    }).catch(err => deferred.reject(err));
-    return deferred.promise;
-}
-
-function register(plugin, repository) {
-    var deferred = Q.defer();
-
-    bower.commands.register(plugin.toString(), repository.url || repository, { registry: Constants.getRegistry() })
-    .on('end', function(result) {
-        deferred.resolve({ result: result, plugin: plugin });
-    })
-    .on('error', function (err) {
-        deferred.reject(err);
-    });
-    return deferred.promise;
-}
-
-function exists(plugin) {
-    var deferred = Q.defer();
-
-    bower.commands.search(plugin.toString(),  { registry: Constants.getRegistry() })
-    .on('end', function(result) {
-        var matches = result.filter(exactMatch(plugin.toString()));
-        deferred.resolve(!!matches.length);
-    })
-    .on('error', function (err) {
-        deferred.reject(err);
-    });
-    return deferred.promise;
-}
-
-function exactMatch(pattern) {
-    return function (item) {
-         if (typeof pattern === 'string') {
-            if (pattern.toLowerCase() === item.name.toLowerCase()) {
-                return true;
-            } 
-            return false
-        }
-        var regexp = new RegExp(pattern, 'i');
-        return regexp.test(item.name);
-    };
-}
-
-function reportExistence(plugin, renderer) {
-    renderer.log(chalk.yellow(plugin.toString()), chalk.cyan('has been previously registered. Plugin names must be unique. Try again with a different name.'));
-}
+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,129 +1,14 @@
-var bower = require('bower'),
-    chalk = require('chalk'),
-    inquirer = require('inquirer'),
-    _ = require('lodash'),
-    Q = require('q'),
-    request = require('request'),
-    Constants = require('../Constants'),
-    Plugin = require('../Plugin'),
-    authenticate = require('../promise/authenticate'),
-    log;
-
-module.exports = {
-    rename: function (renderer) {
-        log = renderer.log;
-
-        var done = arguments[arguments.length-1] || function () {};
-        
-        if (arguments.length >= 4) {
-            var params = {
-                oldName:arguments[1],
-                newName:arguments[2]
-            };
-
-            // use Plugin to standardise name
-            params.newName = new Plugin(params.newName).packageName;
-
-            log(chalk.yellow('Using registry at', Constants.getRegistry()));
-            log(chalk.yellow('Plugin will be renamed to', params.newName));
-
-             Q(params)
-            .then(checkPluginNameExists)
-            .then(checkNewPluginNameDoesNotExist)
-            .then(authenticate)
-            .then(confirm)
-            .then(rename)
-            .then(function() {
-                log(chalk.green('The plugin was successfully renamed.'));
-                done();
-            })
-            .catch(function (err) {
-                log(chalk.red(err));
-                log('The plugin was not renamed.');
-                done(err);
-            })
-            .done();
-
-        } else {
-            log(chalk.red('You must call rename with the following arguments: <plugin name> <new plugin name>'));
-            done();
-        }
-    }
-};
-
-function checkPluginNameExists(params) {
-    return exists(params.oldName).then(function(exists) {
-        return exists ? Q.resolve(params) : Q.reject('Plugin "'+params.oldName+'" does not exist');
-    });
-}
-
-function checkNewPluginNameDoesNotExist(params) {
-    return exists(params.newName).then(function(exists) {
-        return exists ? Q.reject('Name "'+params.newName+'" already exists') : Q.resolve(params);
-    });
-}
-
-function confirm(params) {
-    var deferred = Q.defer();
-    var schema = [
-        {
-            name: 'ready',
-            message: chalk.cyan('Confirm rename now?'),
-            type: 'confirm',
-            default: true
-        }
-    ];
-    inquirer.prompt(schema).then(confirmation => {
-        if(!confirmation.ready) deferred.reject(new Error('Aborted. Nothing has been renamed.'));
-        deferred.resolve(params);
-    }).catch(err => deferred.reject(err));
-    return deferred.promise;
-}
-
-function rename(params) {
-    var deferred = Q.defer();
-    var path = 'packages/rename/'+params.username+'/'+params.oldName+'/'+params.newName;
-    var query = '?access_token='+params.token;
-
-    request({
-        url: Constants.getRegistry()+'/'+path+query,
-        method:'GET',
-        headers: {'User-Agent':'adapt-cli'},
-        followRedirect:false
-    }, function(err, res, body) {
-        if (err) {
-            deferred.reject(err);
-        } else {
-            res.statusCode==201 ? deferred.resolve(params) : deferred.reject("The server responded with "+res.statusCode);
-        }
-    });
-
-    return deferred.promise;
-}
-
-function exists(plugin) {
-    var deferred = Q.defer();
-
-    bower.commands.search(plugin.toString(),  { registry: Constants.getRegistry() })
-    .on('end', function(result) {
-        var matches = result.filter(exactMatch(plugin.toString()));
-        deferred.resolve(!!matches.length);
-    })
-    .on('error', function (err) {
-        deferred.reject(err);
-    });
-    return deferred.promise;
-}
-
-function exactMatch(pattern) {
-    return function (item) {
-        if (typeof pattern === 'string') {
-            if (pattern.toLowerCase() === item.name.toLowerCase()) {
-                return true;
-            } 
-            return false
-        }
-        var regexp = new RegExp(pattern, 'i');
-        return regexp.test(item.name);
-    };
-}
+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,29 +1,11 @@
-var bower = require('bower'),
-    chalk = require('chalk'),
-    Constants = require('../Constants'),
-    Plugin = require('../Plugin');
-
-
-module.exports = {
-    search: function(renderer) {
-        var searchTerm = arguments.length >= 3 ? arguments[1] : '',
-            done = arguments[arguments.length -1] || function () {};
-        
-        var plugin = new Plugin(searchTerm);
-
-        bower.commands.search(searchTerm,  { registry: Constants.getRegistry() })
-        .on('end', function(results) {
-            if(!results.length) {
-                renderer.log(chalk.yellow('no plugins found', plugin.toString()));
-            }
-            results.forEach(function (result) {
-                renderer.log(chalk.cyan(result.name) + ' ' + result.url);
-            });
-            done();
-        })
-        .on('error', function (err) {
-            renderer.log(chalk.red("Oh dear, something went wrong. I'm terribly sorry."), err);
-            done(err);
-        });
-    }
-};
+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,136 +1,9 @@
-var chalk = require('chalk'),
-    fs = require('fs'),
-    path = require('path'),
-    rimraf = require('rimraf'),
-    Q = require('q'),
-    Constants = require('../Constants'),
-    PluginTypeResolver =  require('../PluginTypeResolver'),
-    PackageMeta = require('../PackageMeta'),
-    Project =  require('../Project'),
-    Plugin = require('../Plugin'),
-    RendererHelpers = require('../RendererHelpers'),
-    uninstallPackage = require('../promise/uninstallPackage'),
-    Errors = require('../errors');
-
-module.exports = {
-    apiuninstall:function(pluginName, cwd) {
-        Constants.setCwd(cwd);
-
-        var project = new Project(Constants.DefaultProjectManifestPath, Constants.DefaultProjectFrameworkPath);
-
-        if(!project.isProjectContainsManifestFile()) {
-            return Q.reject(Errors.ERROR_COURSE_DIR);
-        }
-
-        var plugin = Plugin.parse(pluginName);
-        var deferred = Q.defer();
-
-        PackageMeta.getKeywords(plugin, { registry: Constants.getRegistry() })
-        .then(function (keywords) {
-            var resolver = new PluginTypeResolver(),
-                pluginType = resolver.resolve(keywords);
-
-            return uninstallPackage(plugin, {
-                directory: path.join('src', pluginType.belongsTo),
-                cwd:Constants.cwd
-            });
-        })
-        .then(function () {
-            project.remove(plugin);
-        })
-        .then(function () {
-            deferred.resolve(pluginName);
-        })
-        .fail(function() {
-            // will fail if plugin has not been installed by Bower (i.e. the .bower.json manifest is missing)
-            // so just try and remove the directory (this is basically what Bower does anyway)
-
-            var removePath;
-            
-            ['components', 'extensions', 'menu', 'theme'].forEach(function(pluginType) {
-                var pluginPath = path.join(Constants.cwd, 'src', pluginType, plugin.packageName);
-                
-                if (fs.existsSync(pluginPath)) {
-                    removePath = pluginPath;
-                }
-            });
-
-            if (removePath) {
-                rimraf(removePath, function() {
-                    if (fs.existsSync(removePath)) {
-                        deferred.reject(Errors.ERROR_UNINSTALL);
-                    } else {
-                        project.remove(plugin);
-                        deferred.resolve(pluginName);
-                    }
-                });
-            } else {
-                deferred.reject(Errors.ERROR_NOT_FOUND);
-            }
-        });
-
-        return deferred.promise;
-    },
-    uninstall: function (renderer) {
-
-        var packageName = arguments.length >= 3 ? arguments[1] : null,
-            done = arguments[arguments.length - 1];
-
-        if(!packageName) {
-            return renderer.log(chalk.red('Please specify a plugin to uninstall.'));
-        }
-
-        var project = new Project(Constants.DefaultProjectManifestPath);
-        if (!project.isProjectContainsManifestFile()) {
-            return RendererHelpers.reportInvalidFrameworkDirectory(renderer, done)(true);
-        }
-
-        var plugin = Plugin.parse(packageName);
-
-        PackageMeta.getKeywords(plugin, { registry: Constants.getRegistry() })
-        .then(function (keywords) {
-            var resolver = new PluginTypeResolver(),
-                pluginType = resolver.resolve(keywords);
-
-            renderer.log(chalk.cyan(plugin.packageName), 'found.', 'Uninstalling', pluginType.typename, '...');
-            return uninstallPackage(plugin, {
-                directory: path.join('src', pluginType.belongsTo),
-                cwd:Constants.cwd
-            });
-        })
-        .then(function () {
-            project.remove(plugin);
-        })
-        .then(function () {
-            done();
-        })
-        .fail(function() {
-            // will fail if plugin has not been installed by Bower (i.e. the .bower.json manifest is missing)
-            // so just try and remove the directory (this is basically what Bower does anyway)
-
-            var removePath;
-            
-            ['components', 'extensions', 'menu', 'theme'].forEach(function(pluginType) {
-                var pluginPath = path.join(Constants.cwd, 'src', pluginType, plugin.packageName);
-                
-                if (fs.existsSync(pluginPath)) {
-                    removePath = pluginPath;
-                }
-            });
-
-            if (removePath) {
-                rimraf(removePath, function() {
-                    if (fs.existsSync(removePath)) {
-                        RendererHelpers.reportFailure(renderer, done);
-                    } else {
-                        project.remove(plugin);
-                        done();
-                    }
-                });
-            } else {
-                RendererHelpers.reportFailure(renderer, done);
-            }
-        });
-    }
-
-};
+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,96 +1,12 @@
-var bower = require('bower'),
-    chalk = require('chalk'),
-    inquirer = require('inquirer'),
-    _ = require('lodash'),
-    Q = require('q'),
-    request = require('request'),
-    Constants = require('../Constants'),
-    JsonLoader = require('../JsonLoader'),
-    authenticate = require('../promise/authenticate'),
-    log;
-
-module.exports = {
-    unregister: function (renderer) {
-        log = renderer.log;
-
-        var done = arguments[arguments.length-1] || function () {};
-        var pluginName;
-
-        if (arguments.length >= 3) {
-            pluginName = arguments[1];
-        }
-
-        log(chalk.yellow('This will unregister the plugin at', Constants.getRegistry()));
-        
-         getProperties(pluginName)
-        .then(authenticate)
-        .then(confirm)
-        .then(unregister)
-        .then(function() {
-            log(chalk.green('The plugin was successfully unregistered.'));
-            done();
-        })
-        .catch(function (err) {
-            log(chalk.red(err));
-            log('The plugin was not unregistered.');
-            done(err);
-        })
-        .done();
-    }
-};
-
-function getProperties(pluginName) {
-    if (pluginName) {
-        return Q.resolve({name:pluginName});
-    }
-
-    return loadPluginProperties('./bower.json');
-}
-
-function loadPluginProperties(path, defaults) {
-    var deferred = Q.defer();
-
-    path = path || './bower.json';
-
-    if(!JsonLoader.existsSync(path)) {
-        deferred.reject(new Error('bower.json is not in the current working directory. Plugins must be a valid bower package.'));
-    }
-    JsonLoader.readJSON(path, function (data) {
-        deferred.resolve(_.extend({}, defaults, data));
-    });
-
-    return deferred.promise; 
-}
-
-function confirm(properties) {
-    var deferred = Q.defer();
-    var schema = [
-        {
-            name: 'ready',
-            message: chalk.cyan('Confirm Unregister now?'),
-            type: 'confirm',
-            default: true
-        }
-    ];
-    inquirer.prompt(schema).then(confirmation => {
-        if(!confirmation.ready) deferred.reject(new Error('Aborted. Nothing has been unregistered.'));
-        deferred.resolve(properties);
-    }).catch(err => deferred.reject(err));
-    return deferred.promise;
-}
-
-function unregister(properties) {
-    var deferred = Q.defer();
-    
-    // user (username) with OAuth (token) wants to unregister the registered plugin (name) from registry
-    bower.commands.unregister(properties.username+'/'+properties.name, {token:properties.token, registry: Constants.getRegistry()})
-    .on('end', function (result) {
-        //log('end', result);
-        deferred.resolve();
-    })
-    .on('error', function (err) {
-        //log('error', err);
-        deferred.reject(err);
-    });
-    return deferred.promise;
-}
+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
+  })
+}