hpe-sfdx-plugins v0.0.4

hpe-sfdx-plugins

sfdx plugins for hpe ci/cd

• Debugging your plugin

$ npm install -g hpe-sfdx-plugins
$ sfdx COMMAND
running command...
$ sfdx (-v|--version|version)
hpe-sfdx-plugins/0.0.3-1 win32-x64 node-v12.13.1
$ sfdx --help [COMMAND]
USAGE
  $ sfdx COMMAND
...

• sfdx hpe:community:install [-b <string>] [-o] [-u <string>] [--apiversion <string>] [--json] [--loglevel trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL]
• sfdx hpe:package:install -p <array> [-s <array>] [-t <array>] [-u <string>] [--apiversion <string>] [--json] [--loglevel trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL]
• sfdx hpe:project:create -n <string> [--json] [--loglevel trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL]
• sfdx hpe:project:dependencies:install [-o] [-u <string>] [--apiversion <string>] [--json] [--loglevel trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL]
• sfdx hpe:project:start -a <string> -f <string> [-c] [-o] [-J] [-A] [-S] [-p <string>] [--json] [--loglevel trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL]

sfdx hpe:community:install [-b <string>] [-o] [-u <string>] [--apiversion <string>] [--json] [--loglevel trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL]

USAGE
  $ sfdx hpe:community:install [-b <string>] [-o] [-u <string>] [--apiversion <string>] [--json] [--loglevel 
  trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL]

OPTIONS
  -b, --communitybranch=communitybranch                                             Choose the Communitiy's Repository
                                                                                    Branch Name

  -o, --openscratchorg                                                              True if you want to Open the Created
                                                                                    Scratch Org at the end of the Job

  -u, --targetusername=targetusername                                               username or alias for the target
                                                                                    org; overrides default target org

  --apiversion=apiversion                                                           override the api version used for
                                                                                    api requests made by this command

  --json                                                                            format output as json

  --loglevel=(trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL)  [default: warn] logging level for
                                                                                    this command invocation

See code: lib\commands\hpe\community\install.js

sfdx hpe:package:install -p <array> [-s <array>] [-t <array>] [-u <string>] [--apiversion <string>] [--json] [--loglevel trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL]

USAGE
  $ sfdx hpe:package:install -p <array> [-s <array>] [-t <array>] [-u <string>] [--apiversion <string>] [--json] 
  [--loglevel trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL]

OPTIONS
  -p, --packages=packages
      (required) A list of Package IDs (04t...) or Package Aliases

  -s, --securitytypes=securitytypes
      An array of to configure the package installation for AllUsers or AdminOnly for each package specified in the 
      packages flag. If only one value is given, it will be applied to all packages. The default is AdminsOnly.

  -t, --upgradetypes=upgradetypes
      An array of upgrade types for each package specified in the packages flag. If only one value is given, it will be 
      applied for all packages. The default is Mixed.

  -u, --targetusername=targetusername
      username or alias for the target org; overrides default target org

  --apiversion=apiversion
      override the api version used for api requests made by this command

  --json
      format output as json

  --loglevel=(trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL)
      [default: warn] logging level for this command invocation

See code: lib\commands\hpe\package\install.js

sfdx hpe:project:create -n <string> [--json] [--loglevel trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL]

USAGE
  $ sfdx hpe:project:create -n <string> [--json] [--loglevel 
  trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL]

OPTIONS
  -n, --name=name                                                                   (required) Set a name for the
                                                                                    Project.

  --json                                                                            format output as json

  --loglevel=(trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL)  [default: warn] logging level for
                                                                                    this command invocation

See code: lib\commands\hpe\project\create.js

sfdx hpe:project:dependencies:install [-o] [-u <string>] [--apiversion <string>] [--json] [--loglevel trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL]

USAGE
  $ sfdx hpe:project:dependencies:install [-o] [-u <string>] [--apiversion <string>] [--json] [--loglevel 
  trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL]

OPTIONS
  -o, --openscratchorg                                                              True if you want to Open the Created
                                                                                    Scratch Org at the end of the Job

  -u, --targetusername=targetusername                                               username or alias for the target
                                                                                    org; overrides default target org

  --apiversion=apiversion                                                           override the api version used for
                                                                                    api requests made by this command

  --json                                                                            format output as json

  --loglevel=(trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL)  [default: warn] logging level for
                                                                                    this command invocation

See code: lib\commands\hpe\project\dependencies\install.js

sfdx hpe:project:start -a <string> -f <string> [-c] [-o] [-J] [-A] [-S] [-p <string>] [--json] [--loglevel trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL]

USAGE
  $ sfdx hpe:project:start -a <string> -f <string> [-c] [-o] [-J] [-A] [-S] [-p <string>] [--json] [--loglevel 
  trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL]

OPTIONS
  -A, --runapextests                                                                If specified it will run Apex Test
                                                                                    Suite specified in the YAML

  -J, --runjesttests                                                                If specified it will run all LWC
                                                                                    Jest Tests

  -S, --runseleniumtests                                                            If specified it will run the
                                                                                    Selenium Tests configured in the
                                                                                    YAML

  -a, --alias=alias                                                                 (required) Scratch Org Alias

  -c, --community                                                                   True if you want to install HPE
                                                                                    Community

  -f, --file=file                                                                   (required) Path to Scratch Org
                                                                                    Configuration File.

  -o, --openscratchorg                                                              True if you want to Open the Created
                                                                                    Scratch Org at the end of the Job

  -p, --password=password                                                           If specified it will set the
                                                                                    Password for the Scratch Org User

  --json                                                                            format output as json

  --loglevel=(trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL)  [default: warn] logging level for
                                                                                    this command invocation

See code: lib\commands\hpe\project\start.js

Debugging your plugin

We recommend using the Visual Studio Code (VS Code) IDE for your plugin development. Included in the .vscode directory of this plugin is a launch.json config file, which allows you to attach a debugger to the node process when running your commands.

To debug the hello:org command: 1. Start the inspector

If you linked your plugin to the sfdx cli, call your command with the dev-suspend switch:

$ sfdx hello:org -u myOrg@example.com --dev-suspend

Alternatively, to call your command using the bin/run script, set the NODE_OPTIONS environment variable to --inspect-brk when starting the debugger:

$ NODE_OPTIONS=--inspect-brk bin/run hello:org -u myOrg@example.com

2. Set some breakpoints in your command code
3. Click on the Debug icon in the Activity Bar on the side of VS Code to open up the Debug view.
4. In the upper left hand corner of VS Code, verify that the "Attach to Remote" launch configuration has been chosen.
5. Hit the green play button to the left of the "Attach to Remote" launch configuration window. The debugger should now be suspended on the first line of the program.
6. Hit the green play button at the top middle of VS Code (this play button will be to the right of the play button that you clicked in step #5). Congrats, you are debugging!