Skip to content

PromptScript API


Interface: FormatterOutput

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

Output from a formatter.

Properties

additionalFiles?

optional additionalFiles?: FormatterOutput[]

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

Additional files to generate (e.g., .cursor/commands/, .github/prompts/)


content

content: string

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

Formatted content


managedOutputDirectories?

optional managedOutputDirectories?: string[]

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

Relative directories exclusively managed by this output. Writers may remove obsolete PromptScript-generated files within these directories, but must preserve unmarked files and symlinks.


merge?

optional merge?: StructuredMergePlan

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

Structured merge plan for JSON/TOML settings files


mode?

optional mode?: number

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

File mode (e.g. 0o755 for executable scripts)


path

path: string

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

Output file path