@salesforce/b2c-tooling-sdk / cli / CartridgeTransformer

Interface: CartridgeTransformer

Defined in: packages/b2c-tooling-sdk/src/cli/cartridge-providers.ts:85

Transformer interface for modifying cartridge mappings before deployment.

Transformers run after all providers have contributed cartridges and can modify paths, rename cartridges, or filter the final list.

Example

const versioningTransformer: CartridgeTransformer = {
  name: 'versioning-transformer',
  async transform(cartridges, options) {
    // Append version suffix to cartridge names
    return cartridges.map(c => ({
      ...c,
      dest: `${c.name}_v2`,
    }));
  },
};

Properties

name

readonly name: string

Defined in: packages/b2c-tooling-sdk/src/cli/cartridge-providers.ts:87

Unique name for this transformer (used for logging)

Methods

transform()

transform(cartridges, options): Promise<CartridgeMapping[]>

Defined in: packages/b2c-tooling-sdk/src/cli/cartridge-providers.ts:98

Transform cartridge mappings before deployment.

Can modify paths, names, or filter cartridges.

Parameters

cartridges

CartridgeMapping[]

Current list of cartridge mappings

options

CartridgeDiscoveryOptions

Discovery options for context

Returns

Promise<CartridgeMapping[]>

Transformed array of cartridge mappings