Skip to content

sfccdevops/sfcc-cartridge-overrides-vscode-extension

Repository files navigation

Project Support

If you or your company enjoy using this project, please consider supporting my work and joining my discord. 💖

Become a GitHub Sponsor Become a Patreon Sponsor Donate via PayPal Join Discord Community


Logo

SFCC Cartridge Overrides - VS Code Extension

VS Code Extension to Display SFCC Cartridge Overrides

  • Custom Panel for Displaying SFCC Cartridges with Overrides
  • Uses your Cartridge Path to Determine Override Order
  • Supports Controllers, Models, Scripts & Templates
  • Easily Generate Diffs Between Overrides
  • Contextual Listing by Override Type

Cartridge Path Panel

Show your Cartridge in the Correct Order, and optionally filter to only show Overrides.

screenshot-list

Each Cartridge contains Controllers, Models, Scripts & Templates.

templates-list

Indicator Meanings:

  • Indicates how many Overrides were found Left of the Selected Cartridge
  • Indicates how many Overrides were found Right of the Selected Cartridge
  • On a Folder, & indicate the Total Number of Overrides Within the Folder
  • On a File, & indicate the Total Number of Overrides in the Cartridge Path

Overrides Panel

Once you select a file, view any overrides or files that override your chosen file.

screenshot-overrides

Within the Overrides Panel, select Two Files & Right Click to Create a DIFF.

create-diff

Indicator Meanings:

  • The Bottom File is furthest to the Right in the Cartridge Path
  • The Top File is furthest to the Left in the Cartridge Path
  • Arrow Indicator means the file is overwriting the file beneath it
  • A Green Icon indicates the Current Selected File

Text Editor

Anytime you are editing a file that might have an override, and you do not already have the Overrides Panel open, look for this icon in the Top Right of VS Code. Clicking it will check for any overrides related to the current file you are editing.

launch-overrides

Need Help?

Check out or Troubleshooting Page for help with any known issues or report new ones.

Create Issue

About the Author

Peter Schmalfeldt is a Certified Senior Salesforce Commerce Cloud Developer with over 20 years of experience building eCommerce websites, providing everything you need to design, develop & deploy eCommerce applications for Web, Mobile & Desktop platforms.

Disclaimer

The trademarks and product names of Salesforce®, including the mark Salesforce®, are the property of Salesforce.com. SFCC DevOps is not affiliated with Salesforce.com, nor does Salesforce.com sponsor or endorse the SFCC DevOps products or website. The use of the Salesforce® trademark on this project does not indicate an endorsement, recommendation, or business relationship between Salesforce.com and SFCC DevOps.