@conseq/sfdx-translation-plugin v0.7.0

sfdx-translation-plugin

• Debugging your plugin

$ npm install -g @conseq/sfdx-translation-plugin
$ sfdx COMMAND
running command...
$ sfdx (-v|--version|version)
@conseq/sfdx-translation-plugin/0.6.0 darwin-x64 node-v12.13.1
$ sfdx --help [COMMAND]
USAGE
  $ sfdx COMMAND
...

• sfdx csq:translation:progress -i <filepath> -l <filepath> [-o <filepath>] [--json] [--loglevel trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL]

sfdx csq:translation:progress -i <filepath> -l <filepath> [-o <filepath>] [--json] [--loglevel trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL]

Command description

USAGE
  $ sfdx csq:translation:progress -i <filepath> -l <filepath> [-o <filepath>] [--json] [--loglevel 
  trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL]

OPTIONS
  -i, --input=input                                                                 (required) Path to a translation
                                                                                    file, or directory of translation
                                                                                    files, to be processed

  -l, --labels=labels                                                               (required) Path to a file of listing
                                                                                    the relevant labels

  -o, --output=output                                                               (optional) Path to a directory in
                                                                                    which to write a detailed report for
                                                                                    each translation file processed

  --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 csq:translation:progress -i /translations -l labels.txt
     Process a single translation file and print a report to the console
  
  sfdx csq:translation:progress -i /translations -l labels.txt -o /translations/report
     Process all translation files in the directory /translations, listing a summary to the console
     and writing a report for each file to the directory /translations/report

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!