Merge branch 'pull48'

Author: chris-steele

.travis.yml

@@ -1,6 +1,46 @@
+---
 language: node_js
 node_js:
-  - "0.11"
+  - "lts/*"
+
+sudo: false
+
+env:
+  - CXX=g++-4.8
+
+addons:
+  apt:
+    sources:
+      - ubuntu-toolchain-r-test
+    packages:
+      - g++-4.8
+
+branches:
+  only:
+    - master
+    - develop
+
+git:
+  depth: 10
+
+cache:
+  directories:
+    - node_modules
+
 before_script:
   - npm install -g grunt-cli
-sudo: false
+
+install:
+  - npm config set spin false
+  - npm install
+
+matrix:
+  fast_finish: true
+
+notifications:
+  webhooks:
+    urls:
+      - https://webhooks.gitter.im/e/2b42e20cf5f5550c1dc0
+    on_success: change  # options: [always|never|change] default: always
+    on_failure: always  # options: [always|never|change] default: always
+    on_start: never     # options: [always|never|change] default: always

README.md

@@ -1,87 +1,119 @@
 Adapt Command Line Interface
 ============================
 
-[![Build Status](https://travis-ci.org/adaptlearning/adapt-cli.png?branch=master)](https://travis-ci.org/adaptlearning/adapt-cli)
+[![Build Status](https://travis-ci.org/adaptlearning/adapt-cli.png?branch=master)](https://travis-ci.org/adaptlearning/adapt-cli)  [![Join the chat at https://gitter.im/adaptlearning/adapt-cli](https://badges.gitter.im/Join%20Chat.svg)](https://gitter.im/adaptlearning/adapt-cli?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge)
 
 Installation
 ------------
 
 To install the Adapt CLI, first be sure to install [NodeJS](http://nodejs.org) and [git](http://git-scm.com/downloads), then from the command line run:-
-
-
-        npm install -g adapt-cli
-
+```
+npm install -g adapt-cli
+```
 
 Usage
 -----
 
 ##### Creating an Adapt course
-
-    adapt create {type} {path} [{branch}]
-
-type - What to create. Only the value "course" is currently supported. 
-path - The directory of the new course.
-branch - Optional - The branch of the framework to be downlaoded.
+```
+adapt create {type} {path} [{branch}]
+```
+`type` What to create. The only types currently supported are `course` and `component`. If you want to create a new Adapt course, use `course`. If you want to develop a new Adapt component, use `component` to download a component template.
+`path` The name of the directory you'd like the course to be downloaded to (relative to the current directory)  
+`branch` (optional) The branch of the framework you'd like to use as the basis for your course. If your needs to support Internet Explorer v8, 9 or 10 then set this to `legacy`. If not, leave blank or set to `master`.
 
 For example...
-
-    adapt create course "My Course"
-
+```
+adapt create course "My Course"
+```
 This will download the Adapt framework and create an new course in the directory "My Course", in your current directory.
 
 ##### Searching for an Adapt plugin.
-
-    adapt search {name or partial name of plugin to search for}
-
+```
+adapt search {name or partial name of plugin to search for}
+```
 
 ##### Installing a plugin into your current directory
-
-    adapt install {name of plugin}
-
+```
+adapt install {name of plugin}
+```
 Additionally you can install a specific version of a plugin.
-
-    adapt install {name of plugin}#{version}
-
+```
+adapt install {name of plugin}#{version}
+```
 Anywhere that you are required to provide a name of a plugin it can be either fully qualified with 'adapt-' or optionally you can omit the prefix an just use the plugin name.
 
 Therefore these commands are equivalent:
-
-    adapt install adapt-my-plugin
-    adapt install my-plugin
-
-Installed plugins are saved to `adapt.json`. 
+```
+adapt install adapt-my-plugin
+adapt install my-plugin
+```
+Installed plugins are saved to `adapt.json`.
 
 ##### Installing plugins previously saved in adapt.json
-
-    adapt install
-
+```
+adapt install
+```
 
 ##### Uninstalling a plugin from your current directory
-
-    adapt uninstall {name of plugin}
-
+```
+adapt uninstall {name of plugin}
+```
 
 The Plugin Registry
 -------------------
 
 The plugin system is powered by [Bower](http://bower.io/). Each plugin should be a valid bower package and they should be registered with the Adapt registry.
-
-    http://adapt-bower-repository.herokuapp.com/packages/
-
+```
+http://adapt-bower-repository.herokuapp.com/packages/
+```
 See [Developing plugins](https://github.com/adaptlearning/adapt_framework/wiki/Developing-plugins) for more information on defining your plugins package.
 
 ##### Registering a plugin
 
 From within a plugin directory
-
-    adapt register
-
+```
+adapt register
+```
 `name` and `repository` will be read from `bower.json` in the current directory.
 
 The package will be registered with the registry on a first come first serve basis.
 
+##### Unregister a plugin
+
+From within a plugin directory
+```
+adapt unregister
+```
+`name` will be read from `bower.json` in the current directory
+
+Alternatively, from any directory
+```
+adapt unregister <plugin name>
+```
+You will be prompted to authenticate with GitHub.
+
+The package will be unregistered with the registry if the authenticated user is a collaborator on the given endpoint or a collaborator on the Adapt framework.
+
+##### Rename a plugin
+
+From any directory
+```
+adapt rename <plugin name> <new plugin name>
+```
+You will be prompted to authenticate with GitHub.
+
+The package will be renamed if the authenticated user is a collaborator on the endpoint registered with the plugin or a collaborator on the Adapt framework.
+
 Release History
 ===============
+- 2.1.1 - Integrated PR 48 and fixed issue with adapt create command
+- 2.1.0 - Fully updated update and install commands
+- 2.0.7 - Added update command, rewritten install command and updated dependencies; targetting Node v8+
+- 2.0.6 - Dependencies updated, registry now targeted consistently, fixed issue #49, CI target set to all Node LTS versions
+- 2.0.5 - Added rename and unregister commands and corrected some typos
+- 2.0.4 - Corrected version numbers
+- 2.0.3 - Fixed issue#53 - npm dependency is git url
 - 2.0.2 - Fixed issue#32 - Error: Cannot find module 'Q' on case sensitive file systems
 - 2.0.1 - Fixed an issue with installing dependencies (https://github.com/adaptlearning/adapt-cli/tree/hotfix/has-no-method-install)
 - 2.0.0 - version bump to 2.0.0

TESTING.md

@@ -0,0 +1,25 @@
+### 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).

VERSION

@@ -1 +1 @@
-2.0.2
+2.1.1

json/help-create.json

@@ -0,0 +1,11 @@
+{
+    "command": "create",
+    "description": "Create a new adapt course",
+    "usage": [
+        "create <command>"
+    ],
+    "commands": {
+        "course":               "Create new adapt course",
+        "component":            "Create new componentn using template adapt-component"
+    }
+}

json/help-create/component.json

@@ -0,0 +1,9 @@
+{
+    "command": "create component",
+    "description": "create new component",
+    "usage": [
+        "create component",
+        "create component <component-name>",
+        "create component <component-name> <branch-name>"
+    ]
+}

json/help-create/course.json

@@ -0,0 +1,9 @@
+{
+    "command": "create course",
+    "description": "to create new course",
+    "usage": [
+        "create course",
+        "create course <course-name>",
+        "create course <course-name> <branch-name>"
+    ]
+}

json/help-devinstall.json

@@ -0,0 +1,9 @@
+{
+    "command": "devinstall",
+    "description": "This command will clone the adapt_framework and all the plugins defined in adapt.json as git repos. For more info visit: https://github.com/adaptlearning/adapt-cli/pull/46",
+    "usage": [
+        "devinstall",
+        "devinstall <plugin-name>",
+        "devinstall <plugin-name>#<tag-name>"
+    ]
+}

json/help-install.json

@@ -0,0 +1,10 @@
+{
+    "command": "install",
+    "description": "Install plugins according to the Adapt manifest (adapt.json). You can also specify which plugins to install as arguments. When specifying arguments you can provide an optional semantic version (semver). If a semver is not given the command will attempt to install the latest compatible version. Add the --dry-run option to simulate an installation without making any changes. Add the --compatible option to override any given semvers: the command will attempt to install the latest compatible version for all requested plugins.",
+    "usage": [
+        "install [--dry-run, --compatible]",
+        "install <plugin-name>",
+        "install <plugin-name>#<semver>",
+        "install <plugin-name>@<semver>",
+    ]
+}

json/help-ls.json

@@ -0,0 +1,7 @@
+{
+    "command": "ls",
+    "description": "List the plugin(s) name with version number mentioned in adapt.json file.",
+    "usage": [
+        "ls"
+    ]
+}