Skip to content

PromptScript API


Interface: CompileOptions

Defined in: compiler/src/compiler.ts:518

Options for the standalone compile function.

Properties

customConventions?

optional customConventions: Record\<string, OutputConvention>

Defined in: compiler/src/compiler.ts:542

Custom conventions for formatters.


formatters?

optional formatters: (string | Formatter | { config?: TargetConfig; name: string; })[]

Defined in: compiler/src/compiler.ts:538

Formatters to use. If not specified, all built-in formatters are used.


prettier?

optional prettier: PrettierMarkdownOptions

Defined in: compiler/src/compiler.ts:546

Prettier formatting options for markdown output.


resolver?

optional resolver: object

Defined in: compiler/src/compiler.ts:523

Resolver options for resolving imports and inheritance. If not provided, defaults to current working directory.

cache?

optional cache: boolean

Whether to cache resolved ASTs. Defaults to true.

localPath?

optional localPath: string

Base path for local/relative file resolution. Defaults to cwd.

registryPath?

optional registryPath: string

Base path for registry lookups (@namespace/...). Defaults to cwd.


validator?

optional validator: ValidatorConfig

Defined in: compiler/src/compiler.ts:534

Validator configuration.