@rocko1204/packaging-helper v0.2.0

@rocko/packaging-helper

Provides packaging support

• Debugging your plugin
• Debugging your plugin

$ npm install -g @rocko1204/packaging-helper
$ sfdx COMMAND
running command...
$ sfdx (-v|--version|version)
@rocko1204/packaging-helper/0.1.3 win32-x64 node-v14.17.0
$ sfdx --help [COMMAND]
USAGE
  $ sfdx COMMAND
...

$ npm install -g @rocko1204/packaging-helper
$ sfdx COMMAND
running command...
$ sfdx (-v|--version|version)
@rocko1204/packaging-helper/0.1.3 win32-x64 node-v14.17.0
$ sfdx --help [COMMAND]
USAGE
  $ sfdx COMMAND
...

• sfdx rocko:meta:remove -s <string> -t <string> [-c] [--json] [--loglevel trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL]
• sfdx rocko:project:dep [-c] [--json] [--loglevel trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL]
• sfdx rocko:project:order [-c] [--json] [--loglevel trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL]

sfdx rocko:meta:remove -s <string> -t <string> [-c] [--json] [--loglevel trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL]

removes all douplicates from source dir that exists as metadata in target dir

USAGE
  $ sfdx rocko:meta:remove -s <string> -t <string> [-c] [--json] [--loglevel 
  trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL]

OPTIONS
  -c, --change                                                                      remove metadata from default/input
                                                                                    path

  -s, --sourcedir=sourcedir                                                         (required) required source dir path
                                                                                    to search for duplicates.several
                                                                                    path possible with ','delimiter

  -t, --targetdir=targetdir                                                         (required) required target dir path
                                                                                    to check the results from source
                                                                                    dir.several path possible with
                                                                                    ','delimiter

  --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

EXAMPLES
  sfdx rocko:meta:remove -- sourcedir 'force-app' --targetdir 'src'
  sfdx rocko:meta:remove -s 'force-app' -t 'src -c

See code: src/commands/rocko/meta/remove.ts

sfdx rocko:project:dep [-c] [--json] [--loglevel trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL]

So that a package can be deployed and validated, the dependencies for the dependencies must also be stored in the sfdx-project.json file. This command checks the dependencies for the dependencies and outputs them in the terminal. The flag can also be used to update the sfdx directly.

USAGE
  $ sfdx rocko:project:dep [-c] [--json] [--loglevel 
  trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL]

OPTIONS
  -c, --change                                                                      add the missing dependencies of the
                                                                                    packages and updates the
                                                                                    sfdx-project.json

  --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

EXAMPLE
  sfdx rocko:project:dependency

See code: src/commands/rocko/project/dep.ts

sfdx rocko:project:order [-c] [--json] [--loglevel trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL]

The sequence is elementary when deploying and validating a package. The packages from the dependencies of a package must come first in order so that they can be deployed and validated first. This command checks the sfdx-project.json for the correct order and optionally corrects the sfdx-project.json directly.

USAGE
  $ sfdx rocko:project:order [-c] [--json] [--loglevel 
  trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL]

OPTIONS
  -c, --change                                                                      Corrects the order of the packages
                                                                                    and updates the sfdx-project.json

  --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

EXAMPLE
  sfdx rocko:project:order --change

See code: src/commands/rocko/project/order.ts

• sfdx rocko:meta:remove -s <string> -t <string> [-c] [--json] [--loglevel trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL]
• sfdx rocko:project:dep [-c] [--json] [--loglevel trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL]
• sfdx rocko:project:order [-c] [--json] [--loglevel trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL]

sfdx rocko:meta:remove -s <string> -t <string> [-c] [--json] [--loglevel trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL]

removes all douplicates from source dir that exists as metadata in target dir

USAGE
  $ sfdx rocko:meta:remove -s <string> -t <string> [-c] [--json] [--loglevel 
  trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL]

OPTIONS
  -c, --change                                                                      remove metadata from default/input
                                                                                    path

  -s, --sourcedir=sourcedir                                                         (required) required source dir path
                                                                                    to search for duplicates.several
                                                                                    path possible with ','delimiter

  -t, --targetdir=targetdir                                                         (required) required target dir path
                                                                                    to check the results from source
                                                                                    dir.several path possible with
                                                                                    ','delimiter

  --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

EXAMPLES
  sfdx rocko:meta:remove -- sourcedir 'force-app' --targetdir 'src'
  sfdx rocko:meta:remove -s 'force-app' -t 'src -c

See code: src/commands/rocko/meta/remove.ts

sfdx rocko:project:dep [-c] [--json] [--loglevel trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL]

So that a package can be deployed and validated, the dependencies for the dependencies must also be stored in the sfdx-project.json file. This command checks the dependencies for the dependencies and outputs them in the terminal. The flag can also be used to update the sfdx directly.

USAGE
  $ sfdx rocko:project:dep [-c] [--json] [--loglevel 
  trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL]

OPTIONS
  -c, --change                                                                      add the missing dependencies of the
                                                                                    packages and updates the
                                                                                    sfdx-project.json

  --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

EXAMPLE
  sfdx rocko:project:dependency

See code: src/commands/rocko/project/dep.ts

sfdx rocko:project:order [-c] [--json] [--loglevel trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL]

The sequence is elementary when deploying and validating a package. The packages from the dependencies of a package must come first in order so that they can be deployed and validated first. This command checks the sfdx-project.json for the correct order and optionally corrects the sfdx-project.json directly.

USAGE
  $ sfdx rocko:project:order [-c] [--json] [--loglevel 
  trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL]

OPTIONS
  -c, --change                                                                      Corrects the order of the packages
                                                                                    and updates the sfdx-project.json

  --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

EXAMPLE
  sfdx rocko:project:order --change

See code: src/commands/rocko/project/order.ts

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!