@salesforce/b2c-tooling-sdk / scaffold / ScaffoldManifest

Interface: ScaffoldManifest

Defined in: packages/b2c-tooling-sdk/src/scaffold/types.ts:125

Scaffold manifest (scaffold.json)

Properties

category

category: string

Defined in: packages/b2c-tooling-sdk/src/scaffold/types.ts:133

Category for filtering and organization

---

defaultOutputDir?

optional defaultOutputDir: string

Defined in: packages/b2c-tooling-sdk/src/scaffold/types.ts:143

Default output directory relative to cwd (created if needed)

---

description

description: string

Defined in: packages/b2c-tooling-sdk/src/scaffold/types.ts:131

Description of what this scaffold creates

---

displayName

displayName: string

Defined in: packages/b2c-tooling-sdk/src/scaffold/types.ts:129

Human-readable display name

---

files?

optional files: FileMapping[]

Defined in: packages/b2c-tooling-sdk/src/scaffold/types.ts:137

File mappings (optional - defaults to all files in files/ directory)

---

modifications?

optional modifications: FileModification[]

Defined in: packages/b2c-tooling-sdk/src/scaffold/types.ts:139

Modifications to existing files (optional)

---

name

name: string

Defined in: packages/b2c-tooling-sdk/src/scaffold/types.ts:127

Unique identifier (kebab-case)

---

parameters

parameters: ScaffoldParameter[]

Defined in: packages/b2c-tooling-sdk/src/scaffold/types.ts:135

Parameters for user input (prompts/flags)

---

postInstructions?

optional postInstructions: string

Defined in: packages/b2c-tooling-sdk/src/scaffold/types.ts:141

Instructions to show after generation