adapt-cli 3.0.2 → 3.0.6

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (78) hide show
  1. package/.bowerrc +2 -2
  2. package/.eslintignore +1 -1
  3. package/.eslintrc.json +14 -14
  4. package/.github/CONTRIBUTING.md +8 -0
  5. package/.github/ISSUE_TEMPLATE.md +17 -0
  6. package/.github/pull_request_template.md +25 -0
  7. package/.github/workflows/addtomainproject.yml +19 -0
  8. package/.github/workflows/releases.yml +25 -0
  9. package/.travis.yml +46 -46
  10. package/README.md +266 -266
  11. package/bin/adapt.js +3 -3
  12. package/json/help-create/component.json +9 -9
  13. package/json/help-create/course.json +9 -9
  14. package/json/help-create/question.json +9 -9
  15. package/json/help-create.json +12 -12
  16. package/json/help-devinstall.json +9 -9
  17. package/json/help-install.json +10 -10
  18. package/json/help-ls.json +7 -7
  19. package/json/help-register.json +7 -7
  20. package/json/help-rename.json +7 -7
  21. package/json/help-search.json +8 -8
  22. package/json/help-uninstall.json +7 -7
  23. package/json/help-unregister.json +8 -8
  24. package/json/help-update.json +12 -12
  25. package/json/help-version.json +7 -7
  26. package/json/help.json +19 -19
  27. package/lib/api.js +260 -260
  28. package/lib/cli.js +69 -69
  29. package/lib/commands/authenticate.js +18 -18
  30. package/lib/commands/create/component.js +64 -64
  31. package/lib/commands/create/course.js +26 -26
  32. package/lib/commands/create/question.js +18 -18
  33. package/lib/commands/create.js +94 -85
  34. package/lib/commands/devinstall.js +35 -35
  35. package/lib/commands/help.js +31 -31
  36. package/lib/commands/install.js +16 -16
  37. package/lib/commands/ls.js +9 -9
  38. package/lib/commands/register.js +11 -11
  39. package/lib/commands/rename.js +14 -14
  40. package/lib/commands/search.js +11 -11
  41. package/lib/commands/uninstall.js +9 -9
  42. package/lib/commands/unregister.js +12 -12
  43. package/lib/commands/update.js +12 -12
  44. package/lib/commands/version.js +13 -13
  45. package/lib/integration/AdaptFramework/build.js +42 -42
  46. package/lib/integration/AdaptFramework/clone.js +27 -27
  47. package/lib/integration/AdaptFramework/deleteSrcCore.js +9 -9
  48. package/lib/integration/AdaptFramework/deleteSrcCourse.js +9 -9
  49. package/lib/integration/AdaptFramework/download.js +21 -21
  50. package/lib/integration/AdaptFramework/erase.js +34 -34
  51. package/lib/integration/AdaptFramework/getLatestVersion.js +79 -79
  52. package/lib/integration/AdaptFramework/npmInstall.js +21 -21
  53. package/lib/integration/AdaptFramework.js +19 -19
  54. package/lib/integration/Plugin.js +404 -404
  55. package/lib/integration/PluginManagement/autenticate.js +56 -56
  56. package/lib/integration/PluginManagement/install.js +224 -224
  57. package/lib/integration/PluginManagement/print.js +52 -52
  58. package/lib/integration/PluginManagement/register.js +130 -130
  59. package/lib/integration/PluginManagement/rename.js +101 -101
  60. package/lib/integration/PluginManagement/schemas.js +8 -8
  61. package/lib/integration/PluginManagement/search.js +46 -46
  62. package/lib/integration/PluginManagement/uninstall.js +141 -141
  63. package/lib/integration/PluginManagement/unregister.js +101 -101
  64. package/lib/integration/PluginManagement/update.js +224 -224
  65. package/lib/integration/PluginManagement.js +21 -21
  66. package/lib/integration/Project.js +146 -146
  67. package/lib/integration/Target.js +299 -299
  68. package/lib/integration/getBowerRegistryConfig.js +34 -34
  69. package/lib/logger.js +28 -28
  70. package/lib/util/JSONReadValidate.js +34 -34
  71. package/lib/util/constants.js +38 -38
  72. package/lib/util/createPromptTask.js +7 -7
  73. package/lib/util/download.js +45 -45
  74. package/lib/util/errors.js +58 -58
  75. package/lib/util/extract.js +24 -24
  76. package/lib/util/getDirNameFromImportMeta.js +6 -6
  77. package/lib/util/promises.js +36 -36
  78. package/package.json +74 -40
@@ -1,9 +1,9 @@
1
- {
2
- "command": "devinstall",
3
- "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",
4
- "usage": [
5
- "devinstall",
6
- "devinstall <plugin-name>",
7
- "devinstall <plugin-name>#<tag-name>"
8
- ]
9
- }
1
+ {
2
+ "command": "devinstall",
3
+ "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",
4
+ "usage": [
5
+ "devinstall",
6
+ "devinstall <plugin-name>",
7
+ "devinstall <plugin-name>#<tag-name>"
8
+ ]
9
+ }
@@ -1,10 +1,10 @@
1
- {
2
- "command": "install",
3
- "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.",
4
- "usage": [
5
- "install [--dry-run, --compatible]",
6
- "install <plugin-name>",
7
- "install <plugin-name>#<semver>",
8
- "install <plugin-name>@<semver>"
9
- ]
10
- }
1
+ {
2
+ "command": "install",
3
+ "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.",
4
+ "usage": [
5
+ "install [--dry-run, --compatible]",
6
+ "install <plugin-name>",
7
+ "install <plugin-name>#<semver>",
8
+ "install <plugin-name>@<semver>"
9
+ ]
10
+ }
package/json/help-ls.json CHANGED
@@ -1,7 +1,7 @@
1
- {
2
- "command": "ls",
3
- "description": "List the plugin(s) name with version number mentioned in adapt.json file.",
4
- "usage": [
5
- "ls"
6
- ]
7
- }
1
+ {
2
+ "command": "ls",
3
+ "description": "List the plugin(s) name with version number mentioned in adapt.json file.",
4
+ "usage": [
5
+ "ls"
6
+ ]
7
+ }
@@ -1,7 +1,7 @@
1
- {
2
- "command": "register",
3
- "description": "Register a plugin to adapt's remote registry by reading bower.json file. Check folowing URL for more detail - https://github.com/adaptlearning/adapt_framework/wiki/Registering-a-plugin",
4
- "usage": [
5
- "register"
6
- ]
7
- }
1
+ {
2
+ "command": "register",
3
+ "description": "Register a plugin to adapt's remote registry by reading bower.json file. Check folowing URL for more detail - https://github.com/adaptlearning/adapt_framework/wiki/Registering-a-plugin",
4
+ "usage": [
5
+ "register"
6
+ ]
7
+ }
@@ -1,7 +1,7 @@
1
- {
2
- "command": "rename",
3
- "description": "Unregister a plugin at Adapt's remote registry. Specify as two arguments the current name of the plugin to be renamed and a new name. Please note that you must authenticate with GitHub to unregister and must be a collaborator on the endpoint registered with the plugin or a collaborator on the Adapt framework. Access to GitHub is for authentication only.",
4
- "usage": [
5
- "rename <plugin name> <new plugin name>"
6
- ]
7
- }
1
+ {
2
+ "command": "rename",
3
+ "description": "Unregister a plugin at Adapt's remote registry. Specify as two arguments the current name of the plugin to be renamed and a new name. Please note that you must authenticate with GitHub to unregister and must be a collaborator on the endpoint registered with the plugin or a collaborator on the Adapt framework. Access to GitHub is for authentication only.",
4
+ "usage": [
5
+ "rename <plugin name> <new plugin name>"
6
+ ]
7
+ }
@@ -1,8 +1,8 @@
1
- {
2
- "command": "search",
3
- "description": "List out all the plugin(s) in adapt's remote registry or could also search a plugin with supplied partial name.",
4
- "usage": [
5
- "search",
6
- "search <plugin-name>"
7
- ]
8
- }
1
+ {
2
+ "command": "search",
3
+ "description": "List out all the plugin(s) in adapt's remote registry or could also search a plugin with supplied partial name.",
4
+ "usage": [
5
+ "search",
6
+ "search <plugin-name>"
7
+ ]
8
+ }
@@ -1,7 +1,7 @@
1
- {
2
- "command": "uninstall",
3
- "description": "Remove a local plugin by its name.",
4
- "usage": [
5
- "uninstall <plugin-name>"
6
- ]
7
- }
1
+ {
2
+ "command": "uninstall",
3
+ "description": "Remove a local plugin by its name.",
4
+ "usage": [
5
+ "uninstall <plugin-name>"
6
+ ]
7
+ }
@@ -1,8 +1,8 @@
1
- {
2
- "command": "unregister",
3
- "description": "Unregister a plugin at Adapt's remote registry. This command can be run without arguments in a directory which contains the bower.json file for the plugin to be unregistered. Alternatively, specify the name of the plugin as a single argument. Please note that you must authenticate with GitHub to unregister and must be a collaborator on the endpoint registered with the plugin or a collaborator on the Adapt framework. Access to GitHub is for authentication only.",
4
- "usage": [
5
- "unregister",
6
- "unregister <plugin name>"
7
- ]
8
- }
1
+ {
2
+ "command": "unregister",
3
+ "description": "Unregister a plugin at Adapt's remote registry. This command can be run without arguments in a directory which contains the bower.json file for the plugin to be unregistered. Alternatively, specify the name of the plugin as a single argument. Please note that you must authenticate with GitHub to unregister and must be a collaborator on the endpoint registered with the plugin or a collaborator on the Adapt framework. Access to GitHub is for authentication only.",
4
+ "usage": [
5
+ "unregister",
6
+ "unregister <plugin name>"
7
+ ]
8
+ }
@@ -1,12 +1,12 @@
1
- {
2
- "command": "update",
3
- "description": "Update plugins to their latest compatible version. You can also specify which plugins to update as arguments. When specifying arguments you can provide an optional semantic version (semver). Add the --check option for a summary of available updates for the given plugin(s). When using this option no changes are made. Ensure that there is no bower.json file in your project directory.",
4
- "usage": [
5
- "update [--check]",
6
- "update <group> [<group> ..] where <group> is one of [components|extensions|menu|theme|all]",
7
- "update <plugin-name>",
8
- "update <plugin-name>#<semver>",
9
- "update <plugin-name>@<semver>",
10
- "update <target> [<target> ..] where target is the name of a plugin or group"
11
- ]
12
- }
1
+ {
2
+ "command": "update",
3
+ "description": "Update plugins to their latest compatible version. You can also specify which plugins to update as arguments. When specifying arguments you can provide an optional semantic version (semver). Add the --check option for a summary of available updates for the given plugin(s). When using this option no changes are made. Ensure that there is no bower.json file in your project directory.",
4
+ "usage": [
5
+ "update [--check]",
6
+ "update <group> [<group> ..] where <group> is one of [components|extensions|menu|theme|all]",
7
+ "update <plugin-name>",
8
+ "update <plugin-name>#<semver>",
9
+ "update <plugin-name>@<semver>",
10
+ "update <target> [<target> ..] where target is the name of a plugin or group"
11
+ ]
12
+ }
@@ -1,7 +1,7 @@
1
- {
2
- "command": "version",
3
- "description": "Display version of adapt-cli.",
4
- "usage": [
5
- "version"
6
- ]
7
- }
1
+ {
2
+ "command": "version",
3
+ "description": "Display version of adapt-cli.",
4
+ "usage": [
5
+ "version"
6
+ ]
7
+ }
package/json/help.json CHANGED
@@ -1,19 +1,19 @@
1
- {
2
- "usage": [
3
- "<command>"
4
- ],
5
- "commands": {
6
- "create": "Create a new Adapt course or plugin",
7
- "devinstall": "Get the framework and plugins as Git repository",
8
- "help": "List out the commands available with adapt-cli",
9
- "install": "Install plugin(s) within the Adapt course directory",
10
- "ls": "List all the plugin names mentioned in adapt.json",
11
- "rename": "Rename a plugin at the Adapt remote registry",
12
- "register": "Register a plugin with the Adapt remote registry",
13
- "search": "List/Search for plugin(s) at the Adapt remote registry",
14
- "uninstall": "Remove a local plugin",
15
- "unregister": "Unregister a plugin from the Adapt remote registry",
16
- "update": "Update one or more plugins",
17
- "version": "Display version of adapt-cli"
18
- }
19
- }
1
+ {
2
+ "usage": [
3
+ "<command>"
4
+ ],
5
+ "commands": {
6
+ "create": "Create a new Adapt course or plugin",
7
+ "devinstall": "Get the framework and plugins as Git repository",
8
+ "help": "List out the commands available with adapt-cli",
9
+ "install": "Install plugin(s) within the Adapt course directory",
10
+ "ls": "List all the plugin names mentioned in adapt.json",
11
+ "rename": "Rename a plugin at the Adapt remote registry",
12
+ "register": "Register a plugin with the Adapt remote registry",
13
+ "search": "List/Search for plugin(s) at the Adapt remote registry",
14
+ "uninstall": "Remove a local plugin",
15
+ "unregister": "Unregister a plugin from the Adapt remote registry",
16
+ "update": "Update one or more plugins",
17
+ "version": "Display version of adapt-cli"
18
+ }
19
+ }