XML & JSON Validation

Intellij SFCC teaches the IDE the file formats SFCC uses. Import and export XML, form definitions and the JSON files of a cartridge are validated while you type, with completion for elements, attributes and keys and a red mark on anything the platform would reject. The XML schemas are bundled with the plugin, so validation works offline

STstorefrontSandbox 01version2

hooks.json

1{

2 "hooks": [

3 {

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

5 }

6 ]

7}

dw.order.calculatebuilt-in

dw.order.calculateShippingbuilt-in

dw.order.calculateTaxbuilt-in

CtrlSpace

storefrontapp_customcartridgehooks.jsonGlobal scopeLFUTF-8

Import and export XML

The plugin registers 53 SFCC schemas. A file is validated when its root element declares the matching SFCC namespace, the same way Business Manager exports it

<?xml version="1.0" encoding="UTF-8"?>
<catalog xmlns="http://www.demandware.com/xml/impex/catalog/2006-10-31" catalog-id="storefront-catalog">
    <category category-id="mens">
        <display-name xml:lang="x-default">Mens</display-name>
        <online-flag>true</online-flag>
    </category>
</catalog>

With the namespace in place you get completion for every element and attribute and errors for missing, misplaced or misspelled items

Each schema is registered for one namespace version, for example catalog/2006-10-31 or jobs/2015-07-01

Form definitions

Form XML in a forms folder, with the namespace http://www.demandware.com/xml/form/2008-04-19, is validated against form.xsd. On top of the schema the plugin adds:

• Completion and navigation for resource keys in label, description, range-error, value-error, missing-error and parse-error, taken from your forms resource bundles
• Completion of form names in the name attribute of an <include>, and a gutter icon that opens the included form. With Global scope the icon lists the form in every cartridge, with a site selected it opens the one that comes first in that site's cartridge path
• Highlighting of numbers in min-length and max-length and of keywords in type, mandatory and valid-form

How scripts and templates reach these forms, for example server.forms.getForm('billing'), is covered in SFCC Contracts

Cartridge JSON files

These files get a schema from the plugin, picked by file name. The schema name shows in the JSON schema widget of the status bar

{
    "hooks": [
        {
            "name": "dw.order.calculate",
            "script": "./scripts/hooks/cart/calculate.js"
        }
    ]
}

Click the gutter icon (Navigate to file) next to script to open the script. Calls such as HookMgr.callHook('app.payment.processor.basic_credit', ...) resolve to the same hooks.json entries, see SFCC Contracts

Page Designer JSON

Meta definition files of Page Designer get their own schema by folder

Unlike the XML schemas, these four are downloaded by the IDE the first time you open such a file. References between Page Designer files, such as a custom editor's type or its scripts, navigate with Cmd+Click (Ctrl+Click), and the resource paths of custom editors complete the cartridge's static CSS and JavaScript files

Troubleshooting

Related