Skip to content

PromptScript API


Interface: FormatOptions

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

Options for formatting.

Extended by

Properties

convention?

optional convention: string | OutputConvention

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

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


outputPath?

optional outputPath: string

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

Custom output path (overrides default).


version?

optional version: string

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

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

Example

'legacy' | '1.0' | '2.0'