Skip to content

FormatOptions

PromptScript API


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

Options for formatting.

Properties

convention?

optional convention?: string | OutputConvention

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

Output convention to use


models?

optional models?: ModelsConfig

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

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


outputPath?

optional outputPath?: string

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

Custom output path


prettier?

optional prettier?: PrettierMarkdownOptions

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

Prettier formatting options for markdown output.


provenance?

optional provenance?: ProvenanceTrace

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

Provenance of the resolved program, with every file rewritten so no machine path remains. Passed only to the prompt targets.


targetConfig?

optional targetConfig?: TargetConfig

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

Full target configuration, passed through from promptscript.yaml.


version?

optional version?: string

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

Target version or format variant. Use ‘legacy’ for deprecated formats.

Example

'legacy' | '1.0' | '2.0'