Skip to content

PromptScript API


Interface: FormatOptions

Defined in: compiler/src/types.ts:42

Options for formatting.

Properties

convention?

optional convention?: string | OutputConvention

Defined in: compiler/src/types.ts:44

Output convention to use


models?

optional models?: ModelsConfig

Defined in: compiler/src/types.ts:62

Model catalog settings from promptscript.yaml, used to map agent models.


outputPath?

optional outputPath?: string

Defined in: compiler/src/types.ts:46

Custom output path


prettier?

optional prettier?: PrettierMarkdownOptions

Defined in: compiler/src/types.ts:56

Prettier formatting options for markdown output.


targetConfig?

optional targetConfig?: TargetConfig

Defined in: compiler/src/types.ts:59

Full target configuration, passed through from promptscript.yaml.


version?

optional version?: string

Defined in: compiler/src/types.ts:52

Target version or format variant. Use 'legacy' for deprecated formats.

Example

'legacy' | '1.0' | '2.0'