Module Resolution

SFCC's require doesn't work like Node. */ searches the cartridge path of the current site, ~/ stays in the current cartridge and module.superModule reaches the next copy of the same file. Intellij SFCC resolves these paths the way the server does, so completion, Go to Declaration and types land on the file the storefront would load

STstorefrontSandbox 01version2

Cart.js

1'use strict';

2

3var server = require('server');

4var productHelpers = require('*/cartridge/scripts/helpers/productHelpers');

5

6server.extend(module.superModule);

CtrlClick

Cartridge path of RefArchrequire('*/…') checks every cartridge from the left and takes the first one that has the file

app_customno matching file:int_paypalno matching file:app_storefront_basescripts/helpers/productHelpers.js

Opens app_storefront_base/cartridge/scripts/helpers/productHelpers.js

app_customcartridgecontrollersCart.jsRefArch (3)LFUTF-8

Require paths

require loads .js, .ds and .json files, so completion offers all three and leaves the extension out when you accept one, the same way the server looks them up

Complete paths

STstorefrontSandbox 01version2

Cart.js

1'use strict';

2

3var server = require('server');

4var basketHelpers = require('*/cartridge/scripts/helpers/basketHelpers');

basketCalculationHelpersapp_storefront_base

basketValidationHelpersapp_storefront_base

basketHelpersapp_custom

CtrlSpace

storefrontapp_customcartridgeCart.jsGlobal scopeLFUTF-8

Start typing inside require('') and press Ctrl+Space:

• An empty or one-word path lists your linked cartridges, marked Cartridge, and the B2C modules and global modules you can require by name
• After */, ~/, ./ or a cartridge name, completion walks the folders and files below it
• Each item shows the cartridge or module that owns it, so you can tell app_custom from app_storefront_base before you accept

Only linked cartridges and modules are offered. Link a missing one in Cartridges & Modules

Go to the file the server loads

Cmd+Click or Cmd+B (Ctrl+Click or Ctrl+B) on a require path opens its target. A */ path usually exists in several cartridges, and what you get depends on the site scope:

Pick the site you are working on in the status bar to make navigation match the storefront

module.superModule

module.superModule is the module that the current file overrides: the same path in a cartridge further right on the cartridge path. It is how SFRA overrides extend the original instead of copying it

'use strict';

var base = module.superModule;

function getBadge(product) {
    return product.custom.badgeText || null;
}

base.getBadge = getBadge;

module.exports = base;

With a site scope selected, superModule resolves to the same file in the cartridges to the right of the current one on that site's path. In Global scope it resolves to the copies in your linked cartridges, with app_storefront_base first. Either way, base. completes the functions the original exports, and Cmd+Click on superModule opens the original

Controllers use the same mechanism with server.extend(module.superModule), then server.append, server.prepend and server.replace complete the routes of the original controller, see SFCC Contracts. Overrides creates both kinds of file for you

B2C modules and global modules

A bare require('server') doesn't point into a cartridge. On the server it loads a top-level folder next to your cartridges or a package in the special modules folder. In the IDE these come from the roots you mark yourself:

Root	Mark it with	Then
B2C Module Root	Mark Directory as › B2C Module Root	Its scripts complete by module name, with the module icon
Modules (Global Modules) Root	Mark Directory as › Modules (Global Modules) Root	Its packages complete by name, for example server from SFRA's modules/server

See Cartridges & Modules for the rules

Troubleshooting

Related