Skip to content

FormatOptions

PromptScript API


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

Options for formatting.

Extended by

Properties

convention?

optional convention?: string | OutputConvention

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

Output convention to use. Can be a built-in convention name (‘xml’, ‘markdown’) or a custom OutputConvention.


models?

optional models?: ModelsConfig

Defined in: formatters/src/types.ts:75

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


outputPath?

optional outputPath?: string

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

Custom output path (overrides default).


prettier?

optional prettier?: PrettierMarkdownOptions

Defined in: formatters/src/types.ts:69

Prettier formatting options for markdown output.


provenance?

optional provenance?: ProvenanceTrace

Defined in: formatters/src/types.ts:87

Provenance of the resolved program. Only the prompt targets read it, and the compilers pass it only to them, after rewriting every file so no machine path remains.


targetConfig?

optional targetConfig?: TargetConfig

Defined in: formatters/src/types.ts:72

Full target configuration, passed through from promptscript.yaml.


verbatimMarkdown?

optional verbatimMarkdown?: boolean

Defined in: formatters/src/types.ts:81

Keep skill, agent and command bodies as written. Formatters skip their Prettier-style markdown normalization for these files.


version?

optional version?: string

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

Target version or format variant. Use ‘legacy’ for deprecated formats (e.g., Cursor’s .cursorrules).

Example

'legacy' | '1.0' | '2.0'