Skip to content

SFDX not compatible with a Metadata type you are using? Use this plugin to transparently use both SFDX and the MDAPI.

Notifications You must be signed in to change notification settings

curiousblueprints/mdapi-fallback

Repository files navigation

mdapi-fallback

Use in the exact same way you would sfdx force:source:pull, but it will also use the Metadata API to pull items that are problematic for you in SFDX.

=============

SFDX plugin that allows users to specify metadata types that should be pushed/pulled with MDAPI allowing for seamless use of SFDX with incompatbile types.

Version CircleCI Appveyor CI Codecov Greenkeeper Known Vulnerabilities Downloads/week License

$ npm install -g mdapi-fallback
$ mdapi-fallback COMMAND
running command...
$ mdapi-fallback (-v|--version|version)
mdapi-fallback/0.0.0 win32-x64 node-v9.11.1
$ mdapi-fallback --help [COMMAND]
USAGE
  $ mdapi-fallback COMMAND
...

mdapi-fallback curiousbp:source:pull

Retrieves metadata using both the Metadata API and SFDX depending on what you have specified.

USAGE
  $ mdapi-fallback curiousbp:source:pull

OPTIONS
  -u, --targetusername=targetusername             username or alias for the target org; overrides default target 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)  logging level for this command invocation

See code: src/commands/curiousbp/source/pull.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
  1. Set some breakpoints in your command code
  2. Click on the Debug icon in the Activity Bar on the side of VS Code to open up the Debug view.
  3. In the upper left hand corner of VS Code, verify that the "Attach to Remote" launch configuration has been chosen.
  4. 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.
  5. 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!

About

SFDX not compatible with a Metadata type you are using? Use this plugin to transparently use both SFDX and the MDAPI.

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published