PromptScript API

Interface: StandaloneFormatOptions¶

Defined in: formatters/src/standalone.ts:8

Options for the standalone format function.

Extends¶

• FormatOptions

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.

Inherited from¶

FormatOptions.convention

formatter?¶

optional formatter: string | Formatter | FormatterFactory

Defined in: formatters/src/standalone.ts:17

Formatter to use. Can be: - A string name (e.g., 'github', 'claude', 'cursor') - A Formatter instance - A factory function that creates a Formatter

If not specified, 'github' is used as default.

outputPath?¶

optional outputPath: string

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

Custom output path (overrides default).

Inherited from¶

FormatOptions.outputPath

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'

Inherited from¶

FormatOptions.version