@salesforce/b2c-tooling-sdk / operations/cap / validateCap

Function: validateCap()

validateCap(target): Promise<CapValidationResult>

Defined in: packages/b2c-tooling-sdk/src/operations/cap/validate.ts:63

Validates a Commerce App Package (CAP) directory or zip file.

Checks required files, manifest schema, and cartridge structure rules. This is a purely local operation — no B2C instance required.

Parameters

target

string

Path to a CAP directory or .zip file

Returns

Promise<CapValidationResult>

Validation result with errors and warnings

Example

const result = await validateCap('./my-commerce-app-v1.0.0');
if (!result.valid) {
  console.error('Validation errors:', result.errors);
}