@trayio/cdk-cli 4.6.0 → 4.8.0

package/README.md

@@ -19,7 +19,7 @@ $ npm install -g @trayio/cdk-cli
 $ tray-cdk COMMAND
 running command...
 $ tray-cdk (--version|-v)
-@trayio/cdk-cli/4.6.0 linux-x64 node-v18.20.2
+@trayio/cdk-cli/4.8.0 linux-x64 node-v18.20.2
 $ tray-cdk --help [COMMAND]
 USAGE
   $ tray-cdk COMMAND
@@ -30,7 +30,7 @@ USAGE
 # Commands
 
 <!-- commands -->
-* [`tray-cdk`](#tray-cdk)
+* [`tray-cdk .`](#tray-cdk-)
 * [`tray-cdk autocomplete [SHELL]`](#tray-cdk-autocomplete-shell)
 * [`tray-cdk connector add-operation [OPERATIONNAME] [OPERATIONTYPE]`](#tray-cdk-connector-add-operation-operationname-operationtype)
 * [`tray-cdk connector build`](#tray-cdk-connector-build)
@@ -39,16 +39,26 @@ USAGE
 * [`tray-cdk connector test [OPERATIONNAME]`](#tray-cdk-connector-test-operationname)
 * [`tray-cdk deployment create`](#tray-cdk-deployment-create)
 * [`tray-cdk deployment get [CONNECTORNAME] [CONNECTORVERSION] [UUID]`](#tray-cdk-deployment-get-connectorname-connectorversion-uuid)
-* [`tray-cdk help [COMMANDS]`](#tray-cdk-help-commands)
+* [`tray-cdk help [COMMAND]`](#tray-cdk-help-command)
 * [`tray-cdk permissions add [CONNECTORNAME] [CONNECTORVERSION]`](#tray-cdk-permissions-add-connectorname-connectorversion)
 * [`tray-cdk permissions list [CONNECTORNAME] [CONNECTORVERSION]`](#tray-cdk-permissions-list-connectorname-connectorversion)
+* [`tray-cdk plugins`](#tray-cdk-plugins)
+* [`tray-cdk plugins add PLUGIN`](#tray-cdk-plugins-add-plugin)
+* [`tray-cdk plugins:inspect PLUGIN...`](#tray-cdk-pluginsinspect-plugin)
+* [`tray-cdk plugins install PLUGIN`](#tray-cdk-plugins-install-plugin)
+* [`tray-cdk plugins link PATH`](#tray-cdk-plugins-link-path)
+* [`tray-cdk plugins remove [PLUGIN]`](#tray-cdk-plugins-remove-plugin)
+* [`tray-cdk plugins reset`](#tray-cdk-plugins-reset)
+* [`tray-cdk plugins uninstall [PLUGIN]`](#tray-cdk-plugins-uninstall-plugin)
+* [`tray-cdk plugins unlink [PLUGIN]`](#tray-cdk-plugins-unlink-plugin)
+* [`tray-cdk plugins update`](#tray-cdk-plugins-update)
 * [`tray-cdk version`](#tray-cdk-version)
 
-## `tray-cdk`
+## `tray-cdk .`
 
 ```
 USAGE
-  $ tray-cdk
+  $ tray-cdk .
 ```
 
 ## `tray-cdk autocomplete [SHELL]`
@@ -213,16 +223,16 @@ EXAMPLES
   $ tray-cdk deployment get my-connector 1.0 3f1de598-d405-4801-9eec-6fe79e8393d3 -t
 ```
 
-## `tray-cdk help [COMMANDS]`
+## `tray-cdk help [COMMAND]`
 
 Display help for tray-cdk.
 
 ```
 USAGE
-  $ tray-cdk help [COMMANDS] [-n]
+  $ tray-cdk help [COMMAND] [-n]
 
 ARGUMENTS
-  COMMANDS  Command to show help for.
+  COMMAND  Command to show help for.
 
 FLAGS
   -n, --nested-commands  Include all nested commands in the output.
@@ -231,7 +241,7 @@ DESCRIPTION
   Display help for tray-cdk.
 ```
 
-_See code: [@oclif/plugin-help](https://github.com/oclif/plugin-help/blob/v6.0.12/src/commands/help.ts)_
+_See code: [@oclif/plugin-help](https://github.com/oclif/plugin-help/blob/v6.0.21/src/commands/help.ts)_
 
 ## `tray-cdk permissions add [CONNECTORNAME] [CONNECTORVERSION]`
 
@@ -286,6 +296,295 @@ EXAMPLES
   $ tray-cdk permissions list my-connector 1.0
 ```
 
+## `tray-cdk plugins`
+
+List installed plugins.
+
+```
+USAGE
+  $ tray-cdk plugins [--json] [--core]
+
+FLAGS
+  --core  Show core plugins.
+
+GLOBAL FLAGS
+  --json  Format output as json.
+
+DESCRIPTION
+  List installed plugins.
+
+EXAMPLES
+  $ tray-cdk plugins
+```
+
+_See code: [@oclif/plugin-plugins](https://github.com/oclif/plugin-plugins/blob/v5.0.11/src/commands/plugins/index.ts)_
+
+## `tray-cdk plugins add PLUGIN`
+
+Installs a plugin into tray-cdk.
+
+```
+USAGE
+  $ tray-cdk plugins add PLUGIN [--json] [-f] [-h] [-s | -v]
+
+ARGUMENTS
+  PLUGIN  Plugin to install.
+
+FLAGS
+  -f, --force    Force npm to fetch remote resources even if a local copy exists on disk.
+  -h, --help     Show CLI help.
+  -s, --silent   Silences npm output.
+  -v, --verbose  Show verbose npm output.
+
+GLOBAL FLAGS
+  --json  Format output as json.
+
+DESCRIPTION
+  Installs a plugin into tray-cdk.
+
+  Uses bundled npm executable to install plugins into /home/runner/.local/share/@trayio/cdk-cli
+
+  Installation of a user-installed plugin will override a core plugin.
+
+  Use the TRAY_CDK_NPM_LOG_LEVEL environment variable to set the npm loglevel.
+  Use the TRAY_CDK_NPM_REGISTRY environment variable to set the npm registry.
+
+ALIASES
+  $ tray-cdk plugins add
+
+EXAMPLES
+  Install a plugin from npm registry.
+
+    $ tray-cdk plugins add myplugin
+
+  Install a plugin from a github url.
+
+    $ tray-cdk plugins add https://github.com/someuser/someplugin
+
+  Install a plugin from a github slug.
+
+    $ tray-cdk plugins add someuser/someplugin
+```
+
+## `tray-cdk plugins:inspect PLUGIN...`
+
+Displays installation properties of a plugin.
+
+```
+USAGE
+  $ tray-cdk plugins inspect PLUGIN...
+
+ARGUMENTS
+  PLUGIN  [default: .] Plugin to inspect.
+
+FLAGS
+  -h, --help     Show CLI help.
+  -v, --verbose
+
+GLOBAL FLAGS
+  --json  Format output as json.
+
+DESCRIPTION
+  Displays installation properties of a plugin.
+
+EXAMPLES
+  $ tray-cdk plugins inspect myplugin
+```
+
+_See code: [@oclif/plugin-plugins](https://github.com/oclif/plugin-plugins/blob/v5.0.11/src/commands/plugins/inspect.ts)_
+
+## `tray-cdk plugins install PLUGIN`
+
+Installs a plugin into tray-cdk.
+
+```
+USAGE
+  $ tray-cdk plugins install PLUGIN [--json] [-f] [-h] [-s | -v]
+
+ARGUMENTS
+  PLUGIN  Plugin to install.
+
+FLAGS
+  -f, --force    Force npm to fetch remote resources even if a local copy exists on disk.
+  -h, --help     Show CLI help.
+  -s, --silent   Silences npm output.
+  -v, --verbose  Show verbose npm output.
+
+GLOBAL FLAGS
+  --json  Format output as json.
+
+DESCRIPTION
+  Installs a plugin into tray-cdk.
+
+  Uses bundled npm executable to install plugins into /home/runner/.local/share/@trayio/cdk-cli
+
+  Installation of a user-installed plugin will override a core plugin.
+
+  Use the TRAY_CDK_NPM_LOG_LEVEL environment variable to set the npm loglevel.
+  Use the TRAY_CDK_NPM_REGISTRY environment variable to set the npm registry.
+
+ALIASES
+  $ tray-cdk plugins add
+
+EXAMPLES
+  Install a plugin from npm registry.
+
+    $ tray-cdk plugins install myplugin
+
+  Install a plugin from a github url.
+
+    $ tray-cdk plugins install https://github.com/someuser/someplugin
+
+  Install a plugin from a github slug.
+
+    $ tray-cdk plugins install someuser/someplugin
+```
+
+_See code: [@oclif/plugin-plugins](https://github.com/oclif/plugin-plugins/blob/v5.0.11/src/commands/plugins/install.ts)_
+
+## `tray-cdk plugins link PATH`
+
+Links a plugin into the CLI for development.
+
+```
+USAGE
+  $ tray-cdk plugins link PATH [-h] [--install] [-v]
+
+ARGUMENTS
+  PATH  [default: .] path to plugin
+
+FLAGS
+  -h, --help          Show CLI help.
+  -v, --verbose
+      --[no-]install  Install dependencies after linking the plugin.
+
+DESCRIPTION
+  Links a plugin into the CLI for development.
+  Installation of a linked plugin will override a user-installed or core plugin.
+
+  e.g. If you have a user-installed or core plugin that has a 'hello' command, installing a linked plugin with a 'hello'
+  command will override the user-installed or core plugin implementation. This is useful for development work.
+
+
+EXAMPLES
+  $ tray-cdk plugins link myplugin
+```
+
+_See code: [@oclif/plugin-plugins](https://github.com/oclif/plugin-plugins/blob/v5.0.11/src/commands/plugins/link.ts)_
+
+## `tray-cdk plugins remove [PLUGIN]`
+
+Removes a plugin from the CLI.
+
+```
+USAGE
+  $ tray-cdk plugins remove [PLUGIN] [-h] [-v]
+
+ARGUMENTS
+  PLUGIN  plugin to uninstall
+
+FLAGS
+  -h, --help     Show CLI help.
+  -v, --verbose
+
+DESCRIPTION
+  Removes a plugin from the CLI.
+
+ALIASES
+  $ tray-cdk plugins unlink
+  $ tray-cdk plugins remove
+
+EXAMPLES
+  $ tray-cdk plugins remove myplugin
+```
+
+## `tray-cdk plugins reset`
+
+Remove all user-installed and linked plugins.
+
+```
+USAGE
+  $ tray-cdk plugins reset [--hard] [--reinstall]
+
+FLAGS
+  --hard       Delete node_modules and package manager related files in addition to uninstalling plugins.
+  --reinstall  Reinstall all plugins after uninstalling.
+```
+
+_See code: [@oclif/plugin-plugins](https://github.com/oclif/plugin-plugins/blob/v5.0.11/src/commands/plugins/reset.ts)_
+
+## `tray-cdk plugins uninstall [PLUGIN]`
+
+Removes a plugin from the CLI.
+
+```
+USAGE
+  $ tray-cdk plugins uninstall [PLUGIN] [-h] [-v]
+
+ARGUMENTS
+  PLUGIN  plugin to uninstall
+
+FLAGS
+  -h, --help     Show CLI help.
+  -v, --verbose
+
+DESCRIPTION
+  Removes a plugin from the CLI.
+
+ALIASES
+  $ tray-cdk plugins unlink
+  $ tray-cdk plugins remove
+
+EXAMPLES
+  $ tray-cdk plugins uninstall myplugin
+```
+
+_See code: [@oclif/plugin-plugins](https://github.com/oclif/plugin-plugins/blob/v5.0.11/src/commands/plugins/uninstall.ts)_
+
+## `tray-cdk plugins unlink [PLUGIN]`
+
+Removes a plugin from the CLI.
+
+```
+USAGE
+  $ tray-cdk plugins unlink [PLUGIN] [-h] [-v]
+
+ARGUMENTS
+  PLUGIN  plugin to uninstall
+
+FLAGS
+  -h, --help     Show CLI help.
+  -v, --verbose
+
+DESCRIPTION
+  Removes a plugin from the CLI.
+
+ALIASES
+  $ tray-cdk plugins unlink
+  $ tray-cdk plugins remove
+
+EXAMPLES
+  $ tray-cdk plugins unlink myplugin
+```
+
+## `tray-cdk plugins update`
+
+Update installed plugins.
+
+```
+USAGE
+  $ tray-cdk plugins update [-h] [-v]
+
+FLAGS
+  -h, --help     Show CLI help.
+  -v, --verbose
+
+DESCRIPTION
+  Update installed plugins.
+```
+
+_See code: [@oclif/plugin-plugins](https://github.com/oclif/plugin-plugins/blob/v5.0.11/src/commands/plugins/update.ts)_
+
 ## `tray-cdk version`
 
 ```

package/dist/commands/deployment/create.js

@@ -65,10 +65,10 @@ class Create extends core_1.Command {
         if (response.isSuccess) {
             const { id } = response.value;
             if (response.value.repeatDeployment === true) {
-                core_1.ux.action.stop((0, colorizeString_1.warning)(`Connector ${connectorName} - ${connectorVersion} deployment is already in progress. Deployment ID: ${id}. Please check for the status using 'tray-cdk deployment get' command.`));
+                core_1.ux.action.stop((0, colorizeString_1.warning)(`Connector ${connectorName} - ${connectorVersion} deployment is already in progress. Deployment ID: ${id}. Run "tray-cdk deployment get" to check the status.`));
             }
             else {
-                core_1.ux.action.stop((0, colorizeString_1.success)('Deployment created! The deployment may take a few minutes to complete. Use `tray-cdk deployment get` to check the status.'));
+                core_1.ux.action.stop((0, colorizeString_1.success)(`Deployment created! The deployment may take a few minutes to complete. Run "tray-cdk deployment get" to check the status.`));
                 this.log(`Connector ${connectorName} - ${connectorVersion} deployment is in progress. Deployment ID: ${id}.`);
             }
         }

package/dist/commands/deployment/create.unit.test.js

@@ -61,7 +61,7 @@ describe('Create', () => {
         expect(test_1.default.run).toHaveBeenCalledWith([]);
         expect(build_1.default.run).toHaveBeenCalledWith([]);
         expect(startSpy).toHaveBeenCalledWith('Creating Connector Deployment');
-        expect(stopSpy).toHaveBeenCalledWith(expect.stringContaining('Deployment created! The deployment may take a few minutes to complete. Use `tray-cdk deployment get` to check the status.'));
+        expect(stopSpy).toHaveBeenCalledWith(expect.stringContaining('Deployment created! The deployment may take a few minutes to complete. Run "tray-cdk deployment get" to check the status.'));
         expect(stdout_stderr_1.stdout.output).toEqual(expect.stringContaining('Connector connectorName - 1.0 deployment is in progress. Deployment ID: some-id.'));
     });
     it('should inform user of repeatDeployment when deployment is already in progress', async () => {
@@ -74,7 +74,7 @@ describe('Create', () => {
         expect(test_1.default.run).toHaveBeenCalledWith([]);
         expect(build_1.default.run).toHaveBeenCalledWith([]);
         expect(startSpy).toHaveBeenCalledWith('Creating Connector Deployment');
-        expect(stopSpy).toHaveBeenCalledWith(expect.stringContaining(`Connector connectorName - 1.0 deployment is already in progress. Deployment ID: some-id. Please check for the status using 'tray-cdk deployment get' command.`));
+        expect(stopSpy).toHaveBeenCalledWith(expect.stringContaining(`Connector connectorName - 1.0 deployment is already in progress. Deployment ID: some-id. Run "tray-cdk deployment get" to check the status.`));
     });
     it('should error when the deployment fails', async () => {
         success = false;

package/oclif.manifest.json

@@ -343,5 +343,5 @@
       ]
     }
   },
-  "version": "4.6.0"
+  "version": "4.8.0"
 }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@trayio/cdk-cli",
-  "version": "4.6.0",
+  "version": "4.8.0",
   "description": "A CLI for connector development",
   "exports": {
     "./*": "./dist/*.js"
@@ -16,18 +16,18 @@
   "dependencies": {
     "@oclif/core": "3.18.1",
     "@oclif/plugin-autocomplete": "3.0.5",
-    "@oclif/plugin-help": "6.0.12",
+    "@oclif/plugin-help": "6.0.21",
+    "@oclif/plugin-plugins": "^5",
     "@oclif/plugin-version": "2.0.11",
     "@oclif/test": "3.1.12",
-    "@trayio/axios": "4.6.0",
-    "@trayio/cdk-build": "4.6.0",
-    "@trayio/commons": "4.6.0",
-    "@trayio/generator": "4.6.0",
-    "@trayio/tray-client": "4.6.0",
-    "@trayio/tray-openapi": "4.6.0",
-    "@types/inquirer": "8.2.6",
+    "@trayio/axios": "4.8.0",
+    "@trayio/cdk-build": "4.8.0",
+    "@trayio/commons": "4.8.0",
+    "@trayio/generator": "4.8.0",
+    "@trayio/tray-client": "4.8.0",
+    "@trayio/tray-openapi": "4.8.0",
     "chalk": "4.1.2",
-    "inquirer": "8.2.5"
+    "inquirer": "8.2.6"
   },
   "typesVersions": {
     "*": {
@@ -53,6 +53,7 @@
     "plugins": [
       "@oclif/plugin-help",
       "@oclif/plugin-autocomplete",
+      "@oclif/plugin-plugins",
       "@oclif/plugin-version"
     ],
     "additionalHelpFlags": [
@@ -76,5 +77,9 @@
   "scripts": {
     "oclif:clean": "rm -f oclif.manifest.json",
     "postcompile": "oclif manifest && oclif readme"
+  },
+  "devDependencies": {
+    "@types/inquirer": "8.2.6",
+    "oclif": "*"
   }
 }