Digital Script Inspections

Digital Script checks run as you type in .ds files and server .js files, most with a quick fix. They're in Settings › Editor › Inspections › SFCC › Digital Script, all on except Rhino-only syntax that ES2015 replaces

Wrong argumentsScript pathsAmbiguous classUsed before importMap and Set

STstorefrontSandbox 01version2

Wrong.ds

1importPackage(dw.util);

2importPackage(dw.util);

3importClass(dw.util.HashMap);

4importScript(path);

5

6var m = new HashMap();

importPackage takes the package name itself, not a stringRemove quotes⌥⇧↩

'dw.util' is a package: importPackage imports itUse importPackage⌥⇧↩

'dw.util.HashMap' is a class: importClass imports itUse importClass⌥⇧↩

importScript takes the script path as a string literal, such as 'app_core:cart/CartUtils.ds'

storefrontapp_customcartridgescriptsutilWrong.dsGlobal scopeLFUTF-8

The syntax checks are free and work while the IDE indexes. The other checks need a license and wait until indexing ends

Import calls

• importScript path that names no script and Wrong argument also run in <isscript>, see Scripting in ISML
• A path without a cartridge: prefix is checked against the calling script's cartridge only, see Script paths
• Name used before the import call checks top-level code outside functions, and only when every call that binds the name comes after the use
• Class name two imported packages provide stays quiet when an importClass picks the class or the file declares the name
• Import the classes the script uses instead writes one importClass per dw.util class the script uses, other than Map and Set. With none, it removes the call. The check runs with no mode set or from mode 21.2
• Rename is offered as you type, not in Inspect Code

Syntax

Free, and they work while the IDE indexes:

for each (var x of items) is always an error, invalid for each loop, with Remove 'each' and Use 'in'. Templates have their own mode check, see Syntax & Compatibility Mode

let and const

B2C Commerce runs let and const on Rhino, which doesn't follow ES6: a let doesn't stay in its block, a const holds for its whole function and is set once per call, and the script debugger doesn't always show either. var runs the same in every compatibility mode

let and constconst in a loopHeld back

STstorefrontSandbox 01version2

Loyalty.js

1var server = require('server');

2

3server.get('Points', function (req, res, next) {

4 var total = 0;

5 var helper = require('*/cartridge/scripts/helpers/loyaltyHelper');

6 for (var i = 0; i < 3; i++) {

7 total += helper.pointsFor(req.currentCustomer.raw, i);

8 }

9 res.json({ total: total });

10 next();

11});

Use 'var': Rhino's 'let' does not follow ES6 block scopeReplace 'let' with 'var'⌥⇧↩

Use 'var': Rhino's 'const' is function scoped and set once per callReplace 'const' with 'var'⌥⇧↩

Use 'var': Rhino's 'let' does not follow ES6 block scopeReplace 'let' with 'var'⌥⇧↩

storefrontapp_customcartridgecontrollersLoyalty.jsGlobal scopeLFUTF-8

• 'let' or 'const' in server code also runs in <isscript>. Client scripts and server .ts files, which Babel compiles, aren't checked
• Use Fix all in the quick-fix menu for a file, or Code › Analyze Code › Run Inspection by Name for a whole cartridge
• A let without a value whose block runs again, in a loop or in an <isscript> inside <isloop>, becomes var x = undefined, so it starts empty on each pass as the let did
• The fix is held back where var would change what the code does: a const assigned again, or a name the function also gives to another variable. Rename the variable, then apply the fix
• 'const' in a loop reports only a value that changes between passes, such as items.next() or a name the loop assigns. A require or a site preference isn't reported
• While 'let' or 'const' in server code is on, the IDE's Convert to let and Convert to const aren't offered in server code

A const declared in a block resolves for the whole function, see Block const

Names and host objects

Name that nothing declares and Host object also run in templates. Which names they skip, and the full host object list, are in Scopes & Types

Pipelets

Pipelet script that breaks the pipeline contract is a warning on pipelet scripts. A missing execute is an error, and a pdict key the header doesn't declare is a weak warning

Every message is in The pipeline contract

TypeScript sources

Two checks catch what breaks when a server .ts file deploys. .d.ts and client .ts files aren't checked

Both are warnings. Name that changes when a .ts source deploys also checks .ds and server .js files, see .ds, .js and .ts together

Related