@salesforce/b2c-tooling-sdk / operations/code / findCartridges

Function: findCartridges()

findCartridges(directory?, options?): CartridgeMapping[]

Defined in: packages/b2c-tooling-sdk/src/operations/code/cartridges.ts:56

Find cartridges recursively in a directory.

Cartridges are identified by the presence of a .project file (Eclipse project marker commonly used in SFCC development).

Parameters

directory?

string

Directory to search for cartridges (defaults to cwd)

options?

FindCartridgesOptions = {}

Filter options for including/excluding cartridges

Returns

CartridgeMapping[]

Array of discovered cartridge mappings

Example

// Find all cartridges in current directory
const cartridges = findCartridges();

// Find cartridges in specific directory
const cartridges = findCartridges('./my-project');

// Find specific cartridges only
const cartridges = findCartridges('.', { include: ['app_storefront_base'] });

// Find all except certain cartridges
const cartridges = findCartridges('.', { exclude: ['test_cartridge'] });