Skip to content

PromptScript API


Interface: FormatterOutput

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

Output from a formatter.

Extends

Properties

additionalFiles?

optional additionalFiles?: FormatterOutput[]

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

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

Overrides

OutputArtifact.additionalFiles


content

content: string

Defined in: core/src/output-plan.ts:14

File contents.

Inherited from

OutputArtifact.content


managedOutputDirectories?

optional managedOutputDirectories?: string[]

Defined in: core/src/output-plan.ts:22

Relative directories managed by this artifact.

Inherited from

OutputArtifact.managedOutputDirectories


managedOutputFiles?

optional managedOutputFiles?: string[]

Defined in: core/src/output-plan.ts:24

Relative files managed by this artifact.

Inherited from

OutputArtifact.managedOutputFiles


merge?

optional merge?: StructuredMergePlan

Defined in: core/src/output-plan.ts:18

Optional structured merge instructions.

Inherited from

OutputArtifact.merge


mode?

optional mode?: number

Defined in: core/src/output-plan.ts:16

Optional Unix file mode.

Inherited from

OutputArtifact.mode


path

path: string

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

Output file path

Overrides

OutputArtifact.path


source?

optional source?: string

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

Source entry used to produce this output.


target?

optional target?: string

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

Target formatter that produced this output.


warnings?

optional warnings?: object[]

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

Target compatibility warnings produced during formatting

code

code: string

location?

optional location?: SourceLocation

message

message: string

suggestion?

optional suggestion?: string