Developer Preview — This project is in active development. APIs may change. Provide feedback
Skip to content

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

Interface: ScaffoldManifest

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

Scaffold manifest (scaffold.json)

Properties

category

category: string

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

Category for filtering and organization


defaultOutputDir?

optional defaultOutputDir: string

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

Default output directory relative to cwd (created if needed)


description

description: string

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

Description of what this scaffold creates


displayName

displayName: string

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

Human-readable display name


files?

optional files: FileMapping[]

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

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


modifications?

optional modifications: FileModification[]

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

Modifications to existing files (optional)


name

name: string

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

Unique identifier (kebab-case)


parameters

parameters: ScaffoldParameter[]

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

Parameters for user input (prompts/flags)


postInstructions?

optional postInstructions: string

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

Instructions to show after generation

Released under the Apache-2.0 License.