🦫 SFCC Beaver
Swiss-knife extension for SFCC developers
Currently supports:
- easy overriding files from one cartridge to another with
- copying file path/require/include into clipboard so it can be quickly inserted to other file
- built-in documentation search.
- this feature temporary not available due to recent documentation portal migration, but it will be back soon.
💡Compatibility
Beaver fully supports only SFRA projects. However, some of the feature are compatible with SiteGen as well.
⭐ Usage
Use top VS Code panel to easily create a copy of an active file in another cartridge
or copy current file path into clipboard
💡 You can use Command Pallette to do it even quicker.
Commands
Beaver adds several new commands that you can run manually.
To run a command you need to open the command pallette (press F1
or Ctrl + Shift + P
) and enter the command name.
- ▰ Extract Swiss-kni command copies to clipboard require of the file depends on type.
- for scripts file copy require:
var fileName = require('*/filePath')
- for templates file copy isinclude:
<isinclude template='templatePath' />
- for resource properties file copy active line as
Resource.msg('{activeLinePropName}', '{fileName}', null)
- ▰ Copy unix path command copies file path relatively to the project root folder.
- ▰ Override command overrides current file to another cartridge
Beaver Dam
Beaver introduces a new side section called Beaver Dam. There are two items currently:
- Cartridges is a active cartridge list where you can pin/unpin cartridge for overriding.
- Documentation. Search in docs without leaving VS Code.
Hovers
If you hover over the API class such as require('dw/web/URLUtils')
you see a tip with ▰ Open docs
suggestion. Clicking it will open corresponding documentation topic.
👍 Recommendations
Install the icons extension 🦫 SFCC Beaver - Icons to make your project look better.
📨 Feedback
Found a 🪲bug or want to improve something? Feel free to open an issue on GitHub: https://github.com/foegit/sfcc-beaver/issues