sfcc/valid-require-path

Validates SFCC-compatible require() and dynamic import() paths and optionally checks whether cartridge-style references exist on disk.

The SFCC module resolution guide explains cartridge-path precedence and the differences between */, ~/, named cartridge references, platform modules, and module.superModule.

What it checks

• Accepts dw/*, ./*, ../*, */*, ~/*, cartridge-style paths like cartridgeName/module, and configured bare modules
• Reports invalid require/import strings that do not match those patterns
• Can verify cartridge existence when checkCartridgeExists is enabled
• Can resolve */ references against the configured cartridge order or filesystem cartridges
• Can resolve ~/ references against the current cartridge
• Can verify that module.superModule resolves to the same module in a later cartridge when checkCartridgeExists is enabled
• When TypeScript parser type information is available, can also validate require() and import() calls that use identifier arguments with an exact string-literal type
• Also supports unions where all members are exact string literals (for example 'dw/order/OrderMgr' | 'server')
• Without type information, keeps existing behavior and ignores dynamic/non-literal require(...) and import(...) arguments
• Mixed unions with non-literal members (for example string | 'server') keep the fallback behavior and are not type-narrowed

Shared settings

This rule reads its shared configuration from settings.sfcc.

Relevant options include:

• allowBareModules
• checkCartridgeExists
• cartridgesDir
• cartridgePath
• siteTemplatePath
• site

Why this rule exists

SFCC projects often mix cartridge-relative imports, template-path lookups, and legacy require conventions. This rule keeps those paths consistent and catches typos before they become runtime failures.

Default behavior

• Severity: error
• Auto-fix: none

Example

Invalid

const helper = require("helpers") 

Valid

const helper = require("*/cartridge/scripts/helpers")