RFLIB Plugin for Salesforce CLI

Plugin for Salesforce CLI to help with the adoption of RFLIB - an open-source logging framework for Salesforce.

Features

• Automatically instruments Apex classes with RFLIB logging statements
• Automatically instruments LWC components with RFLIB logging statements
• Automatically instruments Aura components with RFLIB logging statements
• Automatically instruments Salesforce Flows with RFLIB logging actions

Installation

sf plugins install rflib-plugin

Commands

sf rflib logging apex instrument

Adds RFLIB logging statements to Apex classes.

# Add logging to all classes in a directory
sf rflib logging apex instrument --sourcepath force-app

# Preview changes without modifying files
sf rflib logging apex instrument --sourcepath force-app --dryrun

# Format modified files with Prettier
sf rflib logging apex instrument --sourcepath force-app --prettier

# Skip instrumenting files where logging is already present
sf rflib logging apex instrument --sourcepath force-app --skip-instrumented

Command Options

• --sourcepath (-s): Directory containing Apex classes to instrument
• --dryrun (-d): Preview changes without modifying files
• --prettier (-p): Format modified files using Prettier
• --skip-instrumented: Do not instrument files where RFLIB logging is already present

sf rflib logging lwc instrument

Adds RFLIB logging statements to Lightning Web Components.

# Add logging to all LWC files
sf rflib logging lwc instrument --sourcepath force-app

# Preview changes without modifying files
sf rflib logging lwc instrument --sourcepath force-app --dryrun

# Add logging and format code
sf rflib logging lwc instrument --sourcepath force-app --prettier

# Skip instrumenting files where logging is already present
sf rflib logging lwc instrument --sourcepath force-app --skip-instrumented

Command Options

• --sourcepath (-s): Directory containing LWC components to instrument
• --dryrun (-d): Preview changes without modifying files
• --prettier (-p): Format modified files using Prettier
• --skip-instrumented: Do not instrument files where RFLIB logging is already present

sf rflib logging aura instrument

Adds RFLIB logging statements to Aura Components.

# Add logging to all Aura component files
sf rflib logging aura instrument --sourcepath force-app

# Preview changes without modifying files
sf rflib logging aura instrument --sourcepath force-app --dryrun

# Add logging and format code
sf rflib logging aura instrument --sourcepath force-app --prettier

# Skip instrumenting files where logging is already present
sf rflib logging aura instrument --sourcepath force-app --skip-instrumented

Command Options

• --sourcepath (-s): Directory containing Aura components to instrument
• --dryrun (-d): Preview changes without modifying files
• --prettier (-p): Format modified files using Prettier
• --skip-instrumented: Do not instrument files where RFLIB logging is already present

sf rflib logging flow instrument

Adds RFLIB logging actions to Salesforce Flows and optimizes flow layout.

# Add logging to all Flow files
sf rflib logging flow instrument --sourcepath force-app

# Preview changes without modifying files
sf rflib logging flow instrument --sourcepath force-app --dryrun

# Skip instrumenting flows where logging is already present
sf rflib logging flow instrument --sourcepath force-app --skip-instrumented

Command Options

• --sourcepath (-s): Directory containing Flow files to instrument
• --dryrun (-d): Preview changes without modifying files
• --skip-instrumented: Do not instrument files where RFLIB logging is already present

Features

• Adds logging for flow invocation at the start of the flow
• Adds logging for decision paths to track which branch is executed
• Sets the flow's CanvasMode to AUTO_LAYOUT_CANVAS for better visualization in Flow Builder
• Preserves the original processType value
• Handles both free-form and auto-layout flows, converting all to auto-layout
• Supports both standard Flows (processType="Flow") and Auto-Launched Flows (processType="AutoLaunchedFlow")

Contributing

1. Fork the repository
2. Create a feature branch
3. Make your changes
4. Submit a pull request

Learn More

• RFLIB Documentation
• Salesforce CLI Plugin Developer Guide