sfdx_force_source_clean

sfdx_force_source_clean

• Debugging your plugin

$ npm install -g sfdx_force_source_clean
$ sfdx COMMAND
running command...
$ sfdx (--version)
sfdx_force_source_clean/0.0.1 darwin-x64 node-v17.8.0
$ sfdx --help [COMMAND]
USAGE
  $ sfdx COMMAND
...

• sfdx force:source:clean [-x <string>] [-n] [-u <string>] [--apiversion <string>] [--json] [--loglevel trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL]

sfdx force:source:clean [-x <string>] [-n] [-u <string>] [--apiversion <string>] [--json] [--loglevel trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL]

Runs 'sfdx force:source:retrieve -x manifest/package.xml' AND deletes any source no longer found in the org

USAGE
  $ sfdx force:source:clean [-x <string>] [-n] [-u <string>] [--apiversion <string>] [--json] [--loglevel
    trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL]

FLAGS
  -n, --noprompt                                                                    Skips the warning and 'continue'
                                                                                    prompt.  Only use if you already
                                                                                    understand the impacts!
  -u, --targetusername=<value>                                                      username or alias for the target
                                                                                    org; overrides default target org
  -x, --manifest=<value>                                                            [default: manifest/package.xml] The
                                                                                    complete path for the manifest
                                                                                    (package.xml) file that specifies
                                                                                    the components to retrieve.
  --apiversion=<value>                                                              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

DESCRIPTION
  Runs 'sfdx force:source:retrieve -x manifest/package.xml' AND deletes any source no longer found in the org

EXAMPLES
  $ sfdx force:source:clean --targetusername username_alias -x manifest/package.xml

  $ sfdx force:source:clean --noprompt

See code: src/commands/force/source/clean.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:

• Start the inspector

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

$ sfdx hello:org -u [e-mail] --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 [e-mail]

• Set some breakpoints in your command code
• Click on the Debug icon in the Activity Bar on the side of VS Code to open up the Debug view.
• In the upper left hand corner of VS Code, verify that the "Attach to Remote" launch configuration has been chosen.
• 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.
• 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!