reactforce

A framework for developing and deploying ReactJS applications on Salesforce.com

• Debugging your plugin
• Common Commands

$ npm install -g sfdx-react-plugin
$ sfdx COMMAND
running command...
$ sfdx (--version)
sfdx-react-plugin/1.1.1 linux-x64 node-v16.20.0
$ sfdx --help [COMMAND]
USAGE
  $ sfdx COMMAND
...

• sfdx reactforce [-v] [--json] [--loglevel trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL]
• sfdx reactforce:create -a <string> [-t <string>] [-r <string>] [-b <string>] [-c <string>] [-v] [--json] [--loglevel trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL]
• sfdx reactforce:init [-s <string>] [-r <string>] [-b <string>] [--json] [--loglevel trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL]

sfdx reactforce [-v] [--json] [--loglevel trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL]

print welcome message and reactforce version

USAGE
  $ sfdx reactforce [-v] [--json] [--loglevel
    trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL]

FLAGS
  -v, --version                                                                     version to print
  --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
  print welcome message and reactforce version

EXAMPLES
  $ sfdx reactforce

  $ sfdx reactforce --version

See code: src/commands/reactforce.ts

sfdx reactforce:create -a <string> [-t <string>] [-r <string>] [-b <string>] [-c <string>] [-v] [--json] [--loglevel trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL]

Creates react app and prepares salesforce project for react app rendering.

USAGE
  $ sfdx reactforce create -a <string> [-t <string>] [-r <string>] [-b <string>] [-c <string>] [-v] [--json]
    [--loglevel trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL]

FLAGS
  -a, --app-name=<value>                                                            (required) React app name
  -b, --branch=<value>                                                              [default: main] Repository branch
                                                                                    name
  -c, --cra-template=<value>                                                        [default: cra-template] React app
                                                                                    custom template name
  -r, --repository=<value>                                                          [default:
                                                                                    cloudpremise/reactforce-templates]
                                                                                    Template repository name
  -t, --template-name=<value>                                                       [default: default] Template name for
                                                                                    salesforce and react custom files
  -v, --vanilla                                                                     Modify react app to allow custom
                                                                                    changes for salesforce
  --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
  Creates react app and prepares salesforce project for react app rendering.

EXAMPLES
  $ sfdx reactforce create

  $ sfdx reactforce create --app-name "ReactAppName"

  $ sfdx reactforce create -a="ReactAppName"

  $ sfdx reactforce create --app-name "ReactAppName" --template-name "default" --repository "cloudpremise/reactforce-templates" --branch "main"

  $ sfdx reactforce create -a="ReactAppName"-t="default" -r="cloudpremise/reactforce-templates" -b="main"

sfdx reactforce:init [-s <string>] [-r <string>] [-b <string>] [--json] [--loglevel trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL]

Initialize reactforce

USAGE
  $ sfdx reactforce init [-s <string>] [-r <string>] [-b <string>] [--json] [--loglevel
    trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL]

FLAGS
  -b, --branch=<value>                                                              [default: main] Branch name for
                                                                                    theme static resources
  -r, --repository=<value>                                                          [default:
                                                                                    cloudpremise/reactforce-assets]
                                                                                    Repository name for theme static
                                                                                    resources
  -s, --static-resources=<value>                                                    [default: /force-app/main/default/st
                                                                                    aticresources] Relative path for
                                                                                    static resources
  --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
  Initialize reactforce

EXAMPLES
  $ sfdx reactforce init

  $ sfdx reactforce init --static-resources "/force-app/main/default/staticresources" --repository "cloudpremise/reactforce-assets" --branch "main"

  $ sfdx reactforce init -s="/force-app/main/default/staticresources" -r="cloudpremise/reactforce-assets" -b="main"

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 reactforce:org command:

1. Start the inspector

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

$ sfdx reactforce: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 reactforce:org -u [email protected]

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!

#################################################################################################################

Common Commands

Test the plugin locally

sfdx plugins link .

Remove the linked plugin

sfdx plugins unlink .

See what plugins are installed

sfdx plugins

Install the latest plugin from npm

sfdx plugins install @cloudpremise/reactforce@latest

Install an older version of the plugin from npm

sfdx plugins install @cloudpremise/[email protected]