Skip to content

FormatterOutput

PromptScript API


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

Output from a formatter.

Extends

Properties

additionalFiles?

optional additionalFiles?: FormatterOutput[]

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

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

Overrides

OutputArtifact.additionalFiles


composition?

optional composition?: PromptComposition[]

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

Blocks composed into prompts, for the prompt targets. Not part of any written file.


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


omit?

optional omit?: boolean

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

Plan nothing for this artifact. A formatter sets it when it has no file to write, for example a prompt target in a program without prompts.

Inherited from

OutputArtifact.omit


path

path: string

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

Output file path (relative to project root)

Overrides

OutputArtifact.path


source?

optional source?: string

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

Source entry used to produce this output.


target?

optional target?: string

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

Target formatter that produced this output.


warnings?

optional warnings?: FormatterWarning[]

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

Target compatibility warnings produced during formatting