Scratcher is a helper plugin to facilitate the creation of Scratch orgs which use Package2
$ npm install -g sfdx-plugin-scratcher
$ sfdx-plugin-scratcher COMMAND
running command...
$ sfdx-plugin-scratcher (-v|--version|version)
sfdx-plugin-scratcher/0.0.1 darwin-x64 node-v8.9.4
$ sfdx-plugin-scratcher --help [COMMAND]
USAGE
$ sfdx-plugin-scratcher COMMAND
...bump the major/minor version number in the packageDirectory
USAGE
$ sfdx-plugin-scratcher scratcher:bump
OPTIONS
-M, --major Bump the major version by 1, sets minor,build to 0
-m, --minor Bump the minor version by 1
-p, --patch Bump the patch version by 1
-t, --target=target [default: force-app] name of your package directory (defaults to
force-app)
--json format output as json
--loglevel=(trace|debug|info|warn|error|fatal) logging level for this command invocation
EXAMPLES
sfdx scratcher:bump -m
// bump the minor version up by one (and set patch to 0)
sfdx scratcher:bump -M
// bump the major version up by one (and set minor/patch to 0)
sfdx scratcher:bump -p
// bump the patch version up by one
See code: src/commands/scratcher/bump.ts
Create a scratch org, install deps & pushes code
USAGE
$ sfdx-plugin-scratcher scratcher:create
OPTIONS
-d, --days=days [default: 14] Days for the sandbox to live
-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) logging level for this command invocation
EXAMPLE
$ sfdx scratcher:create
It will create the scratch orgs, install all of the dependancies, push the source code and assign the
permssion of the app
See code: src/commands/scratcher/create.ts
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 [email protected] --dev-suspendAlternatively, 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]- 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!
