PromptScript API

Interface: CompilerOptions¶

Defined in: compiler/src/types.ts:153

Options for the compiler.

Properties¶

customConventions?¶

optional customConventions?: Record\<string, OutputConvention>

Defined in: compiler/src/types.ts:161

Custom convention definitions

formatters¶

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

Defined in: compiler/src/types.ts:159

Formatters to use (names, instances, or configs)

ignoreHashes?¶

optional ignoreHashes?: boolean

Defined in: compiler/src/types.ts:179

Skip reference integrity hash verification

logger?¶

optional logger?: Logger

Defined in: compiler/src/types.ts:171

Logger for verbose/debug output

models?¶

optional models?: ModelsConfig

Defined in: compiler/src/types.ts:169

Model catalog settings (models in promptscript.yaml). Formatters use them to map agent models; the validator uses them for PS041. When validator.models is set, both use that instead.

prettier?¶

optional prettier?: PrettierMarkdownOptions

Defined in: compiler/src/types.ts:163

Prettier formatting options for markdown output

resolver¶

resolver: ResolverOptions

Defined in: compiler/src/types.ts:155

Resolver configuration

skillContent?¶

optional skillContent?: string

Defined in: compiler/src/types.ts:177

Content of the PromptScript SKILL.md to inject into compilation output. When provided (and config doesn't disable it), this content is added to each formatter's native skill directory.

validator?¶

optional validator?: ValidatorConfig

Defined in: compiler/src/types.ts:157

Validator configuration