Skip to content

StandaloneFormatOptions

PromptScript API


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

Options for the standalone format function.

Extends

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.

Inherited from

FormatOptions.convention


formatter?

optional formatter?: string | Formatter | FormatterFactory

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

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.


models?

optional models?: ModelsConfig

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

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

Inherited from

FormatOptions.models


outputPath?

optional outputPath?: string

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

Custom output path (overrides default).

Inherited from

FormatOptions.outputPath


prettier?

optional prettier?: PrettierMarkdownOptions

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

Prettier formatting options for markdown output.

Inherited from

FormatOptions.prettier


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.

Inherited from

FormatOptions.provenance


targetConfig?

optional targetConfig?: TargetConfig

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

Full target configuration, passed through from promptscript.yaml.

Inherited from

FormatOptions.targetConfig


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.

Inherited from

FormatOptions.verbatimMarkdown


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'

Inherited from

FormatOptions.version