Skip to content

OutputArtifact

PromptScript API


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

Formatter output shape understood by the shared output planner.

Formatter packages may add fields to this shape, but filesystem consumers must only depend on these portable fields.

Extended by

Properties

additionalFiles?

optional additionalFiles?: OutputArtifact[]

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

Nested resources emitted with this artifact.


content

content: string

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

File contents.


managedOutputDirectories?

optional managedOutputDirectories?: string[]

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

Relative directories managed by this artifact.


managedOutputFiles?

optional managedOutputFiles?: string[]

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

Relative files managed by this artifact.


merge?

optional merge?: StructuredMergePlan

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

Optional structured merge instructions.


mode?

optional mode?: number

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

Optional Unix file 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.


path

path: string

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

Relative output path.