migration-builder

SFDX Plugin to generate migration files from Excel

• Debugging your plugin

$ npm install -g migration-builder
$ sfdx COMMAND
running command...
$ sfdx (--version)
migration-builder/0.0.5 darwin-arm64 node-v16.17.0
$ sfdx --help [COMMAND]
USAGE
  $ sfdx COMMAND
...

• sfdx migration:build -s <filepath> -t <directory> -p <integer> [-m] [--json] [--loglevel trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL]
• sfdx migration:numbercsv -d <filepath> -o <array> [--json] [--loglevel trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL]

sfdx migration:build -s <filepath> -t <directory> -p <integer> [-m] [--json] [--loglevel trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL]

Generate migration files from Excel

USAGE
  $ sfdx migration:build -s <filepath> -t <directory> -p <integer> [-m] [--json] [--loglevel
    trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL]

FLAGS
  -m, --mergemappingsbyobject                                                       merge different mappings for the
                                                                                    same object into a single file
  -p, --startingsheet=<value>                                                       (required) sheet index to start
                                                                                    generating files. The index for the
                                                                                    first sheet is 1
  -s, --source=<value>                                                              (required) path to the .xlsx Excel
                                                                                    file
  -t, --target=<value>                                                              (required) directory where files
                                                                                    will be generated
  --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
  Generate migration files from Excel

EXAMPLES
  $ sfdx migration:build -s "/Users/jesus_blanco/Downloads/Migration Builder.xlsx" -t /Users/jesus_blanco/Desktop/results -p 3

See code: src/commands/migration/build.ts

sfdx migration:numbercsv -d <filepath> -o <array> [--json] [--loglevel trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL]

Append number prefix for csv files

USAGE
  $ sfdx migration:numbercsv -d <filepath> -o <array> [--json] [--loglevel
    trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL]

FLAGS
  -d, --directory=<value>                                                           (required) directory containing csv
                                                                                    files
  -o, --objectsorder=<value>                                                        (required) comma-separated list with
                                                                                    object api names in order. Example:
                                                                                    Account,Contact,Case will result in
                                                                                    1-Account.csv, 2-Contact.csv,
                                                                                    3-Case.csv
  --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
  Append number prefix for csv files

EXAMPLES
  $ sfdx migration:numbercsv -d /Users/jesus_blanco/Desktop/results -o Account,Contact,Case

See code: src/commands/migration/numbercsv.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 [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]

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!