DocumentationCommerceConfiguration Guide

Overview of URN highlighter

Last update: Fri Apr 21 2023 00:00:00 GMT+0000 (Coordinated Universal Time)

CREATED FOR:

  • Experienced
  • Admin
  • Developer
WARNING
All Magento CLI commands must be run by the file system owner.

Commerce code references all XSD schemas as Uniform Resource Names (URNs). If you are developing code and need to reference XSDs, this command configures your integrated developer environment (IDE) to recognize and highlight URNs. This makes development easier.

By default, an IDE like PhpStorm is not configured to recognize URNs and, as a result, they display in red text as follows:

PhpStorm not configured to recognize URN

The bin/magento dev:urn-catalog:generate command enables your IDE (currently, only PhpStorm and Visual Studio Code) to recognize and highlight URNs like the following:

Enable IDE to recognize URN

Specifically, this command creates the following PhpStorm configuration:

PhpStorm configuration example

Configure your IDE

Currently, only PhpStorm and Visual Studio Code are supported.

Command syntax:

bin/magento dev:urn-catalog:generate <path>

Where <path> is the path to your PhpStorm misc.xml file, which is located relative to your project root. Typically, <path> is .idea/misc.xml.

INFO
To keep your “Schemas and DTDs” up do date, run the dev:urn-catalog:generate command every time you add, modify, or remove Commerce 2 modules containing *.xsd files.
recommendation-more-help
386822bd-e32c-40a8-81c2-ed90ad1e198c