bbpdf

Plugin to generate PDF documents

• Debugging your plugin

$ npm install -g bbpdf
$ sfdx COMMAND
running command...
$ sfdx (-v|--version|version)
bbpdf/1.0.0 darwin-x64 node-v12.18.0
$ sfdx --help [COMMAND]
USAGE
  $ sfdx COMMAND
...

• sfdx bbpdf:pdf [-t <string>] [-d <string>] [-o <string>] [-s <string>] [-q <string>] [-f <string>] [-v <string>] [-u <string>] [--apiversion <string>] [--json] [--loglevel trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL]
• sfdx hello:org [-n <string>] [-f] [-v <string>] [-u <string>] [--apiversion <string>] [--json] [--loglevel trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL]

sfdx bbpdf:pdf [-t <string>] [-d <string>] [-o <string>] [-s <string>] [-q <string>] [-f <string>] [-v <string>] [-u <string>] [--apiversion <string>] [--json] [--loglevel trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL]

generate a PDF from an EJS template and SOQL queries

USAGE
  $ sfdx bbpdf:pdf [-t <string>] [-d <string>] [-o <string>] [-s <string>] [-q <string>] [-f <string>] [-v <string>] [-u 
  <string>] [--apiversion <string>] [--json] [--loglevel 
  trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL]

OPTIONS
  -d, --template-dir=template-dir                                                   template directory name

  -f, --query-file=query-file                                                       File containing a collection of SOQL
                                                                                    queries for sobjects required by the
                                                                                    template - specify this, or an
                                                                                    sobject and related query

  -o, --output=output                                                               output file name

  -q, --query=query                                                                 SOQL query to execute for the
                                                                                    sobject - specify this and an
                                                                                    sobject, or the queries file

  -s, --sobject=sobject                                                             sobject name for the template fields
                                                                                    - specify this and a query, or the
                                                                                    queries file

  -t, --template=template                                                           template file name

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

  -v, --targetdevhubusername=targetdevhubusername                                   username or alias for the dev hub
                                                                                    org; overrides default dev hub 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

EXAMPLES
  $ sfdx bbpdf:pdf -u [email protected] -d ./templates -t contact.ejs -o ./contact.pdf -s contact
        -q "select Title, FirstName, LastName, Account.Name from Contact where id='00380000023TUDeAAO'"
  PDF file succesfully written to ./contact.pdf
  
  $ sfdx bbpdf:pdf -u [email protected] -d ../templates -t opportunity.ejs -o ./opportunity.pdf -f ./queries.json
  PDF file succesfully written to ./opportunity.pdf

See code: lib/commands/bbpdf/pdf.js

sfdx hello:org [-n <string>] [-f] [-v <string>] [-u <string>] [--apiversion <string>] [--json] [--loglevel trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL]

print a greeting and your org IDs

USAGE
  $ sfdx hello:org [-n <string>] [-f] [-v <string>] [-u <string>] [--apiversion <string>] [--json] [--loglevel 
  trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL]

OPTIONS
  -f, --force                                                                       example boolean flag
  -n, --name=name                                                                   name to print

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

  -v, --targetdevhubusername=targetdevhubusername                                   username or alias for the dev hub
                                                                                    org; overrides default dev hub 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

EXAMPLES
  $ sfdx hello:org --targetusername [email protected] --targetdevhubusername [email protected]
     Hello world! This is org: MyOrg and I will be around until Tue Mar 20 2018!
     My hub org id is: 00Dxx000000001234
  
  $ sfdx hello:org --name myname --targetusername [email protected]
     Hello myname! This is org: MyOrg and I will be around until Tue Mar 20 2018!

See code: lib/commands/hello/org.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 [email protected] --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 [email protected]

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!