Skip to content

PromptScript API


Interface: FormatterOutput

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

Output from a formatter.

Properties

additionalFiles?

optional additionalFiles?: FormatterOutput[]

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

Additional files to generate (e.g., workflows)


content

content: string

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

Formatted content


managedOutputDirectories?

optional managedOutputDirectories?: string[]

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

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


managedOutputFiles?

optional managedOutputFiles?: string[]

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

Relative files exclusively managed by this output. Writers may remove an obsolete file only when it carries a PromptScript ownership marker.


merge?

optional merge?: StructuredMergePlan

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

Structured merge plan for JSON/TOML settings files


mode?

optional mode?: number

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

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


path

path: string

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

Output file path (relative to project root)


warnings?

optional warnings?: FormatterWarning[]

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

Target compatibility warnings produced during formatting