sfcc/no-proprietary-module-syntax

Disallows SFCC-specific module syntax when a project requires portable, standard JavaScript modules.

This rule is not part of the recommended config. It is enabled for */ paths by the pwa and storefront-next architecture presets, and remains opt-in for other architectures. That status is not a measure of importance: the recommended config is a conservative baseline, while this rule enforces an architectural convention that each team must choose deliberately. Making that choice explicit is part of the Commerce Klaus philosophy.

What it checks

• Reports require("*/...") paths, which search the configured cartridge path
• Reports require("~/...") paths, which resolve from the current cartridge
• Reports module.superModule and the equivalent module["superModule"] access
• Ignores standard relative paths, dw/* modules, named cartridge paths, bare modules, and dynamic require(...) arguments
• Supports static string literals and template literals without expressions
• Ignores superModule access on locally defined variables named module
• Suggests a named cartridge path for */ when exactly one cartridge in the effective cartridge path contains the requested module
• Suggests ~/ first when that module belongs to the importing cartridge and tilde paths are allowed

Options

The optional allow array selects which proprietary syntax remains available. Supported values are "star", "tilde", and "superModule". All three are disallowed by default.

eslint.config.js

export default {
  rules: {
    "sfcc/no-proprietary-module-syntax": ["error", { allow: ["star", "superModule"] }],
  },
}

Use an empty array, or omit the options object, to prohibit all proprietary forms. Include every value to permit all forms while retaining the rule for an explicit project convention.

Why this rule exists

The */ and ~/ prefixes and module.superModule are SFCC runtime extensions rather than standard CommonJS behavior. Projects can enable this rule to favor explicit relative or named cartridge paths and prevent new code from depending on proprietary module resolution.

Default behavior

• Severity: off by default; error for */ paths in the pwa and storefront-next presets
• Allowed proprietary syntax: none
• Auto-fix: none
• Editor suggestions: replace an unambiguous */ path with ~/ for a local module or with its named cartridge path

The suggestion is intentionally not an automatic fix. A named cartridge import opts out of future cartridge-path overrides, so the developer must confirm that architectural change. It is only offered when the shared SFCC settings resolve the module in exactly one cartridge; the rule still reports ambiguous or unresolved */ paths without suggesting a replacement. Suggestions preserve the original string delimiter.

Configure settings.sfcc.cartridgePath, either directly or through createRecommendedConfig(), when the project should use an explicit cartridge order for this lookup.

Examples

Invalid

const helper = require("*/cartridge/scripts/helper") 
const localHelper = require("~/cartridge/scripts/helper") 
const superModule = module.superModule 

Valid

const helper = require("app_storefront/cartridge/scripts/helper")
const localHelper = require("./helper")

With { allow: ["star", "superModule"] }:

Valid

const helper = require("*/cartridge/scripts/helper")
const superModule = module.superModule