@forcexp/fflib-codegen
v0.0.0
Published
SFDX to create data access code based on Financial Force Library (https://github.com/financialforcedev/fflib-apex-common).
Downloads
45
Readme
fflib-codegen
SFDX to create data access code based on Financial Force Library (https://github.com/financialforcedev/fflib-apex-common).
$ npm install -g fflib-codegen
$ fflib-codegen COMMAND
running command...
$ fflib-codegen (-v|--version|version)
fflib-codegen/0.0.0 darwin-x64 node-v8.15.1
$ fflib-codegen --help [COMMAND]
USAGE
$ fflib-codegen COMMAND
...
fflib-codegen fflib:code:generate [FILE]
fflib-codegen fflib:init [FILE]
fflib-codegen fflib:install [FILE]
fflib-codegen hello:org [FILE]
fflib-codegen fflib:code:generate [FILE]
print a greeting and your org IDs
USAGE
$ fflib-codegen fflib:code:generate [FILE]
OPTIONS
-e, --sobject-set=sobject-set API name of the SObject.
-o, --output-dir=output-dir API name of the SObject.
-s, --sobject-api-name=sobject-api-name API name of the SObject.
-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
EXAMPLES
Example 1
Example 2
See code: src/commands/fflib/code/generate.ts
fflib-codegen fflib:init [FILE]
print a greeting and your org IDs
USAGE
$ fflib-codegen fflib:init [FILE]
OPTIONS
-o, --output-dir=output-dir API name of the SObject.
-s, --sobject-api-name=sobject-api-name API name of the SObject.
-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
EXAMPLES
Example 1
Example 2
See code: src/commands/fflib/init.ts
fflib-codegen fflib:install [FILE]
print a greeting and your org IDs
USAGE
$ fflib-codegen fflib:install [FILE]
OPTIONS
-o, --output-dir=output-dir API name of the SObject.
-s, --sobject-api-name=sobject-api-name API name of the SObject.
-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
EXAMPLES
Example 1
Example 2
See code: src/commands/fflib/install.ts
fflib-codegen hello:org [FILE]
print a greeting and your org IDs
USAGE
$ fflib-codegen hello:org [FILE]
OPTIONS
-f, --force example boolean flag
-n, --name=name name to print
-u, --targetusername=targetusername username or alias for the target org; overrides default target org
-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
EXAMPLES
$ sfdx hello:org --targetusername [email protected] --targetdevhubusername [email protected]
Hello world! This is org: MyOrg and I will be around until Tue Mar 20 2018!
My hub org id is: 00Dxx000000001234
$ sfdx hello:org --name myname --targetusername [email protected]
Hello myname! This is org: MyOrg and I will be around until Tue Mar 20 2018!
See code: src/commands/hello/org.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 [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]
- 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!