PromptScript API

Interface: FormatOptions¶

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

Options for formatting.

Extended by¶

• StandaloneFormatOptions

Properties¶

convention?¶

optional convention?: string | OutputConvention

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

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:71

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

outputPath?¶

optional outputPath?: string

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

Custom output path (overrides default).

prettier?¶

optional prettier?: PrettierMarkdownOptions

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

Prettier formatting options for markdown output.

targetConfig?¶

optional targetConfig?: TargetConfig

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

Full target configuration, passed through from promptscript.yaml.

version?¶

optional version?: string

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

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

Example¶

'legacy' | '1.0' | '2.0'