CodeLens Actions

CodeLens places small, clickable actions above the code they describe. The VS Code extension supplies these actions using language-server indexes, project metadata, and log analysis. They connect a file to its registrations, callers, overrides, or runtime issues

Enable Editor: Code Lens in VS Code settings. Open the relevant source file and let its project data finish indexing

Routes and SFRA extensions

Copy the endpointFind callersFollow the append

storefront

Explorer

storefront

cartridges

app_custom

cartridge

controllers

Product.js

scripts

app_storefront_base

cartridge

controllers

Product.js

templates

Product.jsProduct.js

cartridgesapp_customcartridgecontrollersProduct.js

1'use strict';

2

3var server = require('server');

4

Open Endpoint | Copy Endpoint URL | 2 usages | append (1)

5server.get('Show', function (req, res, next) {

6 res.render('product/productDetails');

7 next();

8});

9

10module.exports = server.exports();

productUrls.jscartridges/app_custom/cartridge/scripts/helpers - Locations (2)

2

3/** @param {string} id */

4function getProductUrl(id) {

5 return URLUtils.url('Product-Show', 'pid', id).toString();

6}

productUrls.jscartridges/app_custom/cartridge/scripts/helpers1

return URLUtils.url('Product-Show', 'pid', id).toString();

productTile.ismlcartridges/app_storefront_base/cartridge/templates/default/product1

<a href="${URLUtils.url('Product-Show', 'pid', product.id)}">

1var server = require('server');

2server.extend(module.superModule);

3

Open Endpoint | Copy Endpoint URL | 2 usages

4server.append('Show', function (req, res, next) {

5 res.setViewData({ showBadge: true });

6 next();

7});

8

9module.exports = server.exports();

Endpoint URL copied to clipboard: https://zzrx-001.dx.commercecloud.salesforce.com/on/demandware.store/Sites-RefArch-Site/default/Product-Show

Source: Salesforce B2C Commerce (Intellij SFCC)

main00Ln 4, Col 15UTF-8SFCC JavaScript

On indexed SFRA, SiteGenesis, and pipeline endpoints, the extension offers:

• Open Endpoint to open the route using the active connection and site context
• Copy Endpoint URL to copy the resolved endpoint address
• A usages count to inspect indexed callers
• On SFRA routes, append, prepend, and replace counts when those actions have indexed targets

For example, start at a base server.get('Show', …) in Product.js, then use the append lens to find a cartridge extending Product-Show. The usages lens connects the route to calls such as URLUtils.url('Product-Show', …)

Opening a URL is a browser request, not a debugger session or a request editor. Routes requiring POST data or authentication still need the appropriate caller. Debugging is a separate workflow

Hook implementations

A script registered in hooks.json gets a lens naming the hook it implements. Click it to open the registration in hooks.json

System hookCustom hook functions

storefront

Explorer

storefront

cartridges

app_custom

cartridge

scripts

hooks

calculate.js

loyalty.js

hooks.json

package.json

app_storefront_base

calculate.jshooks.jsonloyalty.js

app_customcartridgescriptshooksloyalty.js

1'use strict';

2

3var Status = require('dw/system/Status');

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

5

dw.order.calculate

6exports.calculate = function (basket) {

7 helpers.calculateTotals(basket);

8 return new Status(Status.OK);

9};

1'use strict';

2

3var Transaction = require('dw/system/Transaction');

4

app.loyalty.points → earn

5exports.earn = function (order) {

6 return Math.floor(order.totalGrossPrice.value);

7};

8

app.loyalty.points → redeem

9exports.redeem = function (customer, points) {

10 Transaction.wrap(function () {

11 customer.profile.custom.loyaltyPoints -= points;

12 });

13};

1{

2 "hooks": [

3 {

4 "name": "dw.order.calculate",

5 "script": "./cartridge/scripts/hooks/calculate.js"

6 },

7 {

8 "name": "app.loyalty.points",

9 "script": "./cartridge/scripts/hooks/loyalty.js"

10 }

11 ]

12}

mainLn 10, Col 1UTF-8SFCC JavaScript

Every exported function of a custom hook script gets its own lens, which helps when one script serves several hook functions. See Typed hooks for the matching completion and type behavior

Job step functions

Step-type lenses link an implementation back to steptypes.json. The lens reads step type → property, and clicking it opens that property in steptypes.json

Task-oriented stepChunk-oriented step

storefront

Explorer

storefront

cartridges

app_custom

cartridge

scripts

jobs

exportOrders.js

importProducts.js

package.json

steptypes.json

app_storefront_base

exportOrders.jssteptypes.jsonimportProducts.js

app_customcartridgescriptsjobsimportProducts.js

1'use strict';

2

3var Status = require('dw/system/Status');

4

custom.ExportOrders → function

5exports.execute = function (parameters, stepExecution) {

6 exportOrders(parameters.FolderPath);

7 return new Status(Status.OK);

8};

1'use strict';

2

custom.ImportProducts → readFunction

3exports.read = function () {

4 return products.hasNext() ? products.next() : null;

5};

6

custom.ImportProducts → processFunction

7exports.process = function (product) {

8 return mapProduct(product);

9};

10

custom.ImportProducts → writeFunction

11exports.write = function (chunk) {

12 chunk.toArray().forEach(saveProduct);

13};

1{

2 "step-types": {

3 "script-module-step": [

4 {

5 "@type-id": "custom.ExportOrders",

6 "module": "app_custom/cartridge/scripts/jobs/exportOrders.js",

7 "function": "execute"

8 }

9 ],

10 "chunk-script-module-step": [

11 {

12 "@type-id": "custom.ImportProducts",

13 "module": "app_custom/cartridge/scripts/jobs/importProducts.js",

14 "read-function": "read",

15 "process-function": "process",

16 "write-function": "write",

17 "chunk-size": 100

18 }

19 ]

20 }

21}

mainLn 9, Col 1UTF-8SFCC JavaScript

Chunk steps also label the optional totalCountFunction, beforeStepFunction, beforeChunkFunction, afterChunkFunction, and afterStepFunction. This lets you trace a helper-looking export back to the job-step contract that calls it

Custom API operations

Custom APIs span three files: api.json, an OpenAPI schema, and a script. Each file gets lenses that open the other two at the matching operation

api.json to the scriptScript to the schemaSchema back to api.json

storefront

Explorer

storefront

cartridges

app_custom

cartridge

controllers

rest-apis

loyalty

api.json

loyalty.js

schema.yaml

scripts

api.json

app_customcartridgerest-apisloyaltyapi.json

1{

2 "endpoints": [

3 {

GET

4 "endpoint": "getPoints",

/points

5 "schema": "schema.yaml",

6 "implementation": "loyalty"

7 }

8 ]

9}

1'use strict';

2

3var RESTResponseMgr = require('dw/system/RESTResponseMgr');

4

schema.yaml | api.json

5exports.getPoints = function () {

6 var points = customer.profile.custom.loyaltyPoints || 0;

7 RESTResponseMgr.createSuccess({ points: points }).render();

8};

9

10exports.getPoints.public = true;

1openapi: 3.0.0

2info:

3 title: Loyalty Points

4 version: 1.0.0

5paths:

6 /points:

loyalty.js | api.json

7 get:

8 operationId: getPoints

9 summary: Points balance of the current shopper

10 responses:

11 '200':

12 description: OK

mainLn 4, Col 13UTF-8JSON

Completion and definition navigation for the same files are described in SFCC contracts

Resource keys

UsagesLocalizations

storefront

checkout.properties

app_customcartridgetemplatesresourcescheckout.properties

1# Checkout

2 usages | 3 localizations

2button.place.order=Place your order

2 usages | 4 localizations

3heading.checkout=Checkout

3 usages | 4 localizations

4error.payment.not.valid=Please check your payment information.

4 usages | 4 localizations

5label.order.summary=Order Summary

placeOrder.ismlapp_custom/cartridge/templates/default/checkout - Locations (2)

10<div class="place-order">

11 <button class="btn btn-primary place-order" type="submit">

12 ${Resource.msg('button.place.order', 'checkout', null)}

13 </button>

14</div>

placeOrder.ismlapp_custom/cartridge/templates/default/checkout1

${Resource.msg('button.place.order', 'checkout', null)}

CheckoutServices.jsapp_custom/cartridge/controllers1

Resource.msg('button.place.order', 'checkout', null)

checkout.properties

button.place.order2 usages

1app_customCurrent3 filescartridges/app_custom

checkout.propertiesDefault

Place your order

checkout_de.propertiesGerman

Bestellung aufgeben

checkout_fr.propertiesMissingFrench

3app_storefront_base1 filecartridges/app_storefront_base

checkout.propertiesOverridden by app_customDefault

Place Order

mainLn 3, Col 1UTF-8Properties

Every key of a .properties file under cartridge/templates/resources gets two lenses in the text editor:

The localizations count is the number of files of the bundle, across locales and cartridges, that define the key. Lenses show in the active editor only, and refresh as you type

A zero count describes the current local index. It does not prove a key is unused, because keys built at runtime are not counted

Metadata attributes

An attribute definition in metadata XML shows Indexing usages… while its usage data is being prepared, then an N usages lens. Click it to peek every reference to that attribute

Index usagesPeek references

storefront

Explorer

storefront

cartridges

site_template

meta

custom-objecttype-definitions.xml

system-objecttype-extensions.xml

sites

system-objecttype-extensions.xml

site_templatemetasystem-objecttype-extensions.xml

1<?xml version="1.0" encoding="UTF-8"?>

2<metadata xmlns="http://www.demandware.com/xml/impex/metadata/2006-10-31">

3 <type-extension type-id="Product">

4 <custom-attribute-definitions>

3 usages

5 <attribute-definition attribute-id="loyaltyTier">

6 <display-name xml:lang="x-default">Loyalty Tier</display-name>

7 <type>string</type>

8 </attribute-definition>

2 usages

9 <attribute-definition attribute-id="isGiftable">

10 <type>boolean</type>

11 </attribute-definition>

12 </custom-attribute-definitions>

13 </type-extension>

14</metadata>

productHelpers.jsapp_custom/cartridge/scripts/helpers - References (3)

41function getTier(apiProduct) {

42 var tier = apiProduct.custom.loyaltyTier;

43 return tier || 'standard';

44}

productHelpers.jsapp_custom/cartridge/scripts/helpers2

var tier = apiProduct.custom.loyaltyTier;

if (product.custom.loyaltyTier === 'gold') {

loyaltyHelpers.jsapp_custom/cartridge/scripts/helpers1

var tier = lineItem.product.custom.loyaltyTier;

mainLn 5, Col 13UTF-8XML

Open Generated Metadata Types is a separate command and editor action, not a second CodeLens. It helps inspect the declarations generated from the active metadata document. See Metadata & generated types

Cartridge paths

Open from site.xmlAdd and reorderReview the XMLBusiness Manager path

storefront

site.xmlRefArch Cartridge Path (4)

1<?xml version="1.0" encoding="UTF-8"?>

2<site xmlns="http://www.demandware.com/xml/impex/site/2007-04-30" site-id="RefArch">

3 <name>RefArch</name>

4 <currency>USD</currency>

5 <taxation>net</taxation>

Edit RefArch Cartridge Path (4)

6 <custom-cartridges>app_custom:int_loyalty:int_payment:app_storefront_base</custom-cartridges>

7</site>

RefArch Cartridge Path 4site_template/sites/RefArch/site.xml

UnsavedOpen XML

In cartridge path 4Drag to reorder · top loads first

Filter cartridges in path…Add cartridge by name…Add

1app_customstorefront • cartridges/app_custom

2int_loyaltystorefront • cartridges/int_loyalty

3int_paymentstorefront • cartridges/int_payment

4app_storefront_basestorefront • cartridges/app_storefront_base

Linked cartridges not in path 1 Add All

Filter linked cartridges…

plugin_wishlistsstorefront • cartridges/plugin_wishlists

1<?xml version="1.0" encoding="UTF-8"?>

2<preferences xmlns="http://www.demandware.com/xml/impex/preferences/2007-03-31">

3 <standard-preferences>

4 <all-instances>

Edit BM Cartridge Path (2)

5 <preference preference-id="CustomCartridges">bm_custom:bm_app_storefront_base</preference>

6 </all-instances>

7 </standard-preferences>

8</preferences>

Business Manager Cartridge Path 2site_template/preferences.xml

SavedOpen XML

In cartridge path 2Drag to reorder · top loads first

Filter cartridges in path…Add cartridge by name…Add

1bm_customstorefront • cartridges/bm_custom

2bm_app_storefront_baseNot linked to this project

Linked cartridges not in path 0 Add All

Filter linked cartridges…

All linked cartridges are already included.

main

Cartridge path XML gets a lens that opens the Cartridge Path Editor:

The number is the cartridge count. Use the editor to add, remove, and reorder cartridges, then save the XML. The action is available on recognized cartridge-path metadata, not arbitrary colon-separated XML text

Log occurrences

Open the event groupExport the issue

storefront

placeOrder.js

app_customcartridgescriptscheckoutplaceOrder.js

141// Places the order once the payment method resolves.

142function placeOrder(order) {

143 var paymentInstrument = order.getPaymentInstruments()[0];

144 var methodId = paymentInstrument.getPaymentMethod();

145 var paymentMethod = PaymentMgr.getPaymentMethod(methodId);

146

147 // A disabled payment method resolves to null here.

SFCC Logs: 3 occurrences in 2 files | Export SFCC log issue

148 var processorId = paymentMethod.paymentProcessor.ID;

149

150 return Transaction.wrap(function () {

151 OrderMgr.placeOrder(order);

152 return processorId;

153 });

154}

Logs ManagerLiveSandbox 01

OverviewFiles4Monitor1Events3Settings

2.4 MB

Unique events1-3 of 3 · 40 occurrences in current filters

FixedType CountLatestMessageSourceStackFiles

ERROR31m agoTypeError: Cannot read property "paymentProcessor" from nullplaceOrder.js:148resolved2

ERROR73m agoint_payment.http.authorize: SocketTimeoutException: Read timed outauthorize.js:58resolved1

WARN3012s agoProduct demo-product has no price in the site price booksproductHelpers.js:212resolved2

Event group3 occurrencesClose

TypeError: Cannot read property "paymentProcessor" from null

ERRORstack: resolvedLatest9/29/2026, 2:32:08 PM

Collapse allCopy messageMessage + stackFor chatExport

Search message, stack, endpoint, file, request…9 sections

Stack trace4 frames

3 resolvedLinked code only

1. 1at app_custom/cartridge/scripts/checkout/placeOrder.js:148 (placeOrder)placeOrder.js:148
2. 2at app_custom/cartridge/controllers/CheckoutServices.js:41 (anonymous)CheckoutServices.js:41
3. 3at app_storefront_base/cartridge/controllers/CheckoutServices.js:612CheckoutServices.js:612
4. 4at modules/server/route.js:39

🪵 Intellij SFCC Logs Report

📈 Unique events1📊 Total occurrences3🗂️ Log files2🌐 B2C instancezzrx-001.dx.commercecloud.salesforce.com🎯 ScopeSelected record group

Event #1 · 🔴 ERROR

⭕ MessageTypeError: Cannot read property "paymentProcessor" from null

mainLn 148, Col 1UTF-8SFCC JavaScript

When log analysis maps an error to a local source line, that line gets two lenses:

• SFCC Logs: N occurrences opens the event group in Log Center. When the occurrences come from more than one log file, the lens adds the file count, as in SFCC Logs: 3 occurrences in 2 files
• Export SFCC log issue writes a Markdown report of that issue and opens its preview

These lenses depend on logs loaded or streamed into the extension and on source mapping. They are not produced by static type checking

Missing a lens?

Check that editor.codeLens is enabled, the file is saved where needed, and the source is linked to an indexed registration or metadata definition. Route URL actions additionally need an active target, and log lenses need analyzed log data. Follow Configuration & troubleshooting for the shared project checks