dansad / ds-sfdx-plugins

SFDX Plugins

• Debugging your plugin

#install
sfdx plugins:install ds-sfdx-plugins

#install from source
git clone https://github.com/dansadsf/ds-sfdx-plugins.git
cd ds-sfdx-plugins
sfdx plugins:link

Permission Set Stuffer

Automatically add fields to your permission sets because you forgot to do it while you were working, or you're lazy. This is dangerous and cheeky.

USAGE
  $ sfdx ds:permset:stuff -p <array> [-e] [-f <string>] [-o <string>] [-n] [-r] [-d <string>] [-t <string>] [--json] 
  [--loglevel trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL]

OPTIONS
  -d, --readpermission=true|false                                                   [default: true] Allow read

  -e, --addeverything                                                               Add every field to permission set,
                                                                                    not just current branch

  -f, --permsetpath=permsetpath                                                     [default:
                                                                                    force-app/main/default/permissionset
                                                                                    s] The path to your Permission Set
                                                                                    metadata

  -n, --noprompt                                                                    Do the updates without prompting

  -o, --objectpath=objectpath                                                       [default:
                                                                                    force-app/main/default/objects] The
                                                                                    path to your Object metadata

  -p, --permissionset=permissionset                                                 (required) Comma seperated list of
                                                                                    Permission Set names

  -r, --printall                                                                    Print field names

  -t, --editpermission=true|false                                                   [default: true] Allow edit

  --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 ds:permset:stuff --permissionset Permission_Set_Devname,Other_Permission_Set 
  
  $ sfdx ds:permset:stuff --permissionset Permission_Set_Devname,Other_Permission_Set --addeverything

See code: lib/commands/ds/permset/stuff.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!