Salesforce Reference Cleaner for VS Code

This VS Code extension simplifies the process of removing specific metadata references from Salesforce Profiles and Permission Sets. It is particularly useful for Salesforce developers and administrators who need to clean up profiles and permission sets by removing outdated or unused references without manually editing XML files.

Features

• Remove References: Automatically detects and removes specified references from Salesforce Profiles and Permission Sets.
• Modify References: Allows modification of existing references in Salesforce Profiles and Permission Sets.
• Batch Processing: Supports processing multiple files at once.
• Backup Creation: Optionally creates backup copies of original files before modifying them.
• User-Friendly Interface: Provides a clean and intuitive interface for selecting references and confirming deletions.

Installation

To install the Salesforce Reference Cleaner, follow these steps:

1. Open Visual Studio Code.
2. Go to the Extensions view by clicking on the square icon on the sidebar or pressing Ctrl+Shift+X.
3. Search for Salesforce Reference Cleaner.
4. Click on Install.

Alternatively, you can install the extension via the command palette:

1. Open the command palette with Ctrl+Shift+P.
2. Type ext install followed by the extension identifier (e.g., VSCodePublisherSudhansu.sfparty).

Usage

To use the extension, follow these steps:

1. Open the folder containing your Salesforce metadata in VS Code.
2. Right-click on a Profile or Permission Set file, or select multiple files in the Explorer.
3. Choose the desired command from the context menu (e.g., Remove References, Modify References, Remove File and References).
4. In the UI that appears, select the references you want to remove or modify.
5. Confirm your choices, and let the extension handle the removal, modification, and backup.

Configuration Options

This extension can be configured in your workspace or user settings. The following options are available:

• salesforceReferenceCleaner.backupEnabled: Set to true to enable backup before modifications. Default is false.
• salesforceReferenceCleaner.backupFolder: Specify the folder path to save backups.

Logging

The extension uses a logging utility to provide meaningful log messages with appropriate log levels (info, warn, error). Logs are displayed in the sfparty output channel.

Support

For support, feature requests, or bug reporting, please visit the GitHub repository and submit an issue.

Contributing

Contributions are welcome! Please read the CONTRIBUTING.md file for guidelines on how to submit pull requests.

License

This extension is licensed under the MIT License.