force-fiesta

The Force-Fiesta plugin is a tool for Salesforce developers that provides commands to enable and disable debugging for both Apex and Lightning components in a Salesforce organization.

Install

sf plugins install [email protected]

Issues

Please report any issues at https://github.com/payensa-sf/force-fiesta/issues

Contributing

1. Create a new issue before starting your project so that we can keep track of what you are trying to add/fix. That way, we can also offer suggestions or let you know if there is already an effort in progress.
2. Fork this repository.
3. Build the plugin locally
4. Create a topic branch in your fork. Note, this step is recommended but technically not required if contributing using a fork.
5. Edit the code in your fork.
6. Write appropriate tests for your changes. Try to achieve at least 95% code coverage on any new code. No pull request will be accepted without unit tests.
7. Send us a pull request when you are done. We'll review your code, suggest any needed changes, and merge it in.

Build

To build the plugin locally, make sure to have yarn installed and run the following commands:

# Clone the repository
git clone [email protected]:payensa-sf/force-fiesta

# Install the dependencies and compile
yarn && yarn build

To use your plugin, run using the local ./bin/dev or ./bin/dev.cmd file.

# Run using local run file.
./bin/dev debug apex start

There should be no differences when running via the Salesforce CLI or using the local run file. However, it can be useful to link the plugin to do some additional testing or run your commands from anywhere on your machine.

# Link your plugin to the sf cli
sf plugins link .
# To verify
sf plugins

Commands

• sf debug apex start
• sf debug apex stop
• sf debug lightning start
• sf debug lightning stop

sf debug apex start

Starts the debugging session for Apex code execution in Salesforce.

USAGE
  $ sf debug apex start [--json] [--flags-dir <value>] [-o <value>] [--api-version <value>]

FLAGS
  -o, --target-org=<value>
      --api-version=<value>  Override the api version used for api requests made by this command

GLOBAL FLAGS
  --flags-dir=<value>  Import flag values from a directory.
  --json               Format output as json.

DESCRIPTION
  Starts the debugging session for Apex code execution in Salesforce.

  The command enables debug logs for Apex code execution in a Salesforce organization. It checks if a TraceFlag exists for the user. If not, it creates a new DebugLevel and TraceFlag.
  If a TraceFlag already exists, it updates the TraceFlag if necessary. The command sets the debug level values for ApexCode to 'FINEST' and Visualforce to 'FINER'. This command is
  essential for debugging Apex code in Salesforce if you regularly use the Apex Replay Debugger Visual Studio Code extension.

EXAMPLES
  $ sf debug apex start

sf debug apex stop

Stops the debugging session for Apex code execution in Salesforce.

USAGE
  $ sf debug apex stop [--json] [--flags-dir <value>] [-o <value>] [--api-version <value>]

FLAGS
  -o, --target-org=<value>
      --api-version=<value>  Override the api version used for api requests made by this command

GLOBAL FLAGS
  --flags-dir=<value>  Import flag values from a directory.
  --json               Format output as json.

DESCRIPTION
  Stops the debugging session for Apex code execution in Salesforce.

  The command disables debug logs for Apex code execution in a Salesforce organization. It checks if a TraceFlag exists for the user. If a TraceFlag exists, it removes it from the org.

EXAMPLES
  $ sf debug apex stop

sf debug lightning start

Starts the debugging session for Lightning code execution in Salesforce.

USAGE
  $ sf debug lightning start [--json] [--flags-dir <value>] [-o <value>] [--api-version <value>]

FLAGS
  -o, --target-org=<value>
      --api-version=<value>  Override the api version used for api requests made by this command

GLOBAL FLAGS
  --flags-dir=<value>  Import flag values from a directory.
  --json               Format output as json.

DESCRIPTION
  Starts the debugging session for Lightning code execution in Salesforce.

  The command enables debug mode for the user in a Salesforce organization.

EXAMPLES
  $ sf debug lightning start

sf debug lightning stop

Stops the debugging session for Lightning code execution in Salesforce.

USAGE
  $ sf debug lightning stop [--json] [--flags-dir <value>] [-o <value>] [--api-version <value>]

FLAGS
  -o, --target-org=<value>
      --api-version=<value>  Override the api version used for api requests made by this command

GLOBAL FLAGS
  --flags-dir=<value>  Import flag values from a directory.
  --json               Format output as json.

DESCRIPTION
  Stops the debugging session for Lightning code execution in Salesforce.

  The command disables debug mode for the user in a Salesforce organization.

EXAMPLES
  $ sf debug lightning stop

Contributing

Contributions are welcome! Please read our Contributing Guide for more information.

License

This project is licensed under the 3-Clause BSD License.